DtRtiMtdFederateHostInformation Class Reference

DtRtiMtdFederateHostInformation is a metadata type used in RTI Network testing It is used to identify federate host information of recipient federates. More...

Inheritance diagram for DtRtiMtdFederateHostInformation:

Collaboration diagram for DtRtiMtdFederateHostInformation:

List of all members.

Classes
struct	DtFederateHostInformation
Public Member Functions
	DtRtiMtdFederateHostInformation (caddr_t msg)
	Constructor.
	DtRtiMtdFederateHostInformation (DtRtiMsg *msg)
virtual	~DtRtiMtdFederateHostInformation ()
	Destructor.
virtual bool	get (DtFederateHostInformation &federateHostInformation) const
	Find the FederateHostInformationMetaData within the message metadata.
virtual bool	set (const DtFederateHostInformation &federateHostInformation)
	Reserves space in RTI message buffer (if necessary) for additional FederateHostInformation metadata, encodes FederateHostInformation, and copies into message buffer.
Protected Attributes
const unsigned int	myPayloadAlignment
Private Member Functions
	DtRtiMtdFederateHostInformation (const DtRtiMtdFederateHostInformation &)
	Copy CTOR Not Implemented -- Copy Not Allowed!
DtRtiMtdFederateHostInformation &	operator= (const DtRtiMtdFederateHostInformation &)
	Assignment Operator Not Implemented -- Assignment Not Allowed!

---

Detailed Description

DtRtiMtdFederateHostInformation is a metadata type used in RTI Network testing It is used to identify federate host information of recipient federates.

---

Constructor & Destructor Documentation

DtRtiMtdFederateHostInformation::DtRtiMtdFederateHostInformation

(

caddr_t

msg

)

Constructor.

DtRtiMtdFederateHostInformation::DtRtiMtdFederateHostInformation

(

DtRtiMsg *

msg

)

DtRtiMtdFederateHostInformation::~DtRtiMtdFederateHostInformation

(

)

[virtual]

Destructor.

DtRtiMtdFederateHostInformation::DtRtiMtdFederateHostInformation

(

const DtRtiMtdFederateHostInformation &

)

[private]

Copy CTOR Not Implemented -- Copy Not Allowed!

---

Member Function Documentation

bool DtRtiMtdFederateHostInformation::get

(

DtFederateHostInformation &

federateHostInformation

)

const [virtual]

Find the FederateHostInformationMetaData within the message metadata.

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

References DtRtiMtdFederateHostInformation::DtFederateHostInformation::asyncMode, DtRtiMtdFederateHostInformation::DtFederateHostInformation::averageTickTime, DtRtiMtdFederateHostInformation::DtFederateHostInformation::federateName, and DtRtiMetadata::locate().

Referenced by DtInitiatorLatencyTest::addNetReceiveTimeStamp().

DtRtiMtdFederateHostInformation& DtRtiMtdFederateHostInformation::operator=

(

const DtRtiMtdFederateHostInformation &

)

[private]

Assignment Operator Not Implemented -- Assignment Not Allowed!

bool DtRtiMtdFederateHostInformation::set

(

const DtFederateHostInformation &

federateHostInformation

)

[virtual]

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

References DtRtiMsg::addMetadata(), DtMetadataHeader_s::DtMetadataHeaderLenOrVal_u::DtMetadataHeaderPayloadLen_s::alignPad, DtRtiMtdFederateHostInformation::DtFederateHostInformation::asyncMode, DtRtiMtdFederateHostInformation::DtFederateHostInformation::averageTickTime, DtMetadataHeader_s::DtMetadataHeaderCtl_u::DtMetadataHeaderCtl_s::copy, DtMetadataHeader_s::ctl, DtRtiMtdFederateHostInformation::DtFederateHostInformation::federateName, 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(), DtRtiMtdFederateHostInformation::DtFederateHostInformation::size(), and DtMetadataHeader_s::DtMetadataHeaderCtl_u::DtMetadataHeaderCtl_s::type.

Referenced by DtRecipientLatencyTest::addNetSendTimeStamp().

---

Member Data Documentation

const unsigned int DtRtiMtdFederateHostInformation::myPayloadAlignment [protected]

Referenced by set().

---

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

• metadataFederateHostInformation.h
• metadataFederateHostInformation.cxx