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 | Protected Attributes
DtSaveRequestMsg Class Reference
+ Inheritance diagram for DtSaveRequestMsg:
+ Collaboration diagram for DtSaveRequestMsg:

Public Member Functions

 DtSaveRequestMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
 DtSaveRequestMsg (unsigned long requestIDValue, const char *theLabel, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
 DtSaveRequestMsg (const DtNetSaveMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
virtual ~DtSaveRequestMsg ()
 Destructor.
virtual DtRtiMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this.
virtual void set (unsigned long theRequestID, const char *theLabel)
 Set all fields.
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, DtSaveRequestCb cb, void *usr)
 Callback management.
static void removeCallback (DtConnectionMgr *conn, DtSaveRequestCb cb, void *usr)

Protected Member Functions

virtual DtRtiMsgKind internalDtRtiMsgKind ()
 Returns the kind of an Save Request 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 DtNetSaveMsgnetSaveMsg ()
 The network representation.
virtual const DtNetSaveMsgnetSaveMsg () const
virtual int minSize (char const *theLabel=NULL, RTI::FedTime const *theTime=NULL) const
 Returns minimum size of a message, including header.
virtual DtSaveMsgself () 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.

Protected Attributes

char * myTag
- Protected Attributes inherited from DtSaveMsg
char * myLabel
- Protected Attributes inherited from DtRtiMsg
DtTransportHandle myTransportType
DtOrderHandle myOrderType
RTI::FedTimemyFedTime
bool myTimeIsValid
bool myConstrained
bool myAllowedDuringSave
unsigned long mySerialNumber
unsigned long myServiceCallNumber
unsigned long myTriggerMessage

Additional Inherited Members

- Static Public Attributes inherited from DtRtiMsg
static unsigned long theDefaultRegionSetHandle = 0
static const char * theDefaultTag = NULL
- Static Protected Attributes inherited from DtRtiMsg
static bool theUse32BitsForValueSize = false
static bool theSmartForwardingEnabled = false

Constructor & Destructor Documentation

DtSaveRequestMsg::DtSaveRequestMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructor.

References DtRtiMsg::initDtRtiMsg(), internalDtRtiMsgKind(), and DtSaveMsg::minSize().

Referenced by clone(), and create().

DtSaveRequestMsg::DtSaveRequestMsg ( unsigned long  requestIDValue,
const char *  theLabel,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtSaveRequestMsg::DtSaveRequestMsg ( const DtNetSaveMsg netRepMsg,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

Constructor.

References DtNetSaveMsg::header, and DtRtiMsg::initDtRtiMsg().

DtSaveRequestMsg::~DtSaveRequestMsg ( )
virtual

Destructor.

Member Function Documentation

void DtSaveRequestMsg::addCallback ( DtConnectionMgr conn,
DtSaveRequestCb  cb,
void *  usr 
)
static

Callback management.

References DtConnectionMgr::addMsgCallback(), and DtSaveRequestMsgKind.

Referenced by DtFedExec::DtFedExec().

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

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

Implements DtRtiMsg.

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

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

Creator.

References DtSaveRequestMsg().

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

Creator.

References DtSaveRequestMsg().

DtRtiMsgKind DtSaveRequestMsg::internalDtRtiMsgKind ( )
protectedvirtual

Returns the kind of an Save Request Msg.

Reimplemented from DtSaveMsg.

References DtSaveRequestMsgKind.

Referenced by DtSaveRequestMsg().

void DtSaveRequestMsg::printData ( DtLogicalTimeFactory logicalTimeFactory) const
virtual

Print the data section.

Reimplemented from DtSaveMsg.

References DtSaveMsg::label(), and DtSaveMsg::requestID().

void DtSaveRequestMsg::removeCallback ( DtConnectionMgr conn,
DtSaveRequestCb  cb,
void *  usr 
)
static
void DtSaveRequestMsg::set ( unsigned long  theRequestID,
const char *  theLabel 
)
virtual

Member Data Documentation

char* DtSaveRequestMsg::myTag
protected

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)