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:

List of all members.

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.
Protected Attributes
const unsigned int	myPayloadAlignment
Private Member Functions
	DtRtiMtdTestId (const DtRtiMtdTestId &)
	Copy CTOR Not Implemented -- Copy Not Allowed!
DtRtiMtdTestId &	operator= (const DtRtiMtdTestId &)
	Assignment Operator Not Implemented -- Assignment Not Allowed!

---

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