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

The DtAssistantNetworkTestEnableMsg defines a wrapper for the RTI Assistant network testing enable/disable message used by the Assistant to command an rtiexec to enable or disable testing for a given federation. More...

+ Inheritance diagram for DtAssistantNetworkTestEnableMsg:
+ Collaboration diagram for DtAssistantNetworkTestEnableMsg:

List of all members.

Public Member Functions

 DtAssistantNetworkTestEnableMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructors.
 DtAssistantNetworkTestEnableMsg (const DtNetAssistantNetworkTestEnableMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual ~DtAssistantNetworkTestEnableMsg ()
 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 for which network testing should be enabled or disabled.
virtual void setFederationHandle (unsigned long handle)
 Set the handle of the federation for which network testing should be enabled or disabled.
virtual bool enableTesting () const
 Gets whether testing should be enabled or disabled.
virtual void setEnableTesting (bool enable)
 Sets whether testing should be enabled or disabled.
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, DtAssistantNetworkTestEnableCb cb, void *usr)
 Adds or removes a callback with the given Assistant client for this message type.
static void removeCallback (DtRtiAssistantClient *conn, DtAssistantNetworkTestEnableCb cb, void *usr)

Protected Member Functions

virtual
DtNetAssistantNetworkTestEnableMsg
netAssistantNetworkTestEnableMsg ()
 The network representation for the message.
virtual const
DtNetAssistantNetworkTestEnableMsg
netAssistantNetworkTestEnableMsg () const
virtual DtAssistantMsgKind internalMsgKind ()
 Returns the kind of a DtAssistantNetworkTestEnableMsg message.
virtual int minSize () const
 Returns minimum size of a message, including header.

Detailed Description

The DtAssistantNetworkTestEnableMsg defines a wrapper for the RTI Assistant network testing enable/disable message used by the Assistant to command an rtiexec to enable or disable testing for a given federation.


Constructor & Destructor Documentation

DtAssistantNetworkTestEnableMsg::DtAssistantNetworkTestEnableMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructors.

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

Referenced by clone(), and create().

DtAssistantNetworkTestEnableMsg::DtAssistantNetworkTestEnableMsg ( const DtNetAssistantNetworkTestEnableMsg netRepMsg,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

Destructor.


Member Function Documentation

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

References DtRtiAssistantClient::addMsgCallback(), and DtAssistantNetworkTestEnableMsgKind.

Referenced by DtRtiexecObserverForAssistant::DtRtiexecObserverForAssistant().

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

Implements DtAssistantMsg.

References DtAssistantNetworkTestEnableMsg(), and netAssistantNetworkTestEnableMsg().

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

Creators.

References DtAssistantNetworkTestEnableMsg().

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

Get the handle of the federation for which network testing should be enabled or disabled.

References DtNetAssistantNetworkTestEnableMsg::federationHandle, and netAssistantNetworkTestEnableMsg().

Referenced by printData(), and DtRtiexecObserverForAssistant::processNetworkTestingEnableMsg().

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

Returns minimum size of a message, including header.

Referenced by DtAssistantNetworkTestEnableMsg().

The network representation for the message.

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

Print the data section.

Reimplemented from DtAssistantMsg.

References enableTesting(), and federationHandle().

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

Set the handle of the federation for which network testing should be enabled or disabled.

References DtNetAssistantNetworkTestEnableMsg::federationHandle, and netAssistantNetworkTestEnableMsg().

Referenced by DtRtiAssistantServer::sendNetworkTestEnableMsg(), and DtRtiAssistantPeer::sendNetworkTestEnableMsg().


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)