The Robot Application Programming Interface Delegate Project
RAPID Logo

PositionConfigCache Class Reference

Inheritance diagram for PositionConfigCache:
Collaboration diagram for PositionConfigCache:

List of all members.

Classes

class  PositionConfigHolder

Public Member Functions

void addConfigImpl (PositionConfig config)
void rapidEventReceived (Agent agent, MessageType type, IRapidMessage msg)

Static Public Member Functions

static PositionConfigHolder getSubscribedConfig (final Agent agent, final MessageType configType, PositionSample data)
 Matches the serial number in JointSample to the latest JointConfig and returns it if true.
static PositionConfigHolder getConfig (final Agent agent, final MessageType configType)
static synchronized void createCache (final Agent agent, final MessageType configType)
static void addConfig (Agent agent, MessageType configType, PositionConfig config)
 Manually add Config to cache.

Protected Member Functions

PositionConfigHolder getLatestConfig ()
PositionConfigHolder getLatestMatchingConfig (Header hdr)
Map< String, DataTypeIndexgetKeyValueMap (PositionConfig config)

Package Attributes

ArrayList< PositionConfigHolderhistory = new ArrayList<PositionConfigHolder>()

Member Function Documentation

static void addConfig ( Agent  agent,
MessageType  configType,
PositionConfig  config 
) [static]

Used for client Configs.

Parameters:
agent
configType
config

Here is the call graph for this function:

void addConfigImpl ( PositionConfig  config)

Here is the call graph for this function:

static synchronized void createCache ( final Agent  agent,
final MessageType  configType 
) [static]

Here is the call graph for this function:

static PositionConfigHolder getConfig ( final Agent  agent,
final MessageType  configType 
) [static]

Here is the call graph for this function:

Map<String,DataTypeIndex> getKeyValueMap ( PositionConfig  config) [protected]
PositionConfigHolder getLatestConfig ( ) [protected]
PositionConfigHolder getLatestMatchingConfig ( Header  hdr) [protected]
static PositionConfigHolder getSubscribedConfig ( final Agent  agent,
final MessageType  configType,
PositionSample  data 
) [static]

If false, null is returned

TODO: match against history of JointConfig messages

If the client would like to subscribe to the Config message to receive the initial JointSample, the following should be done at the calling class:

JointConfig.getSubscribedConfig(agent, new JointSample());

This will return null, but the JointConfig has been registered to listen for events.

Parameters:
agent
configType
data
  • should never be null
Returns:
PositionConfigHolder
Exceptions:
RapidEventCollectorException

Here is the call graph for this function:

void rapidEventReceived ( Agent  agent,
MessageType  type,
IRapidMessage  msg 
)

Implements IRapidEventListener.

Here is the call graph for this function:


Member Data Documentation

ArrayList<PositionConfigHolder> history = new ArrayList<PositionConfigHolder>() [package]

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines