The Robot Application Programming Interface Delegate Project
RAPID Logo

RangeScanConfigCache Class Reference

Inheritance diagram for RangeScanConfigCache:
Collaboration diagram for RangeScanConfigCache:

List of all members.

Classes

class  RangeScanConfigHolder

Public Member Functions

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

Static Public Member Functions

static RangeScanConfigHolder getSubscribedConfig (final Agent agent, final MessageType configType, RangeScanSample data)
 Matches the serial number in JointSample to the latest JointConfig and returns it if true.
static RangeScanConfigHolder getConfig (final Agent agent, final MessageType configType)
static synchronized void createCache (final Agent agent, MessageType configType)
static void addConfig (Agent agent, MessageType configType, RangeScanConfig config)
 manually add Config to cache.
static void addConfig (String agentName, MessageType configType, RangeScanConfig config)

Protected Member Functions

RangeScanConfigHolder getLatestConfig ()
RangeScanConfigHolder getLatestMatchingConfig (Header hdr)

Package Attributes

ArrayList< RangeScanConfigHolderhistory = new ArrayList<RangeScanConfigHolder>()

Member Function Documentation

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

Used for client Configs

Parameters:
agent
config

Here is the call graph for this function:

static void addConfig ( String  agentName,
MessageType  configType,
RangeScanConfig  config 
) [static]

Here is the call graph for this function:

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

Here is the call graph for this function:

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

Here is the call graph for this function:

RangeScanConfigHolder getLatestConfig ( ) [protected]
RangeScanConfigHolder getLatestMatchingConfig ( Header  hdr) [protected]
static RangeScanConfigHolder getSubscribedConfig ( final Agent  agent,
final MessageType  configType,
RangeScanSample  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:
RangeScanConfigHolder
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<RangeScanConfigHolder> history = new ArrayList<RangeScanConfigHolder>() [package]

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