![]() |
MAK RTIspy API Documentation for HLA Evolved
|
Inheritance diagram for DtSaveBegunMsg:
Collaboration diagram for DtSaveBegunMsg:Public Member Functions | |
| DtSaveBegunMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| Constructor. | |
| DtSaveBegunMsg (const DtNetSaveMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| Constructor. | |
| virtual | ~DtSaveBegunMsg () |
| Destructor. | |
| virtual DtRtiMsg * | clone (bool copy=true) const |
| Return a copy/empty object of the same type as this. | |
| virtual void | printData (DtLogicalTimeFactory *logicalTimeFactory) const |
| Print the data section. | |
Public Member Functions inherited from DtSaveMsg | |
| DtSaveMsg () | |
| Constructor. | |
| virtual | ~DtSaveMsg () |
| Destructor. | |
| void | set (const char *theLabel) |
| Set all fields. | |
| virtual void | setLabel (const char *label) |
| Set/Get tag. | |
| virtual const char * | label () const |
| virtual void | setRequestID (unsigned long requestIDValue) |
| Set/Get request ID. | |
| virtual unsigned long | requestID () const |
| virtual void | setResult (unsigned char result) |
| Set/Get result. | |
| virtual unsigned char | result () const |
| virtual void | setTime (RTI::FedTime const &timeVal) |
| Set/Get time. | |
| virtual RTI::FedTime const * | time (DtLogicalTimeFactory *logicalTimeFactory) const |
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 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. | |
| static DtRtiMsg * | create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) |
| Creator. | |
| static void | addCallback (DtConnectionMgr *conn, DtSaveBegunCb cb, void *usr) |
| Callback management. | |
| static void | removeCallback (DtConnectionMgr *conn, DtSaveBegunCb cb, void *usr) |
Protected Member Functions | |
| virtual DtRtiMsgKind | internalDtRtiMsgKind () |
| Returns the kind of an Save Begun Msg. | |
Protected Member Functions inherited from DtSaveMsg | |
| virtual char * | labelPtr () |
| Returns pointer to the label in the netMsg. | |
| virtual char * | timePtr () |
| Returns pointer to the time in the netMsg. | |
| virtual int | labelFieldSize () const |
| Returns size of label field. | |
| virtual int | timeFieldSize () const |
| Returns size of timestamp field (including serial number) | |
| virtual void | setLabelSize (int size) |
| Set/Get tag size. | |
| virtual int | labelSize () const |
| virtual void | setTimeSize (int size) |
| Set/Get time size. | |
| virtual int | timeSize () const |
| virtual DtNetSaveMsg * | netSaveMsg () |
| The network representation. | |
| virtual const DtNetSaveMsg * | netSaveMsg () const |
| virtual int | minSize (char const *theLabel=NULL, RTI::FedTime const *theTime=NULL) const |
| Returns minimum size of a message, including header. | |
| virtual DtSaveMsg * | 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 DtSaveMsg | |
| char * | myLabel |
Static Protected Attributes inherited from DtRtiMsg | |
| static bool | theUse32BitsForValueSize = false |
| static bool | theSmartForwardingEnabled = false |
| DtSaveBegunMsg::DtSaveBegunMsg | ( | DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER | ) |
Constructor.
References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), and DtSaveMsg::minSize().
| DtSaveBegunMsg::DtSaveBegunMsg | ( | const DtNetSaveMsg * | netRepMsg, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) |
Constructor.
References DtNetSaveMsg::header, and DtRtiMsg::initDtRtiMsg().
|
virtual |
Destructor.
|
static |
Callback management.
References DtConnectionMgr::addMsgCallback(), and DtSaveBegunMsgKind.
Referenced by DtFedExec::DtFedExec().
Return a copy/empty object of the same type as this.
Implements DtRtiMsg.
References DtSaveBegunMsg(), and DtSaveMsg::netSaveMsg().
|
static |
Creator.
References DtSaveBegunMsg().
|
static |
Creator.
References DtSaveBegunMsg().
|
protectedvirtual |
Returns the kind of an Save Begun Msg.
Reimplemented from DtSaveMsg.
References DtSaveBegunMsgKind.
Referenced by DtSaveBegunMsg().
|
virtual |
Print the data section.
Reimplemented from DtSaveMsg.
|
static |
References DtSaveBegunMsgKind, and DtConnectionMgr::removeMsgCallback().
Referenced by DtFedExec::~DtFedExec().