MAK RTIspy API Documentation for HLA Evolved
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions
DtAssistantRtiexecCompInfoMsg Class Reference

The DtAssistantRtiexecCompInfoMsg defines a wrapper for the RTI Assistant component information message used to send information about an rtiexec component to its connected RTI Assistant. More...

+ Inheritance diagram for DtAssistantRtiexecCompInfoMsg:
+ Collaboration diagram for DtAssistantRtiexecCompInfoMsg:

Public Member Functions

 DtAssistantRtiexecCompInfoMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructors.
 DtAssistantRtiexecCompInfoMsg (const DtNetAssistantRtiexecCompInfoMsg *netRep, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual ~DtAssistantRtiexecCompInfoMsg ()
 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 forwarder IP address.
virtual MAKRti::DtInetAddr reliableIpAddress () const
 Get rtiexec's reliable forwarder 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 setNetworkIfAddress (const MAKRti::DtInetAddr &ipAddr)
 Set rtiexec's network interface IP address.
virtual MAKRti::DtInetAddr networkIfAddress () const
 Get rtiexec's network interface IP address.
virtual void setUdpPort (int port)
 Set rtiexec's forwarder UDP port number.
virtual int udpPort () const
 Get rtiexec's forwarder UDP port number.
virtual void setTcpPort (int port)
 Set rtiexec's forwarder TCP port number.
virtual int tcpPort () const
 Get rtiexec's forwarder TCP port number.
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 setIsConnected (bool connected)
 Set whether or not the rtiexec has successfully connected to a forwarder.
virtual bool isConnected () const
 Get whether the rtiexec has successfully connected to a forwarder.
virtual void setHostName (const MAKRti::DtString &name)
 Set rtiexec host name.
virtual MAKRti::DtString hostName () const
 Get rtiexec host name.
virtual void setLogFilename (const MAKRti::DtFilename &filename)
 Set component log filename.
virtual MAKRti::DtFilename logFilename () const
 Get component log filename.
virtual void setNotifyLevel (DtNotifyLevelType level)
 Set notify level.
virtual DtNotifyLevelType notifyLevel () const
 Get notify level.
virtual void setLicServer (const MAKRti::DtString &server)
 Set the license server used by the rtiexec.
virtual MAKRti::DtString licServer () const
 Get rtiexec license server.
virtual int forwarderPort () const
 Get the forwarder port.
virtual void setForwarderPort (int forwarderPortToUse)
 Set the forwarder port.
virtual MAKRti::DtInetAddr additionalForwarderConnection () const
 Get the optional additional forwarder to connect to.
virtual void setAdditionalForwarderConnection (const MAKRti::DtInetAddr &addr)
 Set the optional additional forwarder to connect to.
virtual void printData () const
 Print the data section.
- Public Member Functions inherited from DtAssistantMsg
virtual ~DtAssistantMsg ()
 Destructor.
virtual DtNetAssistantMsgHeadernetHeader () 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 DtAssistantMsgcreate (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Creators.
static DtAssistantMsgcreate (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void addCallback (DtRtiAssistantServer *conn, DtAssistantRtiexecCompInfoCb cb, void *usr)
 Adds or removes a callback with the given Assistant server for this message type.
static void removeCallback (DtRtiAssistantServer *conn, DtAssistantRtiexecCompInfoCb 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 void setAddressFamily (MAKRti::DtInetUtils::DtInetAddrFamily fam)
 Set the IP address family.
virtual
MAKRti::DtInetUtils::DtInetAddrFamily 
addressFamily () const
 Get the IP address family.
virtual
DtNetAssistantRtiexecCompInfoMsg
netAssistantRtiexecCompInfoMsg ()
 The network representation for the rtiexec component information.
virtual const
DtNetAssistantRtiexecCompInfoMsg
netAssistantRtiexecCompInfoMsg () const
virtual DtAssistantMsgKind internalMsgKind ()
 Returns the kind of a DtAssistantRtiexecCompInfoMsg message.
virtual int minSize () const
 Returns minimum size of a message, including header.
virtual void setHostNameSize (unsigned long size)
 Set/Get rtiexec host name size.
virtual unsigned long hostNameSize () const
virtual const char * hostNamePtr () const
 Return pointer to rtiexec host name location in message.
virtual char * hostNamePtr ()
virtual void setLogFilenameSize (unsigned long size)
 Set/Get log filename size.
virtual unsigned long logFilenameSize () const
virtual const char * logFilenamePtr () const
 Return pointer to component name location in message.
virtual char * logFilenamePtr ()
virtual void setLicServerSize (unsigned long size)
 Set/Get license server size.
virtual unsigned long licServerSize () const
virtual const char * licServerPtr () const
 Return pointer to license server location in message.
virtual char * licServerPtr ()
- 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 DtNetAssistantSrcDestInfosrcDestInfoPtr ()
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 ()

Detailed Description

The DtAssistantRtiexecCompInfoMsg defines a wrapper for the RTI Assistant component information message used to send information about an rtiexec component to its connected RTI Assistant.

Constructor & Destructor Documentation

DtAssistantRtiexecCompInfoMsg::DtAssistantRtiexecCompInfoMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructors.

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

Referenced by clone(), and create().

DtAssistantRtiexecCompInfoMsg::DtAssistantRtiexecCompInfoMsg ( const DtNetAssistantRtiexecCompInfoMsg netRep,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
DtAssistantRtiexecCompInfoMsg::~DtAssistantRtiexecCompInfoMsg ( )
virtual

Destructor.

Member Function Documentation

void DtAssistantRtiexecCompInfoMsg::addCallback ( DtRtiAssistantServer conn,
DtAssistantRtiexecCompInfoCb  cb,
void *  usr 
)
static

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

References DtRtiAssistantServer::addMsgCallback(), and DtAssistantRtiexecCompInfoMsgKind.

Referenced by DtAssistantComponentMgr::DtAssistantComponentMgr().

DtInetAddr DtAssistantRtiexecCompInfoMsg::additionalForwarderConnection ( ) const
virtual

Get the optional additional forwarder to connect to.

References addressFamily(), and netAssistantRtiexecCompInfoMsg().

DtInetUtils::DtInetAddrFamily DtAssistantRtiexecCompInfoMsg::addressFamily ( ) const
protectedvirtual
DtInetAddr DtAssistantRtiexecCompInfoMsg::bestEffortIpAddress ( ) const
virtual

Get rtiexec's best effort IP address.

References addressFamily(), and netAssistantRtiexecCompInfoMsg().

Referenced by printData(), and DtAssistantComponentMgr::processRtiexecCompInfoMsg().

DtAssistantMsg * DtAssistantRtiexecCompInfoMsg::clone ( bool  copy = true) const
virtual

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

Implements DtAssistantMsg.

References DtAssistantRtiexecCompInfoMsg(), and netAssistantRtiexecCompInfoMsg().

DtAssistantMsg * DtAssistantRtiexecCompInfoMsg::create ( const DtNetAssistantMsgHeader initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)
static

Creators.

References DtAssistantRtiexecCompInfoMsg().

DtAssistantMsg * DtAssistantRtiexecCompInfoMsg::create ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)
static
int DtAssistantRtiexecCompInfoMsg::forwarderPort ( ) const
virtual
bool DtAssistantRtiexecCompInfoMsg::fullCompliance ( ) const
virtual

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

References DtNetAssistantRtiexecCompInfoMsg::fullCompliance, and netAssistantRtiexecCompInfoMsg().

Referenced by printData(), and DtAssistantComponentMgr::processRtiexecCompInfoMsg().

DtString DtAssistantRtiexecCompInfoMsg::hostName ( ) const
virtual

Get rtiexec host name.

References hostNamePtr(), and hostNameSize().

Referenced by printData(), and DtAssistantComponentMgr::processRtiexecCompInfoMsg().

const char * DtAssistantRtiexecCompInfoMsg::hostNamePtr ( ) const
protectedvirtual

Return pointer to rtiexec host name location in message.

References netAssistantRtiexecCompInfoMsg().

Referenced by hostName(), logFilenamePtr(), and setHostName().

char * DtAssistantRtiexecCompInfoMsg::hostNamePtr ( )
protectedvirtual
unsigned long DtAssistantRtiexecCompInfoMsg::hostNameSize ( ) const
protectedvirtual
DtAssistantMsgKind DtAssistantRtiexecCompInfoMsg::internalMsgKind ( )
protectedvirtual

Returns the kind of a DtAssistantRtiexecCompInfoMsg message.

Implements DtAssistantMsg.

References DtAssistantRtiexecCompInfoMsgKind.

Referenced by DtAssistantRtiexecCompInfoMsg().

bool DtAssistantRtiexecCompInfoMsg::isConnected ( ) const
virtual

Get whether the rtiexec has successfully connected to a forwarder.

References DtNetAssistantRtiexecCompInfoMsg::isConnected, and netAssistantRtiexecCompInfoMsg().

Referenced by printData(), and DtAssistantComponentMgr::processRtiexecCompInfoMsg().

DtString DtAssistantRtiexecCompInfoMsg::licServer ( ) const
virtual

Get rtiexec license server.

References licServerPtr(), and licServerSize().

Referenced by printData(), and DtAssistantComponentMgr::processRtiexecCompInfoMsg().

const char * DtAssistantRtiexecCompInfoMsg::licServerPtr ( ) const
protectedvirtual

Return pointer to license server location in message.

References logFilenamePtr(), and logFilenameSize().

Referenced by licServer(), and setLicServer().

char * DtAssistantRtiexecCompInfoMsg::licServerPtr ( )
protectedvirtual
unsigned long DtAssistantRtiexecCompInfoMsg::licServerSize ( ) const
protectedvirtual
DtFilename DtAssistantRtiexecCompInfoMsg::logFilename ( ) const
virtual

Get component log filename.

References logFilenamePtr(), and logFilenameSize().

Referenced by printData(), and DtAssistantComponentMgr::processRtiexecCompInfoMsg().

const char * DtAssistantRtiexecCompInfoMsg::logFilenamePtr ( ) const
protectedvirtual

Return pointer to component name location in message.

References hostNamePtr(), and hostNameSize().

Referenced by licServerPtr(), logFilename(), and setLogFilename().

char * DtAssistantRtiexecCompInfoMsg::logFilenamePtr ( )
protectedvirtual

References hostNamePtr(), and hostNameSize().

unsigned long DtAssistantRtiexecCompInfoMsg::logFilenameSize ( ) const
protectedvirtual
int DtAssistantRtiexecCompInfoMsg::minSize ( ) const
protectedvirtual

Returns minimum size of a message, including header.

Referenced by DtAssistantRtiexecCompInfoMsg().

DtNetAssistantRtiexecCompInfoMsg * DtAssistantRtiexecCompInfoMsg::netAssistantRtiexecCompInfoMsg ( )
protectedvirtual
const DtNetAssistantRtiexecCompInfoMsg * DtAssistantRtiexecCompInfoMsg::netAssistantRtiexecCompInfoMsg ( ) const
protectedvirtual
DtInetAddr DtAssistantRtiexecCompInfoMsg::networkIfAddress ( ) const
virtual

Get rtiexec's network interface IP address.

References addressFamily(), and netAssistantRtiexecCompInfoMsg().

Referenced by DtAssistantComponentMgr::processRtiexecCompInfoMsg().

DtNotifyLevelType DtAssistantRtiexecCompInfoMsg::notifyLevel ( ) const
virtual
void DtAssistantRtiexecCompInfoMsg::printData ( ) const
virtual
DtInetAddr DtAssistantRtiexecCompInfoMsg::reliableIpAddress ( ) const
virtual

Get rtiexec's reliable forwarder IP address.

References addressFamily(), and netAssistantRtiexecCompInfoMsg().

Referenced by printData(), and DtAssistantComponentMgr::processRtiexecCompInfoMsg().

void DtAssistantRtiexecCompInfoMsg::removeCallback ( DtRtiAssistantServer conn,
DtAssistantRtiexecCompInfoCb  cb,
void *  usr 
)
static
void DtAssistantRtiexecCompInfoMsg::setAdditionalForwarderConnection ( const MAKRti::DtInetAddr &  addr)
virtual
void DtAssistantRtiexecCompInfoMsg::setAddressFamily ( MAKRti::DtInetUtils::DtInetAddrFamily  fam)
protectedvirtual
void DtAssistantRtiexecCompInfoMsg::setBestEffortIpAddress ( const MAKRti::DtInetAddr &  ipAddr)
virtual
void DtAssistantRtiexecCompInfoMsg::setForwarderPort ( int  forwarderPortToUse)
virtual
void DtAssistantRtiexecCompInfoMsg::setFullCompliance ( bool  val)
virtual

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

References DtNetAssistantRtiexecCompInfoMsg::fullCompliance, and netAssistantRtiexecCompInfoMsg().

Referenced by DtRtiAssistantExecClient::sendClientInfo().

void DtAssistantRtiexecCompInfoMsg::setHostName ( const MAKRti::DtString &  name)
virtual
void DtAssistantRtiexecCompInfoMsg::setHostNameSize ( unsigned long  size)
protectedvirtual

Set/Get rtiexec host name size.

References DtNetAssistantRtiexecCompInfoMsg::hostNameSize, and netAssistantRtiexecCompInfoMsg().

Referenced by setHostName().

void DtAssistantRtiexecCompInfoMsg::setIsConnected ( bool  connected)
virtual

Set whether or not the rtiexec has successfully connected to a forwarder.

References DtNetAssistantRtiexecCompInfoMsg::isConnected, and netAssistantRtiexecCompInfoMsg().

Referenced by DtRtiAssistantExecClient::sendClientInfo().

void DtAssistantRtiexecCompInfoMsg::setLicServer ( const MAKRti::DtString &  server)
virtual

Set the license server used by the rtiexec.

References rti1516e::insertBytes(), licServerPtr(), licServerSize(), and setLicServerSize().

Referenced by DtRtiAssistantExecClient::sendClientInfo().

void DtAssistantRtiexecCompInfoMsg::setLicServerSize ( unsigned long  size)
protectedvirtual

Set/Get license server size.

References DtNetAssistantRtiexecCompInfoMsg::licServerSize, and netAssistantRtiexecCompInfoMsg().

Referenced by setLicServer().

void DtAssistantRtiexecCompInfoMsg::setLogFilename ( const MAKRti::DtFilename &  filename)
virtual
void DtAssistantRtiexecCompInfoMsg::setLogFilenameSize ( unsigned long  size)
protectedvirtual
void DtAssistantRtiexecCompInfoMsg::setNetworkIfAddress ( const MAKRti::DtInetAddr &  ipAddr)
virtual
void DtAssistantRtiexecCompInfoMsg::setNotifyLevel ( DtNotifyLevelType  level)
virtual
void DtAssistantRtiexecCompInfoMsg::setReliableIpAddress ( const MAKRti::DtInetAddr &  ipAddr)
virtual
void DtAssistantRtiexecCompInfoMsg::setTcpPort ( int  port)
virtual

Set rtiexec's forwarder TCP port number.

References netAssistantRtiexecCompInfoMsg(), and DtNetAssistantRtiexecCompInfoMsg::tcpPort.

Referenced by DtRtiAssistantExecClient::sendClientInfo().

void DtAssistantRtiexecCompInfoMsg::setUdpPort ( int  port)
virtual

Set rtiexec's forwarder UDP port number.

References netAssistantRtiexecCompInfoMsg(), and DtNetAssistantRtiexecCompInfoMsg::udpPort.

Referenced by DtRtiAssistantExecClient::sendClientInfo().

int DtAssistantRtiexecCompInfoMsg::tcpPort ( ) const
virtual
int DtAssistantRtiexecCompInfoMsg::udpPort ( ) const
virtual

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

Document ID: Generated on Wed Mar 11 20:26:49 EDT 2015 from SVN revision 150939
Copyright © 2005-2015 VT MÄK Inc. All Rights Reserved (www.mak.com)