DtRtiMtdTimeStamp Class Reference

Inheritance diagram for DtRtiMtdTimeStamp:

Collaboration diagram for DtRtiMtdTimeStamp:

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.
Public Member Functions inherited from DtRtiMetadata
	DtRtiMetadata (caddr_t msg, DtMetadataType type)
	Constructor.
	DtRtiMetadata (DtRtiMsg *msg, DtMetadataType type)
virtual	~DtRtiMetadata ()
	Destructor.
virtual bool	locate (void **mdVal, unsigned int &size) const
	Traverse metadata headers of attached message to find this instance's metadata type.
virtual bool	nullify ()
	Find specified type and change type field in header to DtMetadataTypeNull but don't remove from message buffer.
virtual unsigned int	remove ()
	Find specified type and remove from buffer, relocating metadata that remains and adjusting reported size of buffer.
virtual unsigned int	purge ()
	Traverse metadata headers to find all nullified blocks and remove them from buffer, relocating metadata that remains and adjusting reported size of buffer.
virtual bool	isCopyEnabled ()
	Set/Get the 'copy' bit in the specified metadata header.
virtual void	setCopyEnable (bool copyEnable)
virtual bool	setLengthAsValue (unsigned int value)
	Set an integer value to be transmitted without using an actual payload.
virtual bool	getLengthAsValue (unsigned int &value) const
	Get an integer payload value from the payload length.

Static Public Member Functions
static bool	get (DtMetadataType type, char const *msg, MAKRti::DtTime &stamp)
	Find the first time stamp within the message metadata.
Static Public Member Functions inherited from DtRtiMetadata
static unsigned int	metadataMaxSize ()
	Report maximum size of metadata buffer.

Protected Attributes
const unsigned int	myPayloadAlignment
Protected Attributes inherited from DtRtiMetadata
DtRtiMsg *	myMsg
caddr_t	myMsgAddr
unsigned int	myMsgLen
char *	myStartAddr
unsigned int	mySize
	address returned by DtRtiMsg::addMetadata()
bool	myCopyEnabled
const DtMetadataType	myMetaDataType

Static Protected Attributes
static const unsigned int	theSizeOfASingleEntry = sizeof(DtNetFloat64) + sizeof(MAKRti::DtNetU16)
Static Protected Attributes inherited from DtRtiMetadata
static unsigned int	theMaxMetadataBufferSize = 2048

Private Member Functions
	DtRtiMtdTimeStamp (const DtRtiMtdTimeStamp &)
	Copy CTOR Not Implemented – Copy Not Allowed!
DtRtiMtdTimeStamp &	operator= (const DtRtiMtdTimeStamp &)
	Assignment Operator Not Implemented – Assignment Not Allowed!

Additional Inherited Members
Protected Types inherited from DtRtiMetadata
typedef std::list < DtMetadataNetHeader * >	DtMetadataHeaderList
Protected Member Functions inherited from DtRtiMetadata
virtual DtMetadataNetHeader *	getFirstHeader () const
virtual DtMetadataNetHeader *	getHeaderByType () const
virtual DtU16	compactMetadata (char *dst, DtMetadataHeaderList &retentionPool, bool newFinal)
Static Protected Member Functions inherited from DtRtiMetadata
static bool	locate (char const *msg, DtMetadataType type, void **mdVal, unsigned int &size)
	Traverse metadata headers of the given message to find the given metadata type.
static bool	typeIsPresent (char const *msg, DtMetadataType type)
	Determines whether metadata type is present in msg.
static DtMetadataNetHeader *	getFirstHeader (char const *msg)
static DtMetadataNetHeader *	getNextHeader (DtMetadataNetHeader *hdr)
static DtMetadataNetHeader *	getHeaderByType (char const *msg, DtMetadataType type)
static void	transmogrifyHeader (DtMetadataNetHeader &src, DtMetadataNetHeader &dest)
	Transform from network to host format.
static void	reverseTransmogrifyHeader (DtMetadataNetHeader &src, DtMetadataNetHeader &dest)
	Transform from host format to network format.
static unsigned int	metadataSize (DtMetadataNetHeader &hdr)
static unsigned int	metadataPayloadSize (DtMetadataNetHeader &hdr)

Constructor & Destructor Documentation

DtRtiMtdTimeStamp::DtRtiMtdTimeStamp	(	DtMetadataType	type,
		caddr_t	msg
	)

Constructor.

DtRtiMtdTimeStamp::DtRtiMtdTimeStamp	(	DtMetadataType	type,
		DtRtiMsg *	msg
	)

DtRtiMtdTimeStamp::~DtRtiMtdTimeStamp ( )

virtual

Destructor.

DtRtiMtdTimeStamp::DtRtiMtdTimeStamp ( const DtRtiMtdTimeStamp &  )

private

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.

DtMetadataType DtRtiMtdTimeStamp::getType ( ) const

virtual

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

Reserves space in RTI message buffer (if necessary) for additional timestamp metadata, encodes (serializes) timestamp, and copies into message buffer.

Returns true if successful, false otherwise.

References DtRtiMsg::addMetadata(), DtMetadataHeader_s::DtMetadataHeaderLenOrVal_u::DtMetadataHeaderPayloadLen_s::alignPad, DtMetadataHeader_s::DtMetadataHeaderCtl_u::DtMetadataHeaderCtl_s::copy, DtMetadataHeader_s::ctl, DtMetadataHeader_s::DtMetadataHeaderCtl_u::field, DtRtiMetadata::getHeaderByType(), DtMetadataHeader_s::DtMetadataHeaderCtl_u::DtMetadataHeaderCtl_s::hasPayload, DtMetadataHeader_s::DtMetadataHeaderLenOrVal_u::len, DtMetadataHeader_s::lenOrVal, DtRtiMetadata::locate(), DtMetadataHeader_s::DtMetadataHeaderCtl_u::DtMetadataHeaderCtl_s::more, DtRtiMetadata::myCopyEnabled, DtRtiMetadata::myMetaDataType, DtRtiMetadata::myMsg, DtRtiMetadata::myMsgAddr, DtRtiMetadata::myMsgLen, myPayloadAlignment, DtRtiMetadata::myStartAddr, NULL, DtMetadataHeader_s::DtMetadataHeaderLenOrVal_u::DtMetadataHeaderPayloadLen_s::pad, DtMetadataHeader_s::DtMetadataHeaderLenOrVal_u::DtMetadataHeaderPayloadLen_s::payloadAlignment, DtMetadataHeader_s::DtMetadataHeaderLenOrVal_u::DtMetadataHeaderPayloadLen_s::payloadLen, DtRtiMetadata::reverseTransmogrifyHeader(), theSizeOfASingleEntry, and DtMetadataHeader_s::DtMetadataHeaderCtl_u::DtMetadataHeaderCtl_s::type.

Referenced by DtRecipientLatencyTest::addNetSendTimeStamp().

Member Data Documentation

const unsigned int DtRtiMtdTimeStamp::myPayloadAlignment

protected

Referenced by set().

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

staticprotected

Referenced by get(), and set().

---

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

• metadataTimeStamp.h
• metadataTimeStamp.cxx