The Robot Application Programming Interface Delegate Project
RAPID Logo

RapidTextMessage Class Reference

Inheritance diagram for RapidTextMessage:
Collaboration diagram for RapidTextMessage:

List of all members.

Public Member Functions

 RapidTextMessage ()
 RapidTextMessage (TextMessage other)
void setHeader (String srcName, String partitionName, long timeStamp, int statusCode)
 explicitly set each field of header
void setHeader (Agent srcAgent, String partitionName, long timeStamp, int statusCode)
 set header using Agent enums
void setHeader (Agent srcAgent, String partitionName, int statusCode)
 Initialize header with source, destination, and status code.
void updateHeader (int statusCode)
 update an existing header with statusCode and current timestamp
Header getHeader ()
String toString ()
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.
Boolean getBooleanParameter (String key) throws IncompatibleKeyTypeException
Double getDoubleParameter (String key) throws IncompatibleKeyTypeException
Float getFloatParameter (String key) throws IncompatibleKeyTypeException
Integer getIntegerParameter (String key) throws IncompatibleKeyTypeException
Object getParameterObject (String key)
String getStringParameter (String key) throws IncompatibleKeyTypeException

Public Attributes

TextMessage textMessage

Constructor & Destructor Documentation

Here is the call graph for this function:


Member Function Documentation

Boolean getBooleanParameter ( String  key) throws IncompatibleKeyTypeException
Copyable getCopyable ( )

Implements IRapidStruct.

Double getDoubleParameter ( String  key) throws IncompatibleKeyTypeException
Float getFloatParameter ( String  key) throws IncompatibleKeyTypeException
Header getHeader ( )
Returns:
hdr

Implements IRapidMessage.

Integer getIntegerParameter ( String  key) throws IncompatibleKeyTypeException
Object getParameterObject ( String  key)
String getStringParameter ( String  key) throws IncompatibleKeyTypeException
void initializeVariables ( )

Implements IRapidMessage.

void populateTopLevelAttributes ( )

Implements IRapidMessage.

void setHeader ( String  srcName,
String  partitionName,
long  timeStamp,
int  statusCode 
)
Parameters:
srcName
partitionName
timeStamp
statusCode
void setHeader ( Agent  srcAgent,
String  partitionName,
long  timeStamp,
int  statusCode 
)

Implements IRapidMessage.

Here is the call graph for this function:

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

Timestamp is filled in automatically.

Implements IRapidMessage.

Here is the call graph for this function:

String toString ( )

Implements IRapidMessage.

void updateHeader ( int  statusCode)
Parameters:
statusCode

Implements IRapidMessage.

Here is the call graph for this function:


Member Data Documentation


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