MAK RTIspy API Documentation for HLA 1516
List of all members | 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:

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 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 version.
virtual int assistantCompId () const
 Get the assistant component ID.
virtual void setAssistantCompId (int compId)
 Set the connection ID.
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.
- 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, 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)
- 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
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 ()
- 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 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 
)
DtAssistantFederateStateMsg::~DtAssistantFederateStateMsg ( )
virtual

Destructor.

Member Function Documentation

void DtAssistantFederateStateMsg::addCallback ( DtRtiAssistantServer conn,
DtAssistantFederateStateCb  cb,
void *  usr 
)
static

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

References DtRtiAssistantServer::addMsgCallback(), and DtAssistantFederateStateMsgKind.

Referenced by DtAssistantFederationsInfoMgr::DtAssistantFederationsInfoMgr().

void DtAssistantFederateStateMsg::addCallback ( DtRtiAssistantPeer conn,
DtAssistantFederateStateCb  cb,
void *  usr 
)
static

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

References DtRtiAssistantPeer::addMsgCallback(), and DtAssistantFederateStateMsgKind.

int DtAssistantFederateStateMsg::assistantCompId ( ) const
virtual
DtAssistantMsg * DtAssistantFederateStateMsg::clone ( bool  copy = true) const
virtual

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
protectedvirtual

Return pointer to federate host name location in message.

References federateNamePtr(), and federateNameSize().

Referenced by federateHostName(), and setFederateHostName().

char * DtAssistantFederateStateMsg::federateHostNamePtr ( )
protectedvirtual
unsigned long DtAssistantFederateStateMsg::federateHostNameSize ( ) const
protectedvirtual
DtString DtAssistantFederateStateMsg::federateName ( ) const
virtual
const char * DtAssistantFederateStateMsg::federateNamePtr ( ) const
protectedvirtual

return pointer to federate name location in message

References federateTypePtr(), and federateTypeSize().

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

char * DtAssistantFederateStateMsg::federateNamePtr ( )
protectedvirtual
unsigned long DtAssistantFederateStateMsg::federateNameSize ( ) const
protectedvirtual
DtString DtAssistantFederateStateMsg::federateType ( ) const
virtual
const char * DtAssistantFederateStateMsg::federateTypePtr ( ) const
protectedvirtual

Return pointer to federate type location in message.

References federationNamePtr(), and federationNameSize().

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

char * DtAssistantFederateStateMsg::federateTypePtr ( )
protectedvirtual
unsigned long DtAssistantFederateStateMsg::federateTypeSize ( ) const
protectedvirtual
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
protectedvirtual

Return pointer to federation name location in message.

References netAssistantFederateStateMsg().

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

char * DtAssistantFederateStateMsg::federationNamePtr ( )
protectedvirtual
unsigned long DtAssistantFederateStateMsg::federationNameSize ( ) const
protectedvirtual
DtHlaVersionId DtAssistantFederateStateMsg::hlaVersion ( ) const
virtual
DtAssistantMsgKind DtAssistantFederateStateMsg::internalMsgKind ( )
protectedvirtual

Returns the kind of a DtAssistantFederateStateMsg message.

Implements DtAssistantMsg.

References DtAssistantFederateStateMsgKind.

Referenced by DtAssistantFederateStateMsg().

bool DtAssistantFederateStateMsg::isContinuousTest ( ) const
virtual

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

References DtNetAssistantFederateStateMsg::continuousTest, and netAssistantFederateStateMsg().

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

bool DtAssistantFederateStateMsg::isDisconnected ( ) const
virtual
bool DtAssistantFederateStateMsg::isReconnecting ( ) const
virtual

Get whether or not the federate is currently reconnecting.

References DtNetAssistantFederateStateMsg::isReconnecting, and netAssistantFederateStateMsg().

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

bool DtAssistantFederateStateMsg::isRemoval ( ) const
virtual

Get whether or not this federate is being removed.

References DtNetAssistantFederateStateMsg::isRemoval, and netAssistantFederateStateMsg().

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

bool DtAssistantFederateStateMsg::isTestEnabled ( ) const
virtual

Get whether or not the federate has network testing enabled.

References netAssistantFederateStateMsg(), and DtNetAssistantFederateStateMsg::testEnabled.

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

bool DtAssistantFederateStateMsg::isTestInProgress ( ) const
virtual

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
protectedvirtual

Returns minimum size of a message, including header.

Referenced by DtAssistantFederateStateMsg().

DtNetAssistantFederateStateMsg * DtAssistantFederateStateMsg::netAssistantFederateStateMsg ( )
protectedvirtual
const DtNetAssistantFederateStateMsg * DtAssistantFederateStateMsg::netAssistantFederateStateMsg ( ) const
protectedvirtual
unsigned int DtAssistantFederateStateMsg::numInitiatedTests ( ) const
virtual
unsigned int DtAssistantFederateStateMsg::numTestReports ( ) const
virtual
void DtAssistantFederateStateMsg::printData ( ) const
virtual
void DtAssistantFederateStateMsg::removeCallback ( DtRtiAssistantServer conn,
DtAssistantFederateStateCb  cb,
void *  usr 
)
static
void DtAssistantFederateStateMsg::removeCallback ( DtRtiAssistantPeer conn,
DtAssistantFederateStateCb  cb,
void *  usr 
)
static
void DtAssistantFederateStateMsg::setAssistantCompId ( int  compId)
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)
protectedvirtual

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)
protectedvirtual

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)
protectedvirtual

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)
protectedvirtual

Set/Get federation name size.

References DtNetAssistantFederateStateMsg::federationNameSize, and netAssistantFederateStateMsg().

Referenced by setFederationName().

void DtAssistantFederateStateMsg::setHlaVersion ( DtHlaVersionId  version)
virtual
void DtAssistantFederateStateMsg::setIsContinuousTest ( bool  continuous)
virtual

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().

void DtAssistantFederateStateMsg::setIsTestEnabled ( bool  enabled)
virtual

Set whether or not the federate has network testing enabled.

References netAssistantFederateStateMsg(), and DtNetAssistantFederateStateMsg::testEnabled.

Referenced by DtRtiAssistantExecClient::sendFederateUpdateMsg().

void DtAssistantFederateStateMsg::setIsTestInProgress ( bool  inProgress)
virtual

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().


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

Document ID: Generated on Fri Mar 14 19:08:55 EDT 2014 from SVN revision 137085
Copyright © 2005-2014 VT MÄK Inc. All Rights Reserved (www.mak.com)