MAK RTIspy API Documentation for HLA Evolved
Public Member Functions | Static Public Member Functions | Protected Member Functions
DtAssistantDeleteFederationMsg Class Reference

The DtAssistantDeleteFederationMsg defines a wrapper for the RTI Assistant delete federation message used by the Assistant to command an rtiexec to destroy a federation. More...

+ Inheritance diagram for DtAssistantDeleteFederationMsg:
+ Collaboration diagram for DtAssistantDeleteFederationMsg:

List of all members.

Public Member Functions

 DtAssistantDeleteFederationMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructors.
 DtAssistantDeleteFederationMsg (const DtNetAssistantDeleteFederationMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual ~DtAssistantDeleteFederationMsg ()
 Destructor.
virtual DtAssistantMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this.
virtual unsigned long federationHandle () const
 Get the handle of the federation to be deleted.
virtual void setFederationHandle (unsigned long handle)
 Set the handle of the federation to be deleted.
virtual void printData () const
 Print the data section.

Static Public Member Functions

static DtAssistantMsgcreate (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Creators.
static DtAssistantMsgcreate (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void addCallback (DtRtiAssistantClient *conn, DtAssistantDeleteFederationCb cb, void *usr)
 Adds or removes a callback with the given Assistant client for this message type.
static void removeCallback (DtRtiAssistantClient *conn, DtAssistantDeleteFederationCb cb, void *usr)
static void addCallback (DtRtiAssistantPeer *conn, DtAssistantDeleteFederationCb cb, void *usr)
 Adds or removes a callback with the given Assistant peer for this message type.
static void removeCallback (DtRtiAssistantPeer *conn, DtAssistantDeleteFederationCb cb, void *usr)

Protected Member Functions

virtual
DtNetAssistantDeleteFederationMsg
netAssistantDeleteFederationMsg ()
 The network representation for the delete federation message.
virtual const
DtNetAssistantDeleteFederationMsg
netAssistantDeleteFederationMsg () const
virtual DtAssistantMsgKind internalMsgKind ()
 Returns the kind of a DtAssistantDeleteFederationMsg message.
virtual int minSize () const
 Returns minimum size of a message, including header.

Detailed Description

The DtAssistantDeleteFederationMsg defines a wrapper for the RTI Assistant delete federation message used by the Assistant to command an rtiexec to destroy a federation.


Constructor & Destructor Documentation

DtAssistantDeleteFederationMsg::DtAssistantDeleteFederationMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructors.

References DtAssistantMsg::initAssistantMsg(), internalMsgKind(), and minSize().

Referenced by clone(), and create().

DtAssistantDeleteFederationMsg::DtAssistantDeleteFederationMsg ( const DtNetAssistantDeleteFederationMsg netRepMsg,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

Destructor.


Member Function Documentation

Adds or removes a callback with the given Assistant peer for this message type.

References DtRtiAssistantPeer::addMsgCallback(), and DtAssistantDeleteFederationMsgKind.

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

Implements DtAssistantMsg.

References DtAssistantDeleteFederationMsg(), and netAssistantDeleteFederationMsg().

DtAssistantMsg * DtAssistantDeleteFederationMsg::create ( const DtNetAssistantMsgHeader initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
) [static]

Creators.

References DtAssistantDeleteFederationMsg().

DtAssistantMsg * DtAssistantDeleteFederationMsg::create ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER) [static]
unsigned long DtAssistantDeleteFederationMsg::federationHandle ( ) const [virtual]

Returns the kind of a DtAssistantDeleteFederationMsg message.

Implements DtAssistantMsg.

References DtAssistantDeleteFederationMsgKind.

Referenced by DtAssistantDeleteFederationMsg().

int DtAssistantDeleteFederationMsg::minSize ( ) const [protected, virtual]

Returns minimum size of a message, including header.

Referenced by DtAssistantDeleteFederationMsg().

The network representation for the delete federation message.

Referenced by clone(), federationHandle(), and setFederationHandle().

Print the data section.

Reimplemented from DtAssistantMsg.

void DtAssistantDeleteFederationMsg::setFederationHandle ( unsigned long  handle) [virtual]

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

Document ID: Generated on Thu Jun 14 14:15:04 EDT 2012 from SVN revision 116116
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)