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

The DtAssistantFederateStateMsg defines a wrapper for the RTI Assistant federate state message used by the rtiexec to inform the Assistant of the current state of a single federate. More...

+ Inheritance diagram for DtAssistantFederateStateMsg:
+ Collaboration diagram for DtAssistantFederateStateMsg:

List of all members.

Public Member Functions

 DtAssistantFederateStateMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructors.
 DtAssistantFederateStateMsg (const DtNetAssistantFederateStateMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual ~DtAssistantFederateStateMsg ()
 Destructor.
virtual DtAssistantMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this.
virtual unsigned long connectionId () const
 Get the connection ID.
virtual void setConnectionId (unsigned long connId)
 Set the connection ID.
virtual unsigned int federateHandle () const
 Get the federate handle.
virtual void setFederateHandle (unsigned int handle)
 Set the federate handle.
virtual MAKRti::DtInetAddr federateHostIp () const
 Get the federate host IP.
virtual void setFederateHostIp (const MAKRti::DtInetAddr &ip)
 Set the federate host IP.
virtual MAKRti::DtInetAddr webServerIp () const
 Get the federate's web server host IP.
virtual void setWebServerIp (const MAKRti::DtInetAddr &ip)
 Set the federate's web server host IP.
virtual unsigned int webServerPort () const
 Get the federate's web server port.
virtual void setWebServerPort (unsigned int port)
 Set the federate's web server port.
virtual bool isTestEnabled () const
 Get whether or not the federate has network testing enabled.
virtual void setIsTestEnabled (bool enabled)
 Set whether or not the federate has network testing enabled.
virtual bool isTestInProgress () const
 Get whether or not the federate has a network test in progress.
virtual void setIsTestInProgress (bool inProgress)
 Set whether or not the federate has a network test in progress.
virtual bool isContinuousTest () const
 Get whether or not the federate is configured to run a test continuously.
virtual void setIsContinuousTest (bool continuous)
 Set whether or not the federate is configured to run a test continuously.
virtual unsigned int numInitiatedTests () const
 Get the federate's number of initiated network test.
virtual void setNumInitiatedTests (unsigned int num)
 Set the federate's number of initiated network test.
virtual unsigned int numTestReports () const
 Get the federate's number of test reports generated.
virtual void setNumTestReports (unsigned int num)
 Set the federate's number of test reports generated.
virtual bool isReconnecting () const
 Get whether or not the federate is currently reconnecting.
virtual void setIsReconnecting (bool reconnecting)
 Set whether or not the federate is currently reconnecting.
virtual bool isDisconnected () const
 Get whether or not the federate has disconnected.
virtual void setIsDisconnected (bool disconnected)
 Set whether or not the federate has disconnected.
virtual bool isRemoval () const
 Get whether or not this federate is being removed.
virtual void setIsRemoval (bool remove)
 Set whether or not this federate is being removed.
virtual DtHlaVersionId hlaVersion () const
 Get the federate's HLA version.
virtual void setHlaVersion (DtHlaVersionId version)
 Set the federate's HLA verison.
virtual MAKRti::DtString federationName () const
 Get the federation name for this federate.
virtual void setFederationName (const MAKRti::DtString &name)
 Set the federation name for this federate.
virtual MAKRti::DtString federateType () const
 Get the federate's type.
virtual void setFederateType (const MAKRti::DtString &type)
 set the federate's type
virtual MAKRti::DtString federateName () const
 Get the federates name.
virtual void setFederateName (const MAKRti::DtString &name)
 Get the federates name.
virtual MAKRti::DtString federateHostName () const
 Get the name of the host the federate is on.
virtual void setFederateHostName (const MAKRti::DtString &name)
 Set the name of the host the federate is on.
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 (DtRtiAssistantServer *conn, DtAssistantFederateStateCb cb, void *usr)
 Adds or removes a callback with the given Assistant server for this message type.
static void removeCallback (DtRtiAssistantServer *conn, DtAssistantFederateStateCb cb, void *usr)
static void addCallback (DtRtiAssistantPeer *conn, DtAssistantFederateStateCb cb, void *usr)
 Adds or removes a callback with the given Assistant peer for this message type.
static void removeCallback (DtRtiAssistantPeer *conn, DtAssistantFederateStateCb cb, void *usr)

Protected Member Functions

virtual
DtNetAssistantFederateStateMsg
netAssistantFederateStateMsg ()
 The network representation for the message.
virtual const
DtNetAssistantFederateStateMsg
netAssistantFederateStateMsg () const
virtual DtAssistantMsgKind internalMsgKind ()
 Returns the kind of a DtAssistantFederateStateMsg message.
virtual int minSize () const
 Returns minimum size of a message, including header.
virtual void setFederationNameSize (unsigned long size)
 Set/Get federation name size.
virtual unsigned long federationNameSize () const
virtual const char * federationNamePtr () const
 Return pointer to federation name location in message.
virtual char * federationNamePtr ()
virtual void setFederateTypeSize (unsigned long size)
 Set/Get federate type size.
virtual unsigned long federateTypeSize () const
virtual const char * federateTypePtr () const
 Return pointer to federate type location in message.
virtual char * federateTypePtr ()
virtual void setFederateNameSize (unsigned long size)
 Set/Get federate name size.
virtual unsigned long federateNameSize () const
virtual const char * federateNamePtr () const
 return pointer to federate name location in message
virtual char * federateNamePtr ()
virtual void setFederateHostNameSize (unsigned long size)
 Set/Get federate host name size.
virtual unsigned long federateHostNameSize () const
virtual const char * federateHostNamePtr () const
 Return pointer to federate host name location in message.
virtual char * federateHostNamePtr ()

Detailed Description

The DtAssistantFederateStateMsg defines a wrapper for the RTI Assistant federate state message used by the rtiexec to inform the Assistant of the current state of a single federate.


Constructor & Destructor Documentation

DtAssistantFederateStateMsg::DtAssistantFederateStateMsg ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructors.

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

Referenced by clone(), and create().

DtAssistantFederateStateMsg::DtAssistantFederateStateMsg ( const DtNetAssistantFederateStateMsg 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 DtAssistantFederateStateMsgKind.

Referenced by DtAssistantFederationsInfoMgr::DtAssistantFederationsInfoMgr().

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

References DtRtiAssistantPeer::addMsgCallback(), and DtAssistantFederateStateMsgKind.

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

Implements DtAssistantMsg.

References DtAssistantFederateStateMsg(), and netAssistantFederateStateMsg().

unsigned long DtAssistantFederateStateMsg::connectionId ( ) const [virtual]
DtAssistantMsg * DtAssistantFederateStateMsg::create ( const DtNetAssistantMsgHeader initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
) [static]

Creators.

References DtAssistantFederateStateMsg().

DtAssistantMsg * DtAssistantFederateStateMsg::create ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER) [static]
unsigned int DtAssistantFederateStateMsg::federateHandle ( ) const [virtual]
DtInetAddr DtAssistantFederateStateMsg::federateHostIp ( ) const [virtual]
DtString DtAssistantFederateStateMsg::federateHostName ( ) const [virtual]

Get the name of the host the federate is on.

References federateHostNamePtr(), and federateHostNameSize().

Referenced by printData(), and DtAssistantFederationsInfoMgr::processFederateStateMsg().

const char * DtAssistantFederateStateMsg::federateHostNamePtr ( ) const [protected, virtual]

Return pointer to federate host name location in message.

References federateNamePtr(), and federateNameSize().

Referenced by federateHostName(), and setFederateHostName().

char * DtAssistantFederateStateMsg::federateHostNamePtr ( ) [protected, virtual]
unsigned long DtAssistantFederateStateMsg::federateHostNameSize ( ) const [protected, virtual]
DtString DtAssistantFederateStateMsg::federateName ( ) const [virtual]
const char * DtAssistantFederateStateMsg::federateNamePtr ( ) const [protected, virtual]

return pointer to federate name location in message

References federateTypePtr(), and federateTypeSize().

Referenced by federateHostNamePtr(), federateName(), and setFederateName().

char * DtAssistantFederateStateMsg::federateNamePtr ( ) [protected, virtual]
unsigned long DtAssistantFederateStateMsg::federateNameSize ( ) const [protected, virtual]
DtString DtAssistantFederateStateMsg::federateType ( ) const [virtual]
const char * DtAssistantFederateStateMsg::federateTypePtr ( ) const [protected, virtual]

Return pointer to federate type location in message.

References federationNamePtr(), and federationNameSize().

Referenced by federateNamePtr(), federateType(), and setFederateType().

char * DtAssistantFederateStateMsg::federateTypePtr ( ) [protected, virtual]
unsigned long DtAssistantFederateStateMsg::federateTypeSize ( ) const [protected, virtual]
DtString DtAssistantFederateStateMsg::federationName ( ) const [virtual]

Get the federation name for this federate.

References federationNamePtr(), and federationNameSize().

Referenced by printData(), and DtAssistantFederationsInfoMgr::processFederateStateMsg().

const char * DtAssistantFederateStateMsg::federationNamePtr ( ) const [protected, virtual]

Return pointer to federation name location in message.

References netAssistantFederateStateMsg().

Referenced by federateTypePtr(), federationName(), and setFederationName().

char * DtAssistantFederateStateMsg::federationNamePtr ( ) [protected, virtual]
unsigned long DtAssistantFederateStateMsg::federationNameSize ( ) const [protected, virtual]

Returns the kind of a DtAssistantFederateStateMsg message.

Implements DtAssistantMsg.

References DtAssistantFederateStateMsgKind.

Referenced by DtAssistantFederateStateMsg().

Get whether or not the federate is configured to run a test continuously.

References DtNetAssistantFederateStateMsg::continuousTest, and netAssistantFederateStateMsg().

Referenced by printData(), and DtAssistantFederationsInfoMgr::processFederateStateMsg().

Get whether or not the federate is currently reconnecting.

References DtNetAssistantFederateStateMsg::isReconnecting, and netAssistantFederateStateMsg().

Referenced by printData(), and DtAssistantFederationsInfoMgr::processFederateStateMsg().

Get whether or not this federate is being removed.

References DtNetAssistantFederateStateMsg::isRemoval, and netAssistantFederateStateMsg().

Referenced by printData(), and DtAssistantFederationsInfoMgr::processFederateStateMsg().

Get whether or not the federate has network testing enabled.

References netAssistantFederateStateMsg(), and DtNetAssistantFederateStateMsg::testEnabled.

Referenced by printData(), and DtAssistantFederationsInfoMgr::processFederateStateMsg().

Get whether or not the federate has a network test in progress.

References netAssistantFederateStateMsg(), and DtNetAssistantFederateStateMsg::testInProgress.

Referenced by printData(), and DtAssistantFederationsInfoMgr::processFederateStateMsg().

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

Returns minimum size of a message, including header.

Referenced by DtAssistantFederateStateMsg().

unsigned int DtAssistantFederateStateMsg::numInitiatedTests ( ) const [virtual]
unsigned int DtAssistantFederateStateMsg::numTestReports ( ) const [virtual]
void DtAssistantFederateStateMsg::printData ( ) const [virtual]
void DtAssistantFederateStateMsg::setConnectionId ( unsigned long  connId) [virtual]
void DtAssistantFederateStateMsg::setFederateHandle ( unsigned int  handle) [virtual]
void DtAssistantFederateStateMsg::setFederateHostIp ( const MAKRti::DtInetAddr &  ip) [virtual]
void DtAssistantFederateStateMsg::setFederateHostName ( const MAKRti::DtString &  name) [virtual]
void DtAssistantFederateStateMsg::setFederateHostNameSize ( unsigned long  size) [protected, virtual]

Set/Get federate host name size.

References DtNetAssistantFederateStateMsg::federateHostNameSize, and netAssistantFederateStateMsg().

Referenced by setFederateHostName().

void DtAssistantFederateStateMsg::setFederateName ( const MAKRti::DtString &  name) [virtual]
void DtAssistantFederateStateMsg::setFederateNameSize ( unsigned long  size) [protected, virtual]

Set/Get federate name size.

References DtNetAssistantFederateStateMsg::federateNameSize, and netAssistantFederateStateMsg().

Referenced by setFederateName().

void DtAssistantFederateStateMsg::setFederateType ( const MAKRti::DtString &  type) [virtual]
void DtAssistantFederateStateMsg::setFederateTypeSize ( unsigned long  size) [protected, virtual]

Set/Get federate type size.

References DtNetAssistantFederateStateMsg::federateTypeSize, and netAssistantFederateStateMsg().

Referenced by setFederateType().

void DtAssistantFederateStateMsg::setFederationName ( const MAKRti::DtString &  name) [virtual]
void DtAssistantFederateStateMsg::setFederationNameSize ( unsigned long  size) [protected, virtual]

Set/Get federation name size.

References DtNetAssistantFederateStateMsg::federationNameSize, and netAssistantFederateStateMsg().

Referenced by setFederationName().

Set whether or not the federate is configured to run a test continuously.

References DtNetAssistantFederateStateMsg::continuousTest, and netAssistantFederateStateMsg().

Referenced by DtRtiAssistantExecClient::sendFederateUpdateMsg().

void DtAssistantFederateStateMsg::setIsDisconnected ( bool  disconnected) [virtual]

Set whether or not the federate has disconnected.

References DtNetAssistantFederateStateMsg::isDisconnected, and netAssistantFederateStateMsg().

Referenced by DtRtiAssistantExecClient::sendFederateUpdateMsg().

void DtAssistantFederateStateMsg::setIsReconnecting ( bool  reconnecting) [virtual]

Set whether or not the federate is currently reconnecting.

References DtNetAssistantFederateStateMsg::isReconnecting, and netAssistantFederateStateMsg().

Referenced by DtRtiAssistantExecClient::sendFederateUpdateMsg().

void DtAssistantFederateStateMsg::setIsRemoval ( bool  remove) [virtual]

Set whether or not this federate is being removed.

References DtNetAssistantFederateStateMsg::isRemoval, and netAssistantFederateStateMsg().

Referenced by DtRtiAssistantExecClient::sendFederateUpdateMsg().

Set whether or not the federate has network testing enabled.

References netAssistantFederateStateMsg(), and DtNetAssistantFederateStateMsg::testEnabled.

Referenced by DtRtiAssistantExecClient::sendFederateUpdateMsg().

Set whether or not the federate has a network test in progress.

References netAssistantFederateStateMsg(), and DtNetAssistantFederateStateMsg::testInProgress.

Referenced by DtRtiAssistantExecClient::sendFederateUpdateMsg().

void DtAssistantFederateStateMsg::setNumInitiatedTests ( unsigned int  num) [virtual]

Set the federate's number of initiated network test.

References netAssistantFederateStateMsg(), and DtNetAssistantFederateStateMsg::numInitiatedTests.

Referenced by DtRtiAssistantExecClient::sendFederateUpdateMsg().

void DtAssistantFederateStateMsg::setNumTestReports ( unsigned int  num) [virtual]

Set the federate's number of test reports generated.

References netAssistantFederateStateMsg(), and DtNetAssistantFederateStateMsg::numTestReports.

Referenced by DtRtiAssistantExecClient::sendFederateUpdateMsg().

void DtAssistantFederateStateMsg::setWebServerIp ( const MAKRti::DtInetAddr &  ip) [virtual]
void DtAssistantFederateStateMsg::setWebServerPort ( unsigned int  port) [virtual]
DtInetAddr DtAssistantFederateStateMsg::webServerIp ( ) const [virtual]

Get the federate's web server host IP.

References netAssistantFederateStateMsg().

Referenced by printData(), and DtAssistantFederationsInfoMgr::processFederateStateMsg().

unsigned int DtAssistantFederateStateMsg::webServerPort ( ) 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)