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

Public Member Functions

 DtRestoreCompleteMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
 DtRestoreCompleteMsg (const char *theLabel, const bool success, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
 DtRestoreCompleteMsg (const DtNetSaveMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
virtual ~DtRestoreCompleteMsg ()
 Destructor.
virtual DtRtiMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this.
- Public Member Functions inherited from DtSaveCompleteMsg
 DtSaveCompleteMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
 DtSaveCompleteMsg (const char *theLabel, const bool success, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
 DtSaveCompleteMsg (const DtNetSaveMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
virtual ~DtSaveCompleteMsg ()
 Destructor.
void set (const char *theLabel, const bool success)
 Set all fields.
virtual void setSuccessIndicator (const bool success)
 Set/Get successIndicator.
virtual bool successIndicator () const
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 DtRtiMsgcloneWithTransport (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 DtNetMsgHeadernetHeader () 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 DtRtiMsgcreate (const DtNetMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Creator.
static DtRtiMsgcreate (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Creator.
static void addCallback (DtConnectionMgr *conn, DtRestoreCompleteCb cb, void *usr)
 Callback management.
static void removeCallback (DtConnectionMgr *conn, DtRestoreCompleteCb cb, void *usr)
- Static Public Member Functions inherited from DtSaveCompleteMsg
static void addCallback (DtConnectionMgr *conn, DtSaveCompleteCb cb, void *usr)
 Callback management.
static void removeCallback (DtConnectionMgr *conn, DtSaveCompleteCb cb, void *usr)

Protected Member Functions

virtual DtRtiMsgKind internalDtRtiMsgKind ()
 Returns the kind of an Restore Complete Msg.

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

Constructor & Destructor Documentation

DtRestoreCompleteMsg::DtRestoreCompleteMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructor.

References internalDtRtiMsgKind(), DtNetMsgHeader::msgKind, and DtRtiMsg::netHeader().

Referenced by clone(), and create().

DtRestoreCompleteMsg::DtRestoreCompleteMsg ( const char *  theLabel,
const bool  success,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtRestoreCompleteMsg::DtRestoreCompleteMsg ( const DtNetSaveMsg netRepMsg,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtRestoreCompleteMsg::~DtRestoreCompleteMsg ( )
virtual

Destructor.

Member Function Documentation

void DtRestoreCompleteMsg::addCallback ( DtConnectionMgr conn,
DtRestoreCompleteCb  cb,
void *  usr 
)
static

Callback management.

References DtConnectionMgr::addMsgCallback(), and DtRestoreCompleteMsgKind.

Referenced by DtFedExec::DtFedExec().

DtRtiMsg * DtRestoreCompleteMsg::clone ( bool  copy = true) const
virtual

Return a copy/empty object of the same type as this.

Reimplemented from DtSaveCompleteMsg.

References DtRestoreCompleteMsg(), and DtSaveMsg::netSaveMsg().

DtRtiMsg * DtRestoreCompleteMsg::create ( const DtNetMsgHeader initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
static

Creator.

Reimplemented from DtSaveCompleteMsg.

References DtRestoreCompleteMsg().

DtRtiMsg * DtRestoreCompleteMsg::create ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)
static

Creator.

Reimplemented from DtSaveCompleteMsg.

References DtRestoreCompleteMsg().

DtRtiMsgKind DtRestoreCompleteMsg::internalDtRtiMsgKind ( )
protectedvirtual

Returns the kind of an Restore Complete Msg.

Reimplemented from DtSaveCompleteMsg.

References DtRestoreCompleteMsgKind.

Referenced by DtRestoreCompleteMsg().

void DtRestoreCompleteMsg::removeCallback ( DtConnectionMgr conn,
DtRestoreCompleteCb  cb,
void *  usr 
)
static

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

Document ID: Generated on Wed Mar 11 20:26:49 EDT 2015 from SVN revision 150939
Copyright © 2005-2015 VT MÄK Inc. All Rights Reserved (www.mak.com)