MAK RTIspy API Documentation for HLA 1.3
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions
DtDeleteRoMsg Class Reference

Message for sending receive order delete. More...

+ Inheritance diagram for DtDeleteRoMsg:
+ Collaboration diagram for DtDeleteRoMsg:

Public Member Functions

 DtDeleteRoMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
 DtDeleteRoMsg (DtObjectInstanceHandle theObj, char const *theTag, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
 DtDeleteRoMsg (const DtNetDeleteMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
virtual ~DtDeleteRoMsg ()
 Destructor.
virtual DtRtiMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this.
virtual void set (DtObjectInstanceHandle theObj, char const *theTag)
 Set all fields simultaneously.
virtual void setId (DtObjectInstanceHandle id)
 Set/Get handle.
virtual DtObjectInstanceHandle id () const
virtual void printData (DtLogicalTimeFactory *logicalTimeFactory) const
 Print the data section.
- Public Member Functions inherited from DtDeleteMsg
 DtDeleteMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructor.
virtual ~DtDeleteMsg ()
 Destructor.
virtual void setTag (char const *tag)
 Set/Get tag.
virtual char const * tag () 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 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 DtRtiMsgcreate (const DtNetMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Creator.
static DtRtiMsgcreate (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Creator.
static void addCallback (DtConnectionMgr *conn, DtDeleteRoCb cb, void *usr)
 Callback management.
static void removeCallback (DtConnectionMgr *conn, DtDeleteRoCb cb, void *usr)

Protected Member Functions

virtual DtNetDeleteMsgnetDeleteRoMsg ()
 The network representation.
virtual const DtNetDeleteMsgnetDeleteRoMsg () const
virtual DtRtiMsgKind internalDtRtiMsgKind ()
 Returns the kind of an Delete Msg.
virtual int minSize (char const *theTag=NULL) const
 Returns minimum size of a message, including header.
virtual void setTagSize (int size)
 Set/Get tag size.
virtual int tagSize () const
virtual char * tagPtr ()
 Returns pointer to the tag in the netMsg.
virtual DtDeleteRoMsgselfRo () const
 Casts away const-ness.
- Protected Member Functions inherited from DtDeleteMsg
virtual int tagFieldSize () const
 Returns size of tag field.
virtual DtDeleteMsgself () 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 DtDeleteMsg
char * myTag
- Static Protected Attributes inherited from DtRtiMsg
static bool theUse32BitsForValueSize = false
static bool theSmartForwardingEnabled = false

Detailed Description

Message for sending receive order delete.

Constructor & Destructor Documentation

DtDeleteRoMsg::DtDeleteRoMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)
DtDeleteRoMsg::DtDeleteRoMsg ( DtObjectInstanceHandle  theObj,
char const *  theTag,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtDeleteRoMsg::DtDeleteRoMsg ( const DtNetDeleteMsg netRepMsg,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

Constructor.

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

DtDeleteRoMsg::~DtDeleteRoMsg ( )
virtual

Destructor.

Member Function Documentation

void DtDeleteRoMsg::addCallback ( DtConnectionMgr conn,
DtDeleteRoCb  cb,
void *  usr 
)
static

Callback management.

References DtConnectionMgr::addMsgCallback(), and DtDeleteRoMsgKind.

Referenced by DtObjectMgr::DtObjectMgr().

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

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

Implements DtRtiMsg.

References DtDeleteRoMsg(), and netDeleteRoMsg().

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

Creator.

References DtDeleteRoMsg().

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

Creator.

References DtDeleteRoMsg().

DtObjectInstanceHandle DtDeleteRoMsg::id ( ) const
virtual

Implements DtDeleteMsg.

References DtNetDeleteMsg::id, and netDeleteRoMsg().

Referenced by DtObjectMgr::processDelete(), and setId().

DtRtiMsgKind DtDeleteRoMsg::internalDtRtiMsgKind ( )
protectedvirtual

Returns the kind of an Delete Msg.

Implements DtRtiMsg.

References DtDeleteRoMsgKind.

Referenced by DtDeleteRoMsg().

int DtDeleteRoMsg::minSize ( char const *  theTag = NULL) const
protectedvirtual

Returns minimum size of a message, including header.

Referenced by DtDeleteRoMsg().

DtNetDeleteMsg * DtDeleteRoMsg::netDeleteRoMsg ( )
protectedvirtual

The network representation.

Referenced by clone(), id(), setId(), setTagSize(), tagPtr(), and tagSize().

const DtNetDeleteMsg * DtDeleteRoMsg::netDeleteRoMsg ( ) const
protectedvirtual
void DtDeleteRoMsg::printData ( DtLogicalTimeFactory logicalTimeFactory) const
virtual

Print the data section.

Reimplemented from DtRtiMsg.

References DtDeleteMsg::tag().

void DtDeleteRoMsg::removeCallback ( DtConnectionMgr conn,
DtDeleteRoCb  cb,
void *  usr 
)
static
DtDeleteRoMsg * DtDeleteRoMsg::selfRo ( ) const
inlineprotectedvirtual

Casts away const-ness.

void DtDeleteRoMsg::set ( DtObjectInstanceHandle  theObj,
char const *  theTag 
)
virtual

Set all fields simultaneously.

Referenced by DtObjectMgr::sendDeleteMsg().

void DtDeleteRoMsg::setId ( DtObjectInstanceHandle  id)
virtual

Set/Get handle.

Implements DtDeleteMsg.

References DtNetDeleteMsg::id, id(), and netDeleteRoMsg().

Referenced by DtDeleteRoMsg().

void DtDeleteRoMsg::setTagSize ( int  size)
protectedvirtual

Set/Get tag size.

Implements DtDeleteMsg.

References netDeleteRoMsg(), and DtNetDeleteMsg::tagSize.

char * DtDeleteRoMsg::tagPtr ( )
protectedvirtual

Returns pointer to the tag in the netMsg.

Implements DtDeleteMsg.

References netDeleteRoMsg(), and tagSize().

int DtDeleteRoMsg::tagSize ( ) const
protectedvirtual

Implements DtDeleteMsg.

References netDeleteRoMsg(), and DtNetDeleteMsg::tagSize.

Referenced by tagPtr().


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

Document ID: Generated on Fri Mar 14 19:08:55 EDT 2014 from SVN revision 137085
Copyright © 2005-2014 VT MÄK Inc. All Rights Reserved (www.mak.com)