![]() |
MAK RTIspy API Documentation for HLA 1.3
|
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 DtAssistantMsg * | clone (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 DtNetAssistantMsgHeader * | netHeader () 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 DtAssistantMsg * | create (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) |
| Creators. | |
| static DtAssistantMsg * | create (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 DtNetAssistantSrcDestInfo * | srcDestInfoPtr () |
| 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 () |
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.
| DtAssistantFederateStateMsg::DtAssistantFederateStateMsg | ( | DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER | ) |
Constructors.
References DtAssistantMsg::initAssistantMsg(), internalMsgKind(), and minSize().
| DtAssistantFederateStateMsg::DtAssistantFederateStateMsg | ( | const DtNetAssistantFederateStateMsg * | netRepMsg, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) |
References DtNetAssistantFederateStateMsg::header, and DtAssistantMsg::initAssistantMsg().
|
virtual |
Destructor.
|
static |
Adds or removes a callback with the given Assistant server for this message type.
References DtRtiAssistantServer::addMsgCallback(), and DtAssistantFederateStateMsgKind.
Referenced by DtAssistantFederationsInfoMgr::DtAssistantFederationsInfoMgr().
|
static |
Adds or removes a callback with the given Assistant peer for this message type.
References DtRtiAssistantPeer::addMsgCallback(), and DtAssistantFederateStateMsgKind.
|
virtual |
Get the assistant component ID.
References DtNetAssistantFederateStateMsg::astntCompId, and netAssistantFederateStateMsg().
Referenced by DtAssistantFederationsInfoMgr::processFederateStateMsg().
|
virtual |
Return a copy/empty object of the same type as this.
Implements DtAssistantMsg.
References DtAssistantFederateStateMsg(), and netAssistantFederateStateMsg().
|
virtual |
Get the connection ID.
References DtNetAssistantFederateStateMsg::connId, and netAssistantFederateStateMsg().
Referenced by printData(), and DtAssistantFederationsInfoMgr::processFederateStateMsg().
|
static |
Creators.
References DtAssistantFederateStateMsg().
|
static |
References DtAssistantFederateStateMsg().
|
virtual |
Get the federate handle.
References DtNetAssistantFederateStateMsg::federateHandle, and netAssistantFederateStateMsg().
Referenced by printData(), and DtAssistantFederationsInfoMgr::processFederateStateMsg().
|
virtual |
Get the federate host IP.
References netAssistantFederateStateMsg().
Referenced by printData(), and DtAssistantFederationsInfoMgr::processFederateStateMsg().
|
virtual |
Get the name of the host the federate is on.
References federateHostNamePtr(), and federateHostNameSize().
Referenced by printData(), and DtAssistantFederationsInfoMgr::processFederateStateMsg().
|
protectedvirtual |
Return pointer to federate host name location in message.
References federateNamePtr(), and federateNameSize().
Referenced by federateHostName(), and setFederateHostName().
|
protectedvirtual |
References federateNamePtr(), and federateNameSize().
|
protectedvirtual |
References DtNetAssistantFederateStateMsg::federateHostNameSize, and netAssistantFederateStateMsg().
Referenced by federateHostName(), and setFederateHostName().
|
virtual |
Get the federates name.
References federateNamePtr(), and federateNameSize().
Referenced by printData(), and DtAssistantFederationsInfoMgr::processFederateStateMsg().
|
protectedvirtual |
return pointer to federate name location in message
References federateTypePtr(), and federateTypeSize().
Referenced by federateHostNamePtr(), federateName(), and setFederateName().
|
protectedvirtual |
References federateTypePtr(), and federateTypeSize().
|
protectedvirtual |
References DtNetAssistantFederateStateMsg::federateNameSize, and netAssistantFederateStateMsg().
Referenced by federateHostNamePtr(), federateName(), and setFederateName().
|
virtual |
Get the federate's type.
References federateTypePtr(), and federateTypeSize().
Referenced by printData(), and DtAssistantFederationsInfoMgr::processFederateStateMsg().
|
protectedvirtual |
Return pointer to federate type location in message.
References federationNamePtr(), and federationNameSize().
Referenced by federateNamePtr(), federateType(), and setFederateType().
|
protectedvirtual |
References federationNamePtr(), and federationNameSize().
|
protectedvirtual |
References DtNetAssistantFederateStateMsg::federateTypeSize, and netAssistantFederateStateMsg().
Referenced by federateNamePtr(), federateType(), and setFederateType().
|
virtual |
Get the federation name for this federate.
References federationNamePtr(), and federationNameSize().
Referenced by printData(), and DtAssistantFederationsInfoMgr::processFederateStateMsg().
|
protectedvirtual |
Return pointer to federation name location in message.
References netAssistantFederateStateMsg().
Referenced by federateTypePtr(), federationName(), and setFederationName().
|
protectedvirtual |
References netAssistantFederateStateMsg().
|
protectedvirtual |
References DtNetAssistantFederateStateMsg::federationNameSize, and netAssistantFederateStateMsg().
Referenced by federateTypePtr(), federationName(), and setFederationName().
|
virtual |
Get the federate's HLA version.
References DtNetAssistantFederateStateMsg::hlaVersion, and netAssistantFederateStateMsg().
Referenced by DtAssistantFederationsInfoMgr::processFederateStateMsg().
|
protectedvirtual |
Returns the kind of a DtAssistantFederateStateMsg message.
Implements DtAssistantMsg.
References DtAssistantFederateStateMsgKind.
Referenced by DtAssistantFederateStateMsg().
|
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().
|
virtual |
Get whether or not the federate has disconnected.
References DtNetAssistantFederateStateMsg::isDisconnected, and netAssistantFederateStateMsg().
Referenced by printData(), and DtAssistantFederationsInfoMgr::processFederateStateMsg().
|
virtual |
Get whether or not the federate is currently reconnecting.
References DtNetAssistantFederateStateMsg::isReconnecting, and netAssistantFederateStateMsg().
Referenced by printData(), and DtAssistantFederationsInfoMgr::processFederateStateMsg().
|
virtual |
Get whether or not this federate is being removed.
References DtNetAssistantFederateStateMsg::isRemoval, and netAssistantFederateStateMsg().
Referenced by printData(), and DtAssistantFederationsInfoMgr::processFederateStateMsg().
|
virtual |
Get whether or not the federate has network testing enabled.
References netAssistantFederateStateMsg(), and DtNetAssistantFederateStateMsg::testEnabled.
Referenced by printData(), and DtAssistantFederationsInfoMgr::processFederateStateMsg().
|
virtual |
Get whether or not the federate has a network test in progress.
References netAssistantFederateStateMsg(), and DtNetAssistantFederateStateMsg::testInProgress.
Referenced by printData(), and DtAssistantFederationsInfoMgr::processFederateStateMsg().
|
protectedvirtual |
Returns minimum size of a message, including header.
Referenced by DtAssistantFederateStateMsg().
|
protectedvirtual |
The network representation for the message.
Referenced by assistantCompId(), clone(), connectionId(), federateHandle(), federateHostIp(), federateHostNameSize(), federateNameSize(), federateTypeSize(), federationNamePtr(), federationNameSize(), hlaVersion(), isContinuousTest(), isDisconnected(), isReconnecting(), isRemoval(), isTestEnabled(), isTestInProgress(), numInitiatedTests(), numTestReports(), setAssistantCompId(), setConnectionId(), setFederateHandle(), setFederateHostIp(), setFederateHostNameSize(), setFederateNameSize(), setFederateTypeSize(), setFederationNameSize(), setHlaVersion(), setIsContinuousTest(), setIsDisconnected(), setIsReconnecting(), setIsRemoval(), setIsTestEnabled(), setIsTestInProgress(), setNumInitiatedTests(), and setNumTestReports().
|
protectedvirtual |
|
virtual |
Get the federate's number of initiated network test.
References netAssistantFederateStateMsg(), and DtNetAssistantFederateStateMsg::numInitiatedTests.
Referenced by printData(), and DtAssistantFederationsInfoMgr::processFederateStateMsg().
|
virtual |
Get the federate's number of test reports generated.
References netAssistantFederateStateMsg(), and DtNetAssistantFederateStateMsg::numTestReports.
Referenced by printData(), and DtAssistantFederationsInfoMgr::processFederateStateMsg().
|
virtual |
Print the data section.
Reimplemented from DtAssistantMsg.
References connectionId(), federateHandle(), federateHostIp(), federateHostName(), federateName(), federateType(), federationName(), isContinuousTest(), isDisconnected(), isReconnecting(), isRemoval(), isTestEnabled(), isTestInProgress(), numInitiatedTests(), and numTestReports().
|
static |
References DtAssistantFederateStateMsgKind, and DtRtiAssistantServer::removeMsgCallback().
Referenced by DtAssistantFederationsInfoMgr::~DtAssistantFederationsInfoMgr().
|
static |
References DtAssistantFederateStateMsgKind, and DtRtiAssistantPeer::removeMsgCallback().
|
virtual |
Set the connection ID.
References DtNetAssistantFederateStateMsg::astntCompId, DtAssistantMsg::compId(), and netAssistantFederateStateMsg().
Referenced by DtRtiAssistantExecClient::sendFederateUpdateMsg().
|
virtual |
Set the connection ID.
References DtNetAssistantFederateStateMsg::connId, and netAssistantFederateStateMsg().
Referenced by DtRtiAssistantExecClient::sendFederateUpdateMsg().
|
virtual |
Set the federate handle.
References DtNetAssistantFederateStateMsg::federateHandle, and netAssistantFederateStateMsg().
Referenced by DtRtiAssistantExecClient::sendFederateUpdateMsg().
|
virtual |
Set the federate host IP.
References DtNetAssistantFederateStateMsg::federateHost, DtNetAssistantFederateStateMsg::inetAddrFamily, and netAssistantFederateStateMsg().
Referenced by DtRtiAssistantExecClient::sendFederateUpdateMsg().
|
virtual |
Set the name of the host the federate is on.
References federateHostNamePtr(), federateHostNameSize(), rti1516e::insertBytes(), and setFederateHostNameSize().
Referenced by DtRtiAssistantExecClient::sendFederateUpdateMsg().
|
protectedvirtual |
Set/Get federate host name size.
References DtNetAssistantFederateStateMsg::federateHostNameSize, and netAssistantFederateStateMsg().
Referenced by setFederateHostName().
|
virtual |
Get the federates name.
References federateNamePtr(), federateNameSize(), rti1516e::insertBytes(), and setFederateNameSize().
Referenced by DtRtiAssistantExecClient::sendFederateUpdateMsg().
|
protectedvirtual |
Set/Get federate name size.
References DtNetAssistantFederateStateMsg::federateNameSize, and netAssistantFederateStateMsg().
Referenced by setFederateName().
|
virtual |
set the federate's type
References federateTypePtr(), federateTypeSize(), rti1516e::insertBytes(), and setFederateTypeSize().
Referenced by DtRtiAssistantExecClient::sendFederateUpdateMsg().
|
protectedvirtual |
Set/Get federate type size.
References DtNetAssistantFederateStateMsg::federateTypeSize, and netAssistantFederateStateMsg().
Referenced by setFederateType().
|
virtual |
Set the federation name for this federate.
References federationNamePtr(), federationNameSize(), rti1516e::insertBytes(), and setFederationNameSize().
Referenced by DtRtiAssistantExecClient::sendFederateUpdateMsg().
|
protectedvirtual |
Set/Get federation name size.
References DtNetAssistantFederateStateMsg::federationNameSize, and netAssistantFederateStateMsg().
Referenced by setFederationName().
|
virtual |
Set the federate's HLA version.
References DtNetAssistantFederateStateMsg::hlaVersion, netAssistantFederateStateMsg(), and DtAssistantMsg::version().
Referenced by DtRtiAssistantExecClient::sendFederateUpdateMsg().
|
virtual |
Set whether or not the federate is configured to run a test continuously.
References DtNetAssistantFederateStateMsg::continuousTest, and netAssistantFederateStateMsg().
Referenced by DtRtiAssistantExecClient::sendFederateUpdateMsg().
|
virtual |
Set whether or not the federate has disconnected.
References DtNetAssistantFederateStateMsg::isDisconnected, and netAssistantFederateStateMsg().
Referenced by DtRtiAssistantExecClient::sendFederateUpdateMsg().
|
virtual |
Set whether or not the federate is currently reconnecting.
References DtNetAssistantFederateStateMsg::isReconnecting, and netAssistantFederateStateMsg().
Referenced by DtRtiAssistantExecClient::sendFederateUpdateMsg().
|
virtual |
Set whether or not this federate is being removed.
References DtNetAssistantFederateStateMsg::isRemoval, and netAssistantFederateStateMsg().
Referenced by DtRtiAssistantExecClient::sendFederateUpdateMsg().
|
virtual |
Set whether or not the federate has network testing enabled.
References netAssistantFederateStateMsg(), and DtNetAssistantFederateStateMsg::testEnabled.
Referenced by DtRtiAssistantExecClient::sendFederateUpdateMsg().
|
virtual |
Set whether or not the federate has a network test in progress.
References netAssistantFederateStateMsg(), and DtNetAssistantFederateStateMsg::testInProgress.
Referenced by DtRtiAssistantExecClient::sendFederateUpdateMsg().
|
virtual |
Set the federate's number of initiated network test.
References netAssistantFederateStateMsg(), and DtNetAssistantFederateStateMsg::numInitiatedTests.
Referenced by DtRtiAssistantExecClient::sendFederateUpdateMsg().
|
virtual |
Set the federate's number of test reports generated.
References netAssistantFederateStateMsg(), and DtNetAssistantFederateStateMsg::numTestReports.
Referenced by DtRtiAssistantExecClient::sendFederateUpdateMsg().