MAK RTIspy API Documentation for HLA 1516
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Public Attributes
DtNetMsgHeader Class Reference
+ Collaboration diagram for DtNetMsgHeader:

Public Member Functions

bool isForExec (const MAKRti::DtString &execName, unsigned short execHandle) const
 Returns true if the current message belongs to the indicated federation execution, false otherwise.
bool versionMatches (int messageVersion) const
 Returns bool: given version matches version in header?
bool metadataInMessage () const
 Accessor / Mutator for whether header indicates msg has metadata.
void setMetadataInMessage (bool yesNo)
bool isTestMgrMessage () const
 Accessor / Mutator for whether this is a test msg.
void setIsTestMgrMessage (bool yesNo)
bool isBundled () const
 Accessor / Mutator for whether this message is bundled.
void setIsBundled (bool yesNo)
bool isCompressed () const
 Accessor / Mutator for whether this message is compressed.
void setIsCompressed (bool yesNo)

Public Attributes

DtNetU32 totalSize
DtNetU8 versionCheck
 Older versions had message kind here.
DtNetU8 msgKind
DtNetU8 flags
DtNetU8 fedExecId [DtNetExecNameSize]
 Five bytes representing either the first five characters of the execution name, or a zero byte followed by a four-byte execution handle.
DtNetU16 version
DtNetU16 fedHandle
DtNetU32 sequenceNumber
DtNetU32 metadataSize

Member Function Documentation

bool DtNetMsgHeader::isBundled ( ) const

Accessor / Mutator for whether this message is bundled.

bool DtNetMsgHeader::isCompressed ( ) const

Accessor / Mutator for whether this message is compressed.

bool DtNetMsgHeader::isForExec ( const MAKRti::DtString &  execName,
unsigned short  execHandle 
) const

Returns true if the current message belongs to the indicated federation execution, false otherwise.

If you are not using an rtiexec, use a handle of zero.

bool DtNetMsgHeader::isTestMgrMessage ( ) const

Accessor / Mutator for whether this is a test msg.

bool DtNetMsgHeader::metadataInMessage ( ) const

Accessor / Mutator for whether header indicates msg has metadata.

void DtNetMsgHeader::setIsBundled ( bool  yesNo)
void DtNetMsgHeader::setIsCompressed ( bool  yesNo)
void DtNetMsgHeader::setIsTestMgrMessage ( bool  yesNo)
void DtNetMsgHeader::setMetadataInMessage ( bool  yesNo)
bool DtNetMsgHeader::versionMatches ( int  messageVersion) const

Returns bool: given version matches version in header?

Member Data Documentation

DtNetU8 DtNetMsgHeader::fedExecId[DtNetExecNameSize]

Five bytes representing either the first five characters of the execution name, or a zero byte followed by a four-byte execution handle.

DtNetU16 DtNetMsgHeader::fedHandle
DtNetU8 DtNetMsgHeader::flags
DtNetU32 DtNetMsgHeader::metadataSize
DtNetU8 DtNetMsgHeader::msgKind
DtNetU32 DtNetMsgHeader::sequenceNumber
DtNetU32 DtNetMsgHeader::totalSize
DtNetU16 DtNetMsgHeader::version
DtNetU8 DtNetMsgHeader::versionCheck

Older versions had message kind here.

Newer versions will put invalid message kind here.


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

Document ID: Generated on Mon Jul 9 10:30:41 EDT 2018 from SVN revision 190224
Copyright © 2005-2018 VT MÄK Inc. All Rights Reserved (www.mak.com)