DtRtiMtdTestId Class Reference

DtRtiMtdTestId is a metadata type used in RTI Network testing It is used to identify to which test the message it is attached to belongs. More...

Inheritance diagram for DtRtiMtdTestId:

Collaboration diagram for DtRtiMtdTestId:

Public Member Functions
	DtRtiMtdTestId (caddr_t msg)
	Constructor.
	DtRtiMtdTestId (DtRtiMsg *msg)
virtual	~DtRtiMtdTestId ()
	Destructor.
virtual bool	get (unsigned int &testId) const
	Find the testIdMetaData within the message metadata.
virtual bool	set (unsigned int testId)
	Reserves space in RTI message buffer (if necessary) for additional TestId metadata, encodes TestId, and copies into message buffer.
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.
virtual void	print (MAKRti::DtOutputStream &stream=MAKRti::DtDebug)
	Print this Metadata.

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

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

Additional Inherited Members
Static Public Member Functions inherited from DtRtiMetadata
static unsigned int	metadataMaxSize ()
	Report maximum size of metadata buffer.
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)
Static Protected Attributes inherited from DtRtiMetadata
static unsigned int	theMaxMetadataBufferSize = 2048

Detailed Description

DtRtiMtdTestId is a metadata type used in RTI Network testing It is used to identify to which test the message it is attached to belongs.

Constructor & Destructor Documentation

DtRtiMtdTestId::DtRtiMtdTestId

(

caddr_t

msg

)

Constructor.

DtRtiMtdTestId::DtRtiMtdTestId

(

DtRtiMsg *

msg

)

DtRtiMtdTestId::~DtRtiMtdTestId ( )

virtual

Destructor.

DtRtiMtdTestId::DtRtiMtdTestId ( const DtRtiMtdTestId &  )

private

Copy CTOR Not Implemented – Copy Not Allowed!

Member Function Documentation

bool DtRtiMtdTestId::get ( unsigned int &  testId ) const

virtual

Find the testIdMetaData within the message metadata.

If not found returns false, else copies decoded metadata to testId object supplied (testId) and returns true

References DtRtiMetadata::locate().

Referenced by DtTestManager::addMetadataIfNecessary(), and DtTestManager::getTestIDFromMetaData().

DtRtiMtdTestId& DtRtiMtdTestId::operator= ( const DtRtiMtdTestId &  )

private

Assignment Operator Not Implemented – Assignment Not Allowed!

bool DtRtiMtdTestId::set ( unsigned int  testId )

virtual

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

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(), and DtMetadataHeader_s::DtMetadataHeaderCtl_u::DtMetadataHeaderCtl_s::type.

Referenced by DtTestManager::addMetadataIfNecessary().

Member Data Documentation

const unsigned int DtRtiMtdTestId::myPayloadAlignment

protected

Referenced by set().

---

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

• metadataTestId.h
• metadataTestId.cxx