The Robot Application Programming Interface Delegate Project
RAPID Logo

RapidMessageAdapter Class Reference

Inheritance diagram for RapidMessageAdapter:
Collaboration diagram for RapidMessageAdapter:

List of all members.

Public Member Functions

 RapidMessageAdapter (Message msg)
void setMessage (Message msg)
void setHeader (String srcName, String partitionName, long timeStamp, int statusCode)
 explicitly set each field of header
void setHeader (String srcName, String partitionName, long timeStamp, int serial, int statusCode)
void setHeader (Agent srcAgent, String partitionName, long timeStamp, int statusCode)
void setHeader (Agent srcAgent, String partitionName, int statusCode)
 Initialize header with source, destination, and status code.
void setHeader (Agent srcAgent, String partitionName, int statusCode, int serialId)
void setHeader (String srcName, String partitionName, int statusCode, int serialId)
void setHeader (String srcName, String partitionName, int statusCode, int serialId, long timeStamp)
void updateHeader (int statusCode)
 update an existing header with statusCode and current timestamp
String headerString ()
Header getHeader ()
Object copy_from (Object arg0)
void initializeVariables ()
 ensure that there is no way to send over a null through the wire
Copyable getCopyable ()
void populateTopLevelAttributes ()
 MAE-4255: create top level access variables to simplify access.

Static Public Member Functions

static String headerString (Header hdr)
static String toString (DataType type)
static String keyTypeValueString (KeyTypeValueSequence64 ktvs)

Protected Attributes

Message msg

Constructor & Destructor Documentation


Member Function Documentation

Object copy_from ( Object  arg0)
Header getHeader ( )
Returns:
hdr

Implements IRapidMessage.

String headerString ( )

Here is the call graph for this function:

static String headerString ( Header  hdr) [static]
void initializeVariables ( )
static String keyTypeValueString ( KeyTypeValueSequence64  ktvs) [static]

Here is the call graph for this function:

void populateTopLevelAttributes ( )

Implements IRapidMessage.

Reimplemented in RapidJointSample, and RapidPositionSample.

void setHeader ( Agent  srcAgent,
String  partitionName,
long  timeStamp,
int  statusCode 
)
Deprecated:
Use setHeader() methods that require statusCode and serialId because those should always be set.

Optional timeStamp parameter should be the last parameter.

Implements IRapidMessage.

Here is the call graph for this function:

void setHeader ( Agent  srcAgent,
String  partitionName,
int  statusCode 
)

Timestamp is filled in automatically.

Deprecated:
Use setHeader() methods that require statusCode and serialId because those should always be set. Optional timeStamp parameter should be the last parameter.

Implements IRapidMessage.

Here is the call graph for this function:

void setHeader ( String  srcName,
String  partitionName,
int  statusCode,
int  serialId,
long  timeStamp 
)
void setHeader ( String  srcName,
String  partitionName,
long  timeStamp,
int  statusCode 
)
Parameters:
srcName
partitionName
timeStamp
statusCode
Deprecated:
Use setHeader() methods that require statusCode and serialId because those should always be set. Optional timeStamp parameter should be the last parameter.
void setHeader ( String  srcName,
String  partitionName,
int  statusCode,
int  serialId 
)

Here is the call graph for this function:

void setHeader ( String  srcName,
String  partitionName,
long  timeStamp,
int  serial,
int  statusCode 
)
Deprecated:
Use setHeader() methods that require statusCode and serialId because those should always be set.

Optional timeStamp parameter should be the last parameter.

void setHeader ( Agent  srcAgent,
String  partitionName,
int  statusCode,
int  serialId 
)

Here is the call graph for this function:

void setMessage ( Message  msg)
static String toString ( DataType  type) [static]
void updateHeader ( int  statusCode)
Parameters:
statusCode

Implements IRapidMessage.

Here is the call graph for this function:


Member Data Documentation

Message msg [protected]

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