![]() |
MAK RTIspy API Documentation for HLA Evolved
|
Inheritance diagram for DtCreateMsg:
Collaboration diagram for DtCreateMsg:Public Member Functions | |
| DtCreateMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| Constructor. | |
| DtCreateMsg (unsigned long ID, const MAKRti::DtString &fedExNameVal, const std::vector< unsigned int > &moduleCrcs, MAKRti::DtFomType fedType, const std::vector< MAKRti::DtString > &moduleNames, const MAKRti::DtString &momModule, const MAKRti::DtString &timeImplNameVal=MAKRti::DtString::nullString(), DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| DtCreateMsg (const DtNetCreateMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| Constructor. | |
| virtual | ~DtCreateMsg () |
| Destructor. | |
| virtual DtRtiMsg * | clone (bool copy=true) const |
| Return a copy/empty object of the same type as this. | |
| virtual void | set (unsigned long ID, unsigned int momModuleCrc, const MAKRti::DtString &fedExNameVal, const std::vector< unsigned int > &moduleCrcs, MAKRti::DtFomType fedType, const std::vector< MAKRti::DtString > &moduleNames, const MAKRti::DtString &momModule, const MAKRti::DtString &timeImplNameVal) |
| Set all fields in this msg. | |
| void | setSourceID (const unsigned long ID) |
| Set/Get Source ID. | |
| unsigned long | sourceID () const |
| void | setMomModuleCrc (unsigned int theMomModuleCrc) |
| Set/Get MOM Module CRC. | |
| unsigned int | momModuleCrc () const |
| virtual void | setFullFedExName (const MAKRti::DtString &name) |
| Set/Get full name of federation execution. | |
| virtual const MAKRti::DtString | fullFedExName () const |
| virtual void | setTimeImplName (const MAKRti::DtString &name) |
| Set/Get TimeImplName. | |
| virtual MAKRti::DtString | timeImplName () const |
| virtual void | setFomModuleNames (const std::vector< MAKRti::DtString > &moduleNames) |
| Set/Get FedFileName. | |
| virtual void | getFomModuleNames (std::vector< MAKRti::DtString > &modules) const |
| virtual void | setFedFileType (MAKRti::DtFomType fedType) |
| Set/Get FED file type. | |
| virtual MAKRti::DtFomType | fedFileType () const |
| virtual bool | hasMOMModule () |
| Whether there is a MOM module for this federation. | |
| virtual void | setMOMModuleName (const MAKRti::DtString &name) |
| Set / Get momModuleName. | |
| virtual MAKRti::DtString | MOMmoduleName () const |
| virtual void | setCrcsOfFedFiles (const std::vector< unsigned int > &moduleCrcs) |
| Set/ Get a hashes (crcs) of the fed files. | |
| virtual void | getCRCsOfFedFiles (std::vector< unsigned int > &crcOfFedFiles) const |
| virtual void | printData (DtLogicalTimeFactory *logicalTimeFactory) const |
| Print the data section. | |
Public Member Functions inherited from DtRtiMsg | |
| virtual | ~DtRtiMsg () |
| Destructor. | |
| virtual DtRtiMsg * | cloneWithTransport (bool copy=true) const |
| Return a copy/empty object of the same type as this using clone and set the transport type from the host message. | |
| virtual DtNetMsgHeader * | netHeader () const |
| Get header of network representation. | |
| virtual int | version () const |
| Return the message version. | |
| virtual bool | isValidVersion () const |
| Returns bool: message version is valid? | |
| virtual void | setFedEx (const MAKRti::DtString &name) |
| All RTI messages contain information to identify which federation execution the message applies to. | |
| virtual void | setFedEx (int handle) |
| Set federation execution identifier as a handle. | |
| virtual bool | isForExec (const MAKRti::DtString &execName, int execHandle) const |
| Returns true if the current message belongs to the indicated federation execution, false otherwise. | |
| virtual DtRtiMsgKind | msgKind () const |
| Get the message kind. | |
| virtual const char * | kindString () const |
| Returns the message kind string name. | |
| virtual bool | isConstrained () const |
| Return boolean: message type can be time constrained? | |
| virtual bool | isAllowedDuringSave () const |
| Return boolean: message type can be processed during save? | |
| virtual void | setTime (const RTI::FedTime &time) |
| Set/Get time Used in timestamped messages. | |
| virtual RTI::FedTime const * | time (DtLogicalTimeFactory *fedTimeFactory) const |
| virtual bool | hasTime () const |
| Returns true if time field is valid. | |
| virtual void | setSerialNumber (unsigned long serialNumberValue) |
| Set/Get event retraction serial number Used in timestamped messages. | |
| virtual unsigned long | serialNumber () const |
| virtual void | setTransportType (DtTransportHandle type) |
| Set/Get transport type. | |
| virtual DtTransportHandle | transportType () const |
| virtual DtOrderHandle | orderType () const |
| This base implementation always returns recieve order. | |
| virtual bool | isMetadataPresent () const |
| Test if metadata has been added to a DtRtiMsg object. | |
| virtual bool | addMetadata (caddr_t *mtdAddr, unsigned int size, unsigned int *alignPad, unsigned int *headerPad=NULL) |
| Allocate space for next block of metadata. | |
| virtual void | removeMetadata (unsigned int size) |
| Update the size of the message when metadata has been removed. | |
| bool | isInteractionMsgType () const |
| Utility functions, check the message type against known interaciton/update message types. | |
| bool | isUpdateMsgType () const |
| virtual void | print (DtLogicalTimeFactory *logicalTimeFactory) const |
| Printing functions. | |
| virtual void | printHeader (DtLogicalTimeFactory *logicalTimeFactory) const |
| virtual void | printTime (const char *label, RTI::FedTime const *timeValue) const |
| Print the given time. | |
| virtual void | printInterval (const char *label, RTI::FedTime const *intervalValue) const |
| Print the interval. | |
| virtual int | status () const |
| Returns MSG_STATUS_OK if OK, a reason enumeration otherwise. | |
| virtual const MAKRti::DtString | fedExName () const |
| These two functions should be avoided in favor of isForExec(). | |
| virtual int | fedExHandle () const |
| Get the federation execution identifier as a handle Returns 0 if the identifier is being represented as a name. | |
| virtual void | setFederateHandle (DtFederateHandle handle) |
| Set/Get federate handle. | |
| virtual DtFederateHandle | federateHandle () const |
| Set/Get federate handle. | |
| virtual void | setSequenceNumber (unsigned long value) |
| Set/Get message sequence number. | |
| virtual unsigned long | sequenceNumber () const |
| Set/Get message sequence number. | |
| virtual void | setServiceCallNumber (unsigned long value) |
| Set/Get service call number. | |
| virtual unsigned long | serviceCallNumber () const |
| Set/Get service call number. | |
| virtual void | setTriggerMessageNumber (unsigned long value) |
| Set/Get trigger message sequence number (i.e., the message being processed that triggered this message being sent). | |
| virtual unsigned long | triggerMessageNumber () const |
| Set/Get trigger message sequence number (i.e., the message being processed that triggered this message being sent). | |
Static Public Member Functions | |
| static DtRtiMsg * | create (const DtNetMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) |
| Creator for receiving. | |
| static DtRtiMsg * | create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) |
| Creator for sending. | |
| static void | addCallback (DtConnectionMgr *conn, DtCreateCb cb, void *usr) |
| Callback management. | |
| static void | removeCallback (DtConnectionMgr *conn, DtCreateCb cb, void *usr) |
Static Public Member Functions inherited from DtRtiMsg | |
| static const DtNetMsgHeader * | netHeader (const void *buffer) |
| Extracts the header network representation from the buffer. | |
| static const char * | kindToString (DtRtiMsgKind kind) |
| Returns the name of the message, by kind enumeration. | |
| static const char * | kindString (const void *buffer) |
| Extracts the message kind from the given buffer and returns its string name. | |
| static const DtRtiMsgKind | msgKind (const void *buffer) |
| Extracts the message kind from the given buffer. | |
| static unsigned int | version (const void *buffer) |
| Extracts the message version form the given buffer. | |
| static unsigned int | fedExHandle (const void *buffer) |
| Extracts the message fedEx handle form the given buffer (0 if lightweight fedEx name) | |
| static DtFederateHandle | federateHandle (const void *buffer) |
| Extracts the message federate handle form the given buffer. | |
| static unsigned long | sequenceNumber (const void *buffer) |
| Extracts the message sequence number form the given buffer. | |
| static void | setDefaultRegionSet (unsigned long defaultRegionSet) |
| Set the default region set handle. | |
| static void | setUse32BitsForValueSize (bool use32BitsForValueSizeEnabled) |
| Set/Get flag to enable use of 32 bit size field for attribute/parameter values. | |
| static bool | use32BitsForValueSize () |
| static void | setSmartForwardingEnabled (bool enabled) |
| Set/Get is SmartForwarding enabled? | |
| static bool | smartForwardingEnabled () |
Protected Member Functions | |
| virtual DtNetCreateMsg * | netCreateMsg () |
| The network representation. | |
| virtual const DtNetCreateMsg * | netCreateMsg () const |
| virtual DtRtiMsgKind | internalDtRtiMsgKind () |
| Returns the kind of an Create Msg. | |
| virtual int | minSize () const |
| Returns minimum size of a message, including header. | |
| virtual int | setMinSizes (const MAKRti::DtString &fedExNameVal, const MAKRti::DtString &timeImplNameVal, const MAKRti::DtString &momModuleNameVal, const std::vector< MAKRti::DtString > &fomModuleNamesVal, const std::vector< unsigned int > &moduleCrcs) |
| Sets the field sizes for the variant components and returns the minimum size needed for the message, including header DOES NOT allocate memory for the components. | |
| virtual void | setFedExNameSize (unsigned long size) |
| Set/Get fedEx name size. | |
| virtual unsigned long | fedExNameSize () const |
| virtual void | setTimeImplNameSize (unsigned long size) |
| Set/Get time implementation name size. | |
| virtual unsigned long | timeImplNameSize () const |
| virtual void | setFomModuleNameSize (unsigned long size) |
| Set/Get fomModules Names size. | |
| virtual unsigned long | fomModuleNameSize () const |
| virtual void | setSizeOfMOMModuleName (unsigned long size) |
| virtual unsigned long | sizeOfMOMModuleName () const |
| virtual void | setNumOfCrcs (unsigned int theNumOfCrcs) |
| virtual unsigned long | numOfCrcs () const |
| virtual const char * | fedExNamePtr () const |
| Return pointer to component location in message. | |
| virtual const char * | timeImplNamePtr () const |
| virtual const char * | fomModuleNamesPtr () const |
| virtual const char * | momModuleNamePtr () const |
| virtual const DtNetU32 * | crcsOfFomModulesPtr () const |
| virtual char * | fedExNamePtr () |
| Return pointer to component location in message. | |
| virtual char * | timeImplNamePtr () |
| virtual char * | fomModuleNamesPtr () |
| virtual char * | momModuleNamePtr () |
| virtual DtNetU32 * | crcsOfFomModulesPtr () |
| virtual DtCreateMsg * | self () const |
| Casts away const-ness. | |
Protected Member Functions inherited from DtRtiMsg | |
| DtRtiMsg () | |
| Constructor. | |
| virtual void | sizeChanged (int size) |
| Called whenever size is changed using changeSize, or insert/deleteBytes. | |
| void | initDtRtiMsg (int size, DtRtiMsgKind msgKindVal, DtBufferPtr buffer) |
| Called by ctor, so not virtual. | |
| void | initDtRtiMsg (const void *initial, int size, DtBufferPtr buffer) |
| void | initDtRtiMsg (const DtNetMsgHeader *header, DtBufferPtr buffer) |
| virtual void | adjustBytes (int offset, int numBytes) |
| Adjust numBytes bytes at the indicated offset in the net rep. | |
| virtual void | adjustBytes (void *address, int numBytes) |
| Adjust the numBytes starting at the indicated addres. | |
Additional Inherited Members | |
Static Public Attributes inherited from DtRtiMsg | |
| static unsigned long | theDefaultRegionSetHandle = 0 |
| static const char * | theDefaultTag = NULL |
Protected Attributes inherited from DtRtiMsg | |
| DtTransportHandle | myTransportType |
| DtOrderHandle | myOrderType |
| RTI::FedTime * | myFedTime |
| bool | myTimeIsValid |
| bool | myConstrained |
| bool | myAllowedDuringSave |
| unsigned long | mySerialNumber |
| unsigned long | myServiceCallNumber |
| unsigned long | myTriggerMessage |
Static Protected Attributes inherited from DtRtiMsg | |
| static bool | theUse32BitsForValueSize = false |
| static bool | theSmartForwardingEnabled = false |
| DtCreateMsg::DtCreateMsg | ( | DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER | ) |
Constructor.
References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), and minSize().
| DtCreateMsg::DtCreateMsg | ( | unsigned long | ID, |
| const MAKRti::DtString & | fedExNameVal, | ||
| const std::vector< unsigned int > & | moduleCrcs, | ||
| MAKRti::DtFomType | fedType, | ||
| const std::vector< MAKRti::DtString > & | moduleNames, | ||
| const MAKRti::DtString & | momModule, | ||
| const MAKRti::DtString & | timeImplNameVal = MAKRti::DtString::nullString(), |
||
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) |
| DtCreateMsg::DtCreateMsg | ( | const DtNetCreateMsg * | netRepMsg, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) |
Constructor.
References DtNetCreateMsg::header, and DtRtiMsg::initDtRtiMsg().
|
virtual |
Destructor.
|
static |
Callback management.
References DtConnectionMgr::addMsgCallback(), and DtCreateMsgKind.
Referenced by DtRtiExec::DtRtiExec().
Return a copy/empty object of the same type as this.
Implements DtRtiMsg.
References DtCreateMsg(), and netCreateMsg().
|
protectedvirtual |
References netCreateMsg().
Referenced by fedExNamePtr(), getCRCsOfFedFiles(), and setCrcsOfFedFiles().
|
protectedvirtual |
References netCreateMsg().
|
static |
Creator for receiving.
References DtCreateMsg().
|
static |
Creator for sending.
References DtCreateMsg().
|
protectedvirtual |
Return pointer to component location in message.
References crcsOfFomModulesPtr(), and numOfCrcs().
Referenced by fullFedExName(), setFullFedExName(), and timeImplNamePtr().
|
protectedvirtual |
Return pointer to component location in message.
References crcsOfFomModulesPtr(), and numOfCrcs().
|
protectedvirtual |
References DtNetCreateMsg::fedExNameSize, and netCreateMsg().
Referenced by fullFedExName(), setFullFedExName(), and timeImplNamePtr().
|
virtual |
References DtNetCreateMsg::fedType, and netCreateMsg().
Referenced by DtRtiExec::processCreate().
|
protectedvirtual |
References DtNetCreateMsg::fomModuleNamesSize, and netCreateMsg().
Referenced by momModuleNamePtr(), and setFomModuleNames().
|
protectedvirtual |
References timeImplNamePtr(), and timeImplNameSize().
Referenced by getFomModuleNames(), momModuleNamePtr(), and setFomModuleNames().
|
protectedvirtual |
References timeImplNamePtr(), and timeImplNameSize().
|
virtual |
References fedExNamePtr(), and fedExNameSize().
Referenced by printData(), and DtRtiExec::processCreate().
|
virtual |
References crcsOfFomModulesPtr(), and numOfCrcs().
Referenced by printData(), and DtRtiExec::processCreate().
|
virtual |
References fomModuleNamesPtr(), netCreateMsg(), and DtNetCreateMsg::numFomModules.
Referenced by printData(), and DtRtiExec::processCreate().
|
virtual |
Whether there is a MOM module for this federation.
References DtNetCreateMsg::momModuleSize, and netCreateMsg().
|
protectedvirtual |
Returns the kind of an Create Msg.
Implements DtRtiMsg.
References DtCreateMsgKind.
Referenced by DtCreateMsg().
|
protectedvirtual |
Returns minimum size of a message, including header.
Referenced by DtCreateMsg(), and set().
| unsigned int DtCreateMsg::momModuleCrc | ( | ) | const |
References DtNetCreateMsg::momModuleCrc, and netCreateMsg().
Referenced by DtRtiExec::processCreate().
|
virtual |
References momModuleNamePtr(), and sizeOfMOMModuleName().
Referenced by printData(), and DtRtiExec::processCreate().
|
protectedvirtual |
References fomModuleNameSize(), and fomModuleNamesPtr().
Referenced by MOMmoduleName(), and setMOMModuleName().
|
protectedvirtual |
References fomModuleNameSize(), and fomModuleNamesPtr().
|
protectedvirtual |
The network representation.
Referenced by clone(), crcsOfFomModulesPtr(), fedExNameSize(), fedFileType(), fomModuleNameSize(), getFomModuleNames(), hasMOMModule(), momModuleCrc(), numOfCrcs(), set(), setFedExNameSize(), setFedFileType(), setFomModuleNames(), setFomModuleNameSize(), setFullFedExName(), setMomModuleCrc(), setMOMModuleName(), setNumOfCrcs(), setSizeOfMOMModuleName(), setSourceID(), setTimeImplName(), setTimeImplNameSize(), sizeOfMOMModuleName(), sourceID(), and timeImplNameSize().
|
protectedvirtual |
|
protectedvirtual |
References netCreateMsg(), and DtNetCreateMsg::numOfCrcs.
Referenced by fedExNamePtr(), getCRCsOfFedFiles(), and setCrcsOfFedFiles().
|
virtual |
Print the data section.
Reimplemented from DtRtiMsg.
References fullFedExName(), getCRCsOfFedFiles(), getFomModuleNames(), MOMmoduleName(), sourceID(), and timeImplName().
|
static |
References DtCreateMsgKind, and DtConnectionMgr::removeMsgCallback().
Referenced by DtRtiExec::~DtRtiExec().
|
inlineprotectedvirtual |
Casts away const-ness.
|
virtual |
Set all fields in this msg.
References rti1516e::insertBytes(), minSize(), netCreateMsg(), setCrcsOfFedFiles(), setFedFileType(), setFomModuleNames(), setFullFedExName(), setMinSizes(), setMomModuleCrc(), setMOMModuleName(), setSourceID(), and setTimeImplName().
Referenced by DtRtiExecFederateMgr::sendCreateMsg().
|
virtual |
Set/ Get a hashes (crcs) of the fed files.
References crcsOfFomModulesPtr(), rti1516e::insertBytes(), numOfCrcs(), and setNumOfCrcs().
Referenced by DtCreateMsg(), and set().
|
protectedvirtual |
Set/Get fedEx name size.
References DtNetCreateMsg::fedExNameSize, and netCreateMsg().
Referenced by setMinSizes().
|
virtual |
Set/Get FED file type.
References DtNetCreateMsg::fedType, and netCreateMsg().
Referenced by DtCreateMsg(), and set().
|
virtual |
Set/Get FedFileName.
References fomModuleNameSize(), fomModuleNamesPtr(), DtNetCreateMsg::fomModuleNamesSize, rti1516e::insertBytes(), netCreateMsg(), and DtNetCreateMsg::numFomModules.
Referenced by DtCreateMsg(), and set().
|
protectedvirtual |
Set/Get fomModules Names size.
References DtNetCreateMsg::fomModuleNamesSize, and netCreateMsg().
Referenced by setMinSizes().
|
virtual |
Set/Get full name of federation execution.
References fedExNamePtr(), DtNetCreateMsg::fedExNameSize, fedExNameSize(), rti1516e::insertBytes(), and netCreateMsg().
Referenced by DtCreateMsg(), and set().
|
protectedvirtual |
Sets the field sizes for the variant components and returns the minimum size needed for the message, including header DOES NOT allocate memory for the components.
References setFedExNameSize(), setFomModuleNameSize(), setNumOfCrcs(), and setTimeImplNameSize().
Referenced by DtCreateMsg(), and set().
| void DtCreateMsg::setMomModuleCrc | ( | unsigned int | theMomModuleCrc | ) |
Set/Get MOM Module CRC.
References DtNetCreateMsg::momModuleCrc, and netCreateMsg().
Referenced by set().
|
virtual |
Set / Get momModuleName.
References rti1516e::insertBytes(), momModuleNamePtr(), DtNetCreateMsg::momModuleSize, netCreateMsg(), and sizeOfMOMModuleName().
Referenced by DtCreateMsg(), and set().
|
protectedvirtual |
References netCreateMsg(), and DtNetCreateMsg::numOfCrcs.
Referenced by setCrcsOfFedFiles(), and setMinSizes().
|
protectedvirtual |
References DtNetCreateMsg::momModuleSize, and netCreateMsg().
| void DtCreateMsg::setSourceID | ( | const unsigned long | ID | ) |
Set/Get Source ID.
References netCreateMsg(), and DtNetCreateMsg::sourceID.
Referenced by DtCreateMsg(), and set().
|
virtual |
Set/Get TimeImplName.
References rti1516e::insertBytes(), netCreateMsg(), timeImplNamePtr(), DtNetCreateMsg::timeImplNameSize, and timeImplNameSize().
Referenced by DtCreateMsg(), and set().
|
protectedvirtual |
Set/Get time implementation name size.
References netCreateMsg(), and DtNetCreateMsg::timeImplNameSize.
Referenced by setMinSizes().
|
protectedvirtual |
References DtNetCreateMsg::momModuleSize, and netCreateMsg().
Referenced by MOMmoduleName(), and setMOMModuleName().
| unsigned long DtCreateMsg::sourceID | ( | ) | const |
References netCreateMsg(), and DtNetCreateMsg::sourceID.
Referenced by printData(), and DtRtiExec::processCreate().
|
virtual |
References timeImplNamePtr(), and timeImplNameSize().
Referenced by printData(), and DtRtiExec::processCreate().
|
protectedvirtual |
References fedExNamePtr(), and fedExNameSize().
Referenced by fomModuleNamesPtr(), setTimeImplName(), and timeImplName().
|
protectedvirtual |
References fedExNamePtr(), and fedExNameSize().
|
protectedvirtual |
References netCreateMsg(), and DtNetCreateMsg::timeImplNameSize.
Referenced by fomModuleNamesPtr(), setTimeImplName(), and timeImplName().