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

The DtAssistantStartRtiexecMsg defines a wrapper for the RTI Assistant message used to instruct another Assistant to start a new rtiexec. More...

+ Inheritance diagram for DtAssistantStartRtiexecMsg:
+ Collaboration diagram for DtAssistantStartRtiexecMsg:

List of all members.

Public Member Functions

 DtAssistantStartRtiexecMsg (MAKRti::DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructors.
 DtAssistantStartRtiexecMsg (const DtNetAssistantStartRtiexecMsg *netRep, MAKRti::DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual ~DtAssistantStartRtiexecMsg ()
 Destructor.
virtual DtAssistantMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this.
virtual void setReliableIpAddress (const MAKRti::DtInetAddr &ipAddr)
 Set rtiexec's reliable IP address.
virtual MAKRti::DtInetAddr reliableIpAddress () const
 Get rtiexec's reliable IP address.
virtual void setBestEffortIpAddress (const MAKRti::DtInetAddr &ipAddr)
 Set rtiexec's best effort IP address.
virtual MAKRti::DtInetAddr bestEffortIpAddress () const
 Get rtiexec's best effort IP address.
virtual void setUdpPort (int port)
 Set rtiexec's UDP port number.
virtual int udpPort () const
 Get rtiexec's UDP port number.
virtual void setTcpPort (int port)
 Set rtiexec's TCP port number.
virtual int tcpPort () const
 Get rtiexec's TCP port number.
virtual void setForwarderPort (int port)
 Set the forwarder port.
virtual int forwarderPort () const
 Get the forwarder port.
virtual void setForwarderToConnectTo (const MAKRti::DtInetAddr &ipAddr)
 Set another forwarder for the forwarder to connect to.
virtual MAKRti::DtInetAddr forwarderToConnectTo () const
 Get the other forwarder for the forwarder to connect to.
virtual void setFullCompliance (bool val)
 Set the flag indicating if rtiexec is running with full compliance.
virtual bool fullCompliance () const
 Get the flag indicating if rtiexec is running with full compliance.
virtual void setConnectionName (const MAKRti::DtString &name)
 Set the connection name.
virtual MAKRti::DtString connectionName () const
 Get the connection name.
virtual void printData () const
 Print the data section.

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 (DtRtiAssistantPeer *conn, DtAssistantStartRtiexecCb cb, void *usr)
 Adds or removes a callback with the given Assistant server for this message type.
static void removeCallback (DtRtiAssistantPeer *conn, DtAssistantStartRtiexecCb cb, void *usr)

Protected Member Functions

virtual void setAddressFamily (MAKRti::DtInetUtils::DtInetAddrFamily fam)
 Set the IP address family.
virtual
MAKRti::DtInetUtils::DtInetAddrFamily 
addressFamily () const
 Get the IP address family.
virtual
DtNetAssistantStartRtiexecMsg
netAssistantStartRtiexecMsg ()
 The network representation for the start rtiexec message.
virtual const
DtNetAssistantStartRtiexecMsg
netAssistantStartRtiexecMsg () const
virtual DtAssistantMsgKind internalMsgKind ()
 Returns the kind of a DtAssistantStartRtiexecMsg message.
virtual int minSize () const
 Returns minimum size of a message, including header.
virtual void setConnectionNameSize (unsigned size)
 Set connection name size.
virtual unsigned connectionNameSize () const
 Get connection name size.
virtual const char * connectionNamePtr () const
 Return pointer to connection name location in message.
virtual char * connectionNamePtr ()

Detailed Description

The DtAssistantStartRtiexecMsg defines a wrapper for the RTI Assistant message used to instruct another Assistant to start a new rtiexec.


Constructor & Destructor Documentation

DtAssistantStartRtiexecMsg::DtAssistantStartRtiexecMsg ( MAKRti::DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructors.

Referenced by clone().

DtAssistantStartRtiexecMsg::DtAssistantStartRtiexecMsg ( const DtNetAssistantStartRtiexecMsg netRep,
MAKRti::DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

Destructor.


Member Function Documentation

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

References DtRtiAssistantPeer::addMsgCallback(), and DtAssistantStartRtiexecMsgKind.

Referenced by DtAssistantConnectionInfoMgr::DtAssistantConnectionInfoMgr().

DtInetUtils::DtInetAddrFamily DtAssistantStartRtiexecMsg::addressFamily ( ) const [protected, virtual]

Get the IP address family.

References netAssistantStartRtiexecMsg().

Referenced by bestEffortIpAddress(), forwarderToConnectTo(), and reliableIpAddress().

DtInetAddr DtAssistantStartRtiexecMsg::bestEffortIpAddress ( ) const [virtual]

Get rtiexec's best effort IP address.

References addressFamily(), and netAssistantStartRtiexecMsg().

Referenced by printData(), and DtAssistantConnectionInfoMgr::processStartRtiexecMsg().

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

Implements DtAssistantMsg.

References DtAssistantStartRtiexecMsg(), and netAssistantStartRtiexecMsg().

DtString DtAssistantStartRtiexecMsg::connectionName ( ) const [virtual]
const char * DtAssistantStartRtiexecMsg::connectionNamePtr ( ) const [protected, virtual]

Return pointer to connection name location in message.

References netAssistantStartRtiexecMsg().

Referenced by connectionName(), and setConnectionName().

char * DtAssistantStartRtiexecMsg::connectionNamePtr ( ) [protected, virtual]
unsigned DtAssistantStartRtiexecMsg::connectionNameSize ( ) const [protected, virtual]
static DtAssistantMsg* DtAssistantStartRtiexecMsg::create ( const DtNetAssistantMsgHeader initial,
MAKRti::DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
) [static]

Creators.

static DtAssistantMsg* DtAssistantStartRtiexecMsg::create ( MAKRti::DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER) [static]
DtInetAddr DtAssistantStartRtiexecMsg::forwarderToConnectTo ( ) const [virtual]

Get the other forwarder for the forwarder to connect to.

References addressFamily(), and netAssistantStartRtiexecMsg().

Referenced by DtAssistantConnectionInfoMgr::processStartRtiexecMsg().

Get the flag indicating if rtiexec is running with full compliance.

References DtNetAssistantStartRtiexecMsg::fullCompliance, and netAssistantStartRtiexecMsg().

Referenced by printData(), and DtAssistantConnectionInfoMgr::processStartRtiexecMsg().

Returns the kind of a DtAssistantStartRtiexecMsg message.

Implements DtAssistantMsg.

References DtAssistantStartRtiexecMsgKind.

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

Returns minimum size of a message, including header.

void DtAssistantStartRtiexecMsg::printData ( ) const [virtual]

Print the data section.

Reimplemented from DtAssistantMsg.

References bestEffortIpAddress(), fullCompliance(), reliableIpAddress(), tcpPort(), and udpPort().

DtInetAddr DtAssistantStartRtiexecMsg::reliableIpAddress ( ) const [virtual]
void DtAssistantStartRtiexecMsg::setAddressFamily ( MAKRti::DtInetUtils::DtInetAddrFamily  fam) [protected, virtual]
void DtAssistantStartRtiexecMsg::setBestEffortIpAddress ( const MAKRti::DtInetAddr &  ipAddr) [virtual]
void DtAssistantStartRtiexecMsg::setConnectionName ( const MAKRti::DtString &  name) [virtual]
void DtAssistantStartRtiexecMsg::setConnectionNameSize ( unsigned  size) [protected, virtual]
void DtAssistantStartRtiexecMsg::setForwarderPort ( int  port) [virtual]
void DtAssistantStartRtiexecMsg::setForwarderToConnectTo ( const MAKRti::DtInetAddr &  ipAddr) [virtual]

Set another forwarder for the forwarder to connect to.

References DtNetAssistantStartRtiexecMsg::forwarderAddressToConnectTo, and netAssistantStartRtiexecMsg().

Referenced by DtRtiAssistantPeer::sendStartRtiexecMsg().

Set the flag indicating if rtiexec is running with full compliance.

References DtNetAssistantStartRtiexecMsg::fullCompliance, and netAssistantStartRtiexecMsg().

Referenced by DtRtiAssistantPeer::sendStartRtiexecMsg().

void DtAssistantStartRtiexecMsg::setReliableIpAddress ( const MAKRti::DtInetAddr &  ipAddr) [virtual]
void DtAssistantStartRtiexecMsg::setTcpPort ( int  port) [virtual]
void DtAssistantStartRtiexecMsg::setUdpPort ( int  port) [virtual]
int DtAssistantStartRtiexecMsg::tcpPort ( ) const [virtual]
int DtAssistantStartRtiexecMsg::udpPort ( ) const [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)