MAK RTIspy API Documentation for HLA 1.3
Public Member Functions | Static Public Member Functions | Protected Member Functions
DtAssistantAwaitingForwardersMsg Class Reference

The DtAssistantAwaitingForwardersMsg defines a wrapper for the RTI Assistant message sent to an assistant from a local RTI Forwarder to its Assistant to inform it that it is waiting for connections from other RTI Forwarders. More...

+ Inheritance diagram for DtAssistantAwaitingForwardersMsg:
+ Collaboration diagram for DtAssistantAwaitingForwardersMsg:

List of all members.

Public Member Functions

 DtAssistantAwaitingForwardersMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructors.
 DtAssistantAwaitingForwardersMsg (const DtNetAssistantAwaitingForwardersMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual ~DtAssistantAwaitingForwardersMsg ()
 Destructor.
virtual DtAssistantMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this.
virtual void printData () const
 Print the data section.
void getForwarders (DtNeededFwConnMap &fws) const
 Get the list of forwarder connections.
void setForwarders (const DtNeededFwConnMap &fws)
 Set the list of forwarder connections.
bool isWaitingForForwarders () const
 Get whether the forwarder is waiting for forwarder-to-forwarder connections.
void setIsWaitingForForwarders (bool isWaiting)
 Set whether the forwarder is waiting for forwarder-to-forwarder connections.
unsigned int numForwarders () const
 Returns the number of forwarder connections.

Static Public Member Functions

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

Protected Member Functions

virtual
DtNetAssistantAwaitingForwardersMsg
netAssistantAwaitingForwardersMsg ()
 The network representation for the message.
virtual const
DtNetAssistantAwaitingForwardersMsg
netAssistantAwaitingForwardersMsg () const
virtual DtAssistantMsgKind internalMsgKind ()
 Returns the kind of a DtNetAssistantAwaitingForwardersMsg message.
virtual int minSize () const
 Returns minimum size of a message, including header.
virtual const DtNetU128 * forwarderAddrsPtr () const
 Get the pointer to the forwarder addresses data.
virtual DtNetU128 * forwarderAddrsPtr ()
virtual const DtNetU16 * forwarderPortsPtr () const
 Get the pointer to the forwarder ports data.
virtual DtNetU16 * forwarderPortsPtr ()
virtual unsigned int forwarderNamesSize () const
 Get/Set the total size of all the forwarder names.
virtual void setForwarderNamesSize (unsigned int size)
virtual const char * forwarderNamesPtr () const
 Get the pointer to the forwarder names data.
virtual char * forwarderNamesPtr ()
const DtNetU8 * forwarderConnectedPtr () const
 Get the pointer to connection status data for the forwarders.
DtNetU8 * forwarderConnectedPtr ()

Detailed Description

The DtAssistantAwaitingForwardersMsg defines a wrapper for the RTI Assistant message sent to an assistant from a local RTI Forwarder to its Assistant to inform it that it is waiting for connections from other RTI Forwarders.


Constructor & Destructor Documentation

DtAssistantAwaitingForwardersMsg::DtAssistantAwaitingForwardersMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructors.

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

Referenced by clone().

DtAssistantAwaitingForwardersMsg::DtAssistantAwaitingForwardersMsg ( const DtNetAssistantAwaitingForwardersMsg netRepMsg,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

Destructor.


Member Function Documentation

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

References DtRtiAssistantServer::addMsgCallback(), and DtAssistantAwaitingForwardersMsgKind.

Referenced by DtAssistantNetworkCompViewMgr::DtAssistantNetworkCompViewMgr().

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

References DtRtiAssistantClient::addMsgCallback(), and DtAssistantAwaitingForwardersMsgKind.

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

Implements DtAssistantMsg.

References DtAssistantAwaitingForwardersMsg(), and netAssistantAwaitingForwardersMsg().

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

Creators.

static DtAssistantMsg* DtAssistantAwaitingForwardersMsg::create ( MAKRti::DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER) [static]
const DtNetU128 * DtAssistantAwaitingForwardersMsg::forwarderAddrsPtr ( ) const [protected, virtual]

Get the pointer to the forwarder addresses data.

References netAssistantAwaitingForwardersMsg().

Referenced by forwarderPortsPtr(), getForwarders(), and setForwarders().

DtNetU128 * DtAssistantAwaitingForwardersMsg::forwarderAddrsPtr ( ) [protected, virtual]
const DtNetU8 * DtAssistantAwaitingForwardersMsg::forwarderConnectedPtr ( ) const [protected]

Get the pointer to connection status data for the forwarders.

References forwarderNamesPtr(), and forwarderNamesSize().

Referenced by getForwarders(), and setForwarders().

const char * DtAssistantAwaitingForwardersMsg::forwarderNamesPtr ( ) const [protected, virtual]

Get the pointer to the forwarder names data.

References forwarderPortsPtr(), and numForwarders().

Referenced by forwarderConnectedPtr(), getForwarders(), and setForwarders().

char * DtAssistantAwaitingForwardersMsg::forwarderNamesPtr ( ) [protected, virtual]
unsigned int DtAssistantAwaitingForwardersMsg::forwarderNamesSize ( ) const [protected, virtual]

Get/Set the total size of all the forwarder names.

References DtNetAssistantAwaitingForwardersMsg::fwNamesSize, and netAssistantAwaitingForwardersMsg().

Referenced by forwarderConnectedPtr(), and setForwarders().

const DtNetU16 * DtAssistantAwaitingForwardersMsg::forwarderPortsPtr ( ) const [protected, virtual]

Get the pointer to the forwarder ports data.

References forwarderAddrsPtr(), and numForwarders().

Referenced by forwarderNamesPtr(), getForwarders(), and setForwarders().

DtNetU16 * DtAssistantAwaitingForwardersMsg::forwarderPortsPtr ( ) [protected, virtual]

Get whether the forwarder is waiting for forwarder-to-forwarder connections.

References DtNetAssistantAwaitingForwardersMsg::isWaiting, and netAssistantAwaitingForwardersMsg().

Referenced by printData(), and DtAssistantNetworkCompViewMgr::processAwaitingForwardersMsg().

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

Returns minimum size of a message, including header.

Referenced by DtAssistantAwaitingForwardersMsg().

Print the data section.

Reimplemented from DtAssistantMsg.

References isWaitingForForwarders(), and numForwarders().

void DtAssistantAwaitingForwardersMsg::setForwarderNamesSize ( unsigned int  size) [protected, 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)