MAK RTIspy API Documentation for HLA 1.3
Public Member Functions | Static Public Member Functions | Protected Attributes | Static Protected Attributes | Private Member Functions
DtRtiMtdTimeStamp Class Reference
+ Inheritance diagram for DtRtiMtdTimeStamp:
+ Collaboration diagram for DtRtiMtdTimeStamp:

List of all members.

Public Member Functions

 DtRtiMtdTimeStamp (DtMetadataType type, caddr_t msg)
 Constructor.
 DtRtiMtdTimeStamp (DtMetadataType type, DtRtiMsg *msg)
virtual ~DtRtiMtdTimeStamp ()
 Destructor.
virtual bool get (MAKRti::DtTime &stamp) const
 Find the first time stamp within the message metadata.
virtual bool set (const MAKRti::DtTime &timeStamp)
 Reserves space in RTI message buffer (if necessary) for additional timestamp metadata, encodes (serializes) timestamp, and copies into message buffer.
virtual DtMetadataType getType () const
 Return the DtMetadataType that this instance was constructed with.

Static Public Member Functions

static bool get (DtMetadataType type, char const *msg, MAKRti::DtTime &stamp)
 Find the first time stamp within the message metadata.

Protected Attributes

const unsigned int myPayloadAlignment

Static Protected Attributes

static const unsigned int theSizeOfASingleEntry = sizeof(DtNetFloat64) + sizeof(MAKRti::DtNetU16)

Private Member Functions

 DtRtiMtdTimeStamp (const DtRtiMtdTimeStamp &)
 Copy CTOR Not Implemented -- Copy Not Allowed!
DtRtiMtdTimeStampoperator= (const DtRtiMtdTimeStamp &)
 Assignment Operator Not Implemented -- Assignment Not Allowed!

Constructor & Destructor Documentation

Constructor.

Destructor.

Copy CTOR Not Implemented -- Copy Not Allowed!


Member Function Documentation

bool DtRtiMtdTimeStamp::get ( MAKRti::DtTime &  stamp) const [virtual]

Find the first time stamp within the message metadata.

If none found, returns false. If found, copies decoded metadata to MAKRti::DtTime object supplied (stamp) and returns true.

References DtRtiMetadata::locate(), and theSizeOfASingleEntry.

Referenced by DtRecipientLatencyTest::addAsyncQueueMsgTimeStamp(), DtInitiatorLatencyTest::addAsyncQueueMsgTimeStamp(), DtRecipientLatencyTest::addNetReceiveTimeStamp(), and DtInitiatorLatencyTest::addNetReceiveTimeStamp().

bool DtRtiMtdTimeStamp::get ( DtMetadataType  type,
char const *  msg,
MAKRti::DtTime &  stamp 
) [static]

Find the first time stamp within the message metadata.

If none found, returns false. If found, copies decoded metadata to MAKRti::DtTime object supplied (stamp) and returns true.

References DtRtiMetadata::locate(), and theSizeOfASingleEntry.

Return the DtMetadataType that this instance was constructed with.

Does NOT imply that metadata of this type exists in associated msg.

References DtRtiMetadata::myMetaDataType.

DtRtiMtdTimeStamp& DtRtiMtdTimeStamp::operator= ( const DtRtiMtdTimeStamp ) [private]

Assignment Operator Not Implemented -- Assignment Not Allowed!

bool DtRtiMtdTimeStamp::set ( const MAKRti::DtTime &  timeStamp) [virtual]

Member Data Documentation

const unsigned int DtRtiMtdTimeStamp::myPayloadAlignment [protected]

Referenced by set().

const unsigned int DtRtiMtdTimeStamp::theSizeOfASingleEntry = sizeof(DtNetFloat64) + sizeof(MAKRti::DtNetU16) [static, protected]

Referenced by get(), and set().


The documentation for this class was generated from the following files:

Document ID: Generated on Thu Jun 14 14:15:04 EDT 2012 from SVN revision 116116
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)