The Robot Application Programming Interface Delegate Project
RAPID Logo

NavMapConfigCache Class Reference

Inheritance diagram for NavMapConfigCache:
Collaboration diagram for NavMapConfigCache:

List of all members.

Classes

class  NavMapConfigHolder

Public Member Functions

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

Static Public Member Functions

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

Protected Member Functions

NavMapConfigHolder getLatestConfig ()
NavMapConfigHolder getLatestMatchingConfig (Header hdr)

Package Attributes

ArrayList< NavMapConfigHolderhistory = new ArrayList<NavMapConfigHolder>()

Member Function Documentation

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

Used for client Configs

Parameters:
agent
config

Here is the call graph for this function:

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

Here is the call graph for this function:

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

Here is the call graph for this function:

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

Here is the call graph for this function:

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

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