![]() |
MAK RTIspy API Documentation for HLA Evolved
|
The DtAssistantRemovalMsg defines a wrapper for the RTI Assistant removal message used by Assistants to inform other Assistants that they are shutting down and should be removed from any Assistant lists. More...
Inheritance diagram for DtAssistantRemovalMsg:
Collaboration diagram for DtAssistantRemovalMsg:Public Member Functions | |
| DtAssistantRemovalMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| Constructors. | |
| DtAssistantRemovalMsg (const DtNetAssistantRemovalMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| virtual | ~DtAssistantRemovalMsg () |
| Destructor. | |
| virtual DtAssistantMsg * | clone (bool copy=true) const |
| Return a copy/empty object of the same type as this. | |
| virtual void | printData () const |
| Print the data section. | |
Public Member Functions inherited from DtAssistantMsg | |
| virtual | ~DtAssistantMsg () |
| Destructor. | |
| virtual DtNetAssistantMsgHeader * | 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 DtAssistantMsgKind | msgKind () const |
| Get the message kind. | |
| virtual void | print () const |
| Printing functions. | |
| virtual void | printHeader () const |
| virtual bool | isOk () const |
| Message is good? | |
| bool | isAssistantToAssistantMessage () const |
| Returns whether or not this message contains source/destination information included in messages sent between assistants. | |
| virtual MAKRti::DtInetAddr | sourceAddr () const |
| Get/Set the IP address of the source of this message. | |
| virtual void | setSourceAddr (const MAKRti::DtInetAddr &addr) |
| virtual int | sourceId () const |
| Get/Set the ID of the source of this message. | |
| virtual void | setSourceId (int id) |
| virtual MAKRti::DtString | sourceHost () const |
| Get/Set the host name of the source of this message. | |
| virtual void | setSourceHost (const MAKRti::DtString &addr) |
| virtual MAKRti::DtInetAddr | destAddr () const |
| Get/Set the IP address of the destination of this message. | |
| virtual void | setDestAddr (const MAKRti::DtInetAddr &addr) |
| virtual int | destId () const |
| Get/Set the ID of the destination of this message. | |
| virtual void | setDestId (int id) |
| virtual int | compId () const |
| Get/Set the related component's connection ID. | |
| virtual void | setCompId (int compId) |
Static Public Member Functions | |
| static DtAssistantMsg * | create (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) |
| Creators. | |
| static DtAssistantMsg * | create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) |
| static void | addCallback (DtRtiAssistantPeer *conn, DtAssistantRemovalCb cb, void *usr) |
| Adds or removes a callback with the given Assistant peer for this message type. | |
| static void | removeCallback (DtRtiAssistantPeer *conn, DtAssistantRemovalCb cb, void *usr) |
Static Public Member Functions inherited from DtAssistantMsg | |
| static const char * | kindToString (DtAssistantMsgKind kind) |
| Returns the name of the message, by kind enumeration. | |
Protected Member Functions | |
| virtual DtNetAssistantRemovalMsg * | netAssistantRemovalMsg () |
| The network representation for the removal message. | |
| virtual const DtNetAssistantRemovalMsg * | netAssistantRemovalMsg () const |
| virtual DtAssistantMsgKind | internalMsgKind () |
| Returns the kind of a DtAssistantQueryMsg message. | |
| virtual int | minSize () const |
| Returns minimum size of a message, including header. | |
Protected Member Functions inherited from DtAssistantMsg | |
| DtAssistantMsg () | |
| Constructor. | |
| virtual void | sizeChanged (int size) |
| Called whenever size is changed using changeSize, or insert/deleteBytes. | |
| void | initAssistantMsg (int size, DtAssistantMsgKind msgKindVal, DtBufferPtr buffer) |
| Called by ctor, so not virtual. | |
| void | initAssistantMsg (const void *initial, int size, DtBufferPtr buffer) |
| void | initAssistantMsg (const DtNetAssistantMsgHeader *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 address. | |
| virtual void | resizeForSrcDestInfo () |
| Allocates memory at the end of the message for source/destination information needed when sending messages between assistants. | |
| virtual const DtNetAssistantSrcDestInfo * | srcDestInfoPtr () const |
| Return pointer to source/destination information in the message. | |
| virtual DtNetAssistantSrcDestInfo * | srcDestInfoPtr () |
| virtual void | setSourceHostSize (unsigned long size) |
| Set/Get source host name text size. | |
| virtual unsigned long | sourceHostSize () const |
| virtual const char * | sourceHostPtr () const |
| Return pointer to source host name in message. | |
| virtual char * | sourceHostPtr () |
The DtAssistantRemovalMsg defines a wrapper for the RTI Assistant removal message used by Assistants to inform other Assistants that they are shutting down and should be removed from any Assistant lists.
| DtAssistantRemovalMsg::DtAssistantRemovalMsg | ( | DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER | ) |
Constructors.
References DtAssistantMsg::initAssistantMsg(), internalMsgKind(), and minSize().
| DtAssistantRemovalMsg::DtAssistantRemovalMsg | ( | const DtNetAssistantRemovalMsg * | netRepMsg, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) |
References DtNetAssistantRemovalMsg::header, and DtAssistantMsg::initAssistantMsg().
|
virtual |
Destructor.
|
static |
Adds or removes a callback with the given Assistant peer for this message type.
References DtRtiAssistantPeer::addMsgCallback(), and DtAssistantRemovalMsgKind.
Referenced by DtAssistantConnectionInfoMgr::DtAssistantConnectionInfoMgr().
|
virtual |
Return a copy/empty object of the same type as this.
Implements DtAssistantMsg.
References DtAssistantRemovalMsg(), and netAssistantRemovalMsg().
|
static |
Creators.
References DtAssistantRemovalMsg().
|
static |
References DtAssistantRemovalMsg().
|
protectedvirtual |
Returns the kind of a DtAssistantQueryMsg message.
Implements DtAssistantMsg.
References DtAssistantRemovalMsgKind.
Referenced by DtAssistantRemovalMsg().
|
protectedvirtual |
Returns minimum size of a message, including header.
Referenced by DtAssistantRemovalMsg().
|
protectedvirtual |
The network representation for the removal message.
Referenced by clone().
|
protectedvirtual |
|
virtual |
Print the data section.
Reimplemented from DtAssistantMsg.
|
static |
References DtAssistantRemovalMsgKind, and DtRtiAssistantPeer::removeMsgCallback().
Referenced by DtAssistantConnectionInfoMgr::~DtAssistantConnectionInfoMgr().