The Robot Application Programming Interface Delegate Project

Header Class Reference

Header of all messages. More...

Inheritance diagram for Header:
Collaboration diagram for Header:

List of all members.

Public Member Functions

 Header ()
 Header (Header other)
boolean equals (Object o)
int hashCode ()
Object copy_from (Object src)
 This is the implementation of the Copyable interface.
String toString ()
String toString (String desc, int indent)

Static Public Member Functions

static Object create ()

Public Attributes

String srcName = ""
 Source name of the message.
String assetName = ""
 Agent to which this message is being sent or from which this message was sent.
long timeStamp
 Timestamp is the number of milliseconds elapsed since midnight proleptic Coordinated Universal Time (UTC) of January 1, 1970, not counting leap seconds.
int statusCode
 If statusCode >= 0, then all is well.
int serial
 Serial denotes a config/state pair (i.e.

Detailed Description

Constructor & Destructor Documentation

Header ( )
Header ( Header  other)

Here is the call graph for this function:

Member Function Documentation

Object copy_from ( Object  src)

This method will perform a deep copy of src This method could be placed into HeaderTypeSupport rather than here by using the -noCopyable option to rtiddsgen.

srcThe Object which contains the data to be copied.
Returns this.
NullPointerExceptionIf src is null.
ClassCastExceptionIf src is not the same type as this.
See also:

Here is the call graph for this function:

static Object create ( ) [static]

Here is the call graph for this function:

boolean equals ( Object  o)

Here is the call graph for this function:

int hashCode ( )
String toString ( String  desc,
int  indent 
String toString ( )

Member Data Documentation

String assetName = ""

This is also a key for filtering in DDS.

int serial

the code in a config header should match the code in the corresponding state header).

String srcName = ""

This is a key for filtering in DDS.

If statusCode < 0, there is some sort of error. Each status shall have its own convention for error codes.

long timeStamp

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