 |
MAK RTIspy API Documentation for HLA Evolved
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
MAK RTIspy API Documentation for HLA Evolved
|
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:Classes | |
| struct | DtFederateHostInformation |
Public Member Functions | |
| DtRtiMtdFederateHostInformation (caddr_t msg) | |
| Constructor. More... | |
| DtRtiMtdFederateHostInformation (DtRtiMsg *msg) | |
| virtual | ~DtRtiMtdFederateHostInformation () |
| Destructor. More... | |
| virtual bool | get (DtFederateHostInformation &federateHostInformation) const |
| Find the FederateHostInformationMetaData within the message metadata. More... | |
| 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. More... | |
| Public Member Functions inherited from DtRtiMetadata | |
| DtRtiMetadata (caddr_t msg, DtMetadataType type) | |
| Constructor. More... | |
| DtRtiMetadata (DtRtiMsg *msg, DtMetadataType type) | |
| virtual | ~DtRtiMetadata () |
| Destructor. More... | |
| virtual bool | locate (void **mdVal, unsigned int &size) const |
| Traverse metadata headers of attached message to find this instance's metadata type. More... | |
| virtual bool | nullify () |
| Find specified type and change type field in header to DtMetadataTypeNull but don't remove from message buffer. More... | |
| virtual unsigned int | remove () |
| Find specified type and remove from buffer, relocating metadata that remains and adjusting reported size of buffer. More... | |
| 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. More... | |
| virtual bool | isCopyEnabled () |
| Set/Get the 'copy' bit in the specified metadata header. More... | |
| virtual void | setCopyEnable (bool copyEnable) |
| virtual bool | setLengthAsValue (unsigned int value) |
| Set an integer value to be transmitted without using an actual payload. More... | |
| virtual bool | getLengthAsValue (unsigned int &value) const |
| Get an integer payload value from the payload length. More... | |
| virtual void | print (MAKRti::DtOutputStream &stream=MAKRti::DtDebug) |
| Print this Metadata. More... | |
| virtual DtNetMsgHeader * | netMessageHeader () |
| Get the net header of the message. More... | |
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() More... | |
| bool | myCopyEnabled |
| const DtMetadataType | myMetaDataType |
Private Member Functions | |
| DtRtiMtdFederateHostInformation (const DtRtiMtdFederateHostInformation &) | |
| Copy CTOR Not Implemented – Copy Not Allowed! More... | |
| DtRtiMtdFederateHostInformation & | operator= (const DtRtiMtdFederateHostInformation &) |
| Assignment Operator Not Implemented – Assignment Not Allowed! More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from DtRtiMetadata | |
| static unsigned int | metadataMaxSize () |
| Report maximum size of metadata buffer. More... | |
| 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. More... | |
| static bool | typeIsPresent (char const *msg, DtMetadataType type) |
| Determines whether metadata type is present in msg. More... | |
| 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. More... | |
| static void | reverseTransmogrifyHeader (DtMetadataNetHeader &src, DtMetadataNetHeader &dest) |
| Transform from host format to network format. More... | |
| static unsigned int | metadataSize (DtMetadataNetHeader &hdr) |
| static unsigned int | metadataPayloadSize (DtMetadataNetHeader &hdr) |
| Static Protected Attributes inherited from DtRtiMetadata | |
| static unsigned int | theMaxMetadataBufferSize |
DtRtiMtdFederateHostInformation is a metadata type used in RTI Network testing It is used to identify federate host information of recipient federates.
| DtRtiMtdFederateHostInformation::DtRtiMtdFederateHostInformation | ( | caddr_t | msg | ) |
Constructor.
| DtRtiMtdFederateHostInformation::DtRtiMtdFederateHostInformation | ( | DtRtiMsg * | msg | ) |
|
virtual |
Destructor.
|
private |
Copy CTOR Not Implemented – Copy Not Allowed!
|
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
|
private |
Assignment Operator Not Implemented – Assignment Not Allowed!
|
virtual |
Reserves space in RTI message buffer (if necessary) for additional FederateHostInformation metadata, encodes FederateHostInformation, and copies into message buffer.
|
protected |
