![]() |
MAK RTIspy API Documentation for HLA 1.3
|
The DtAssistantFederationStateMsg defines a wrapper for the RTI Assistant federation state message sent to an assistant from a local rtiexec and between assistants to relay federation information. More...
Inheritance diagram for DtAssistantFederationStateMsg:
Collaboration diagram for DtAssistantFederationStateMsg:Public Member Functions | |
| DtAssistantFederationStateMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| Constructors. More... | |
| DtAssistantFederationStateMsg (const DtNetAssistantFederationStateMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| virtual | ~DtAssistantFederationStateMsg () |
| Destructor. More... | |
| virtual DtAssistantMsg * | clone (bool copy=true) const |
| Return a copy/empty object of the same type as this. More... | |
| virtual bool | noFederations () const |
| Get whether this rtiexec has any federations. More... | |
| virtual void | setNoFederations (bool val) |
| Set whether this rtiexec has any federations. More... | |
| virtual unsigned int | federationHandle () const |
| Get the federation handle. More... | |
| virtual void | setFederationHandle (unsigned int handle) |
| Set the federation handle. More... | |
| virtual bool | isTestEnabled () const |
| Get whether or not network testing is enabled. More... | |
| virtual void | setIsTestEnabled (bool enabled) |
| Set whether or not network testing is enabled. More... | |
| virtual bool | isRemoval () const |
| Get whether or not this federation is being removed. More... | |
| virtual void | setIsRemoval (bool remove) |
| Set whether or not this federation is being removed. More... | |
| virtual MAKRti::DtString | federationName () const |
| Get the federation name. More... | |
| virtual void | setFederationName (const MAKRti::DtString &name) |
| Set the federation name. More... | |
| virtual MAKRti::DtString | fedFileName () const |
| Get the FED file name. More... | |
| virtual void | setFedFileName (const MAKRti::DtString &name) |
| Set the FED file name. More... | |
| virtual void | getFomModules (std::list< MAKRti::DtString > &fomModules) const |
| Get the FOM Modules. More... | |
| virtual void | setFomModules (const std::list< MAKRti::DtString > &fomModules) |
| Set the FOM Modules. More... | |
| virtual void | getUpdatedFederateStates (DtFederateInfoByHandleMap &federates, const MAKRti::DtString &federation=MAKRti::DtString::nullString(), std::set< unsigned > *notUpdated=0) const |
| Adds (or updates) the states of all federates from the message as well as a set of all handles that were NOT updated if such an output set is provided. More... | |
| virtual void | setFederateStates (const DtFederateInfoByHandleMap &federates) |
| Set the states of all federates. More... | |
| virtual void | getConnection (DtRtiConnectionInfo &conn, const MAKRti::DtInetAddr &address, const MAKRti::DtInetAddr &publicAddress) const |
| Get the connection to be observed, setting the network interface address as given. More... | |
| virtual void | setConnection (const DtRtiConnectionInfo &conn) |
| Set the connection. More... | |
| virtual void | printData () const |
| Print the data section. More... | |
Public Member Functions inherited from DtAssistantMsg | |
| virtual | ~DtAssistantMsg () |
| Destructor. More... | |
| virtual DtNetAssistantMsgHeader * | netHeader () const |
| Get header of network representation. More... | |
| virtual int | version () const |
| Return the message version. More... | |
| virtual bool | isValidVersion () const |
| Returns bool: message version is valid? More... | |
| virtual DtAssistantMsgKind | msgKind () const |
| Get the message kind. More... | |
| virtual void | print () const |
| Printing functions. More... | |
| virtual void | printHeader () const |
| virtual void | printSrcDest () const |
| virtual bool | isOk () const |
| Message is good? More... | |
| bool | isAssistantToAssistantMessage () const |
| Returns whether or not this message contains source/destination information included in messages sent between assistants. More... | |
| virtual MAKRti::DtInetAddr | sourceAddr () const |
| Get/Set the IP address of the source of this message. More... | |
| virtual void | setSourceAddr (const MAKRti::DtInetAddr &addr) |
| virtual int | sourceId () const |
| Get/Set the ID of the source of this message. More... | |
| virtual void | setSourceId (int id) |
| virtual MAKRti::DtString | sourceHost () const |
| Get/Set the host name of the source of this message. More... | |
| virtual void | setSourceHost (const MAKRti::DtString &addr) |
| virtual MAKRti::DtInetAddr | destAddr () const |
| Get/Set the IP address of the destination of this message. More... | |
| virtual void | setDestAddr (const MAKRti::DtInetAddr &addr) |
| virtual int | destId () const |
| Get/Set the ID of the destination of this message. More... | |
| virtual void | setDestId (int id) |
| virtual int | compId () const |
| Get/Set the related component's connection ID. More... | |
| virtual void | setCompId (int compId) |
| virtual const DtAssistantUuid & | sourceUuid () const |
| Get/Set the uuid of the source of this message. More... | |
| virtual void | setSourceUuid (const DtAssistantUuid &uuid) |
| virtual bool | isForeign () const |
| Get/Set the whether the source considers the destination foreign Assistant-to-Assistant messages only. More... | |
| virtual void | setIsForeign (bool isForeignDestination) |
| virtual DtU32 | sequence () const |
| Get/Set sequence number Assistant-to-Assistant messages only. More... | |
| virtual void | setSequence (DtU32 sequenceNumber) |
Static Public Member Functions | |
| static DtAssistantMsg * | create (const DtNetAssistantMsgHeader *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) |
| Creators. More... | |
| static DtAssistantMsg * | create (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) |
| static void | addCallback (DtRtiAssistantServer *conn, DtAssistantFederationStateCb cb, void *usr) |
| Adds or removes a callback with the given Assistant server for this message type. More... | |
| static void | removeCallback (DtRtiAssistantServer *conn, DtAssistantFederationStateCb cb, void *usr) |
| static void | addCallback (DtRtiAssistantPeer *conn, DtAssistantFederationStateCb cb, void *usr) |
| Adds or removes a callback with the given Assistant peer for this message type. More... | |
| static void | removeCallback (DtRtiAssistantPeer *conn, DtAssistantFederationStateCb 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. More... | |
Protected Member Functions | |
| virtual DtNetAssistantFederationStateMsg * | netAssistantFederationStateMsg () |
| The network representation for the message. More... | |
| virtual const DtNetAssistantFederationStateMsg * | netAssistantFederationStateMsg () const |
| virtual DtAssistantMsgKind | internalMsgKind () |
| Returns the kind of a DtAssistantFederationStateMsg message. More... | |
| virtual int | minSize () const |
| Returns minimum size of a message, including header. More... | |
| virtual void | setAddressFamily (DtInetUtils::DtInetAddrFamily fam) |
| Get/set the address family for all of the federates in this federation. More... | |
| virtual DtInetUtils::DtInetAddrFamily | addressFamily () const |
| virtual void | setFederationNameSize (unsigned size) |
| Set/Get federation name size. More... | |
| virtual unsigned | federationNameSize () const |
| virtual void | setFedFileNameSize (unsigned size) |
| Set/Get FED file name size. More... | |
| virtual unsigned | fedFileNameSize () const |
| virtual void | setFomModulesSize (unsigned size) |
| Set/Get FOM Modules size. More... | |
| virtual unsigned | fomModulesSize () const |
| virtual void | setNumFederates (unsigned num) |
| Get/set the number of federates included in this message. More... | |
| virtual unsigned | numFederates () const |
| virtual void | setFederateTypesSize (unsigned size) |
| Set/Get federate types size. More... | |
| virtual unsigned | federateTypesSize () const |
| virtual void | setFederateNamesSize (unsigned size) |
| Set/Get federate names size. More... | |
| virtual unsigned | federateNamesSize () const |
| virtual void | setFederateHostNamesSize (unsigned size) |
| Set/Get federate host names size. More... | |
| virtual unsigned | federateHostNamesSize () const |
| virtual void | setLbtsStringsSize (unsigned size) |
| Set/Get the LBTS strings size. More... | |
| virtual unsigned | lbtsStringsSize () const |
| virtual void | setLookAheadStringsSize (unsigned size) |
| Set/Get the look ahead strings size. More... | |
| virtual unsigned | lookAheadStringsSize () const |
| virtual void | setTimeStringsSize (unsigned size) |
| Set/Get the time strings size. More... | |
| virtual unsigned | timeStringsSize () const |
| virtual DtNetU32 * | federateConnIdsPtr () |
| Return pointer to the federate connection IDs location in message. More... | |
| virtual const DtNetU32 * | federateConnIdsPtr () const |
| virtual DtNetU32 * | federateHdlsPtr () |
| Return pointer to the federate handles location in message. More... | |
| virtual const DtNetU32 * | federateHdlsPtr () const |
| virtual DtNetU32 * | federateAstntCompIdsPtr () |
| Return pointer to the federate handles location in message. More... | |
| virtual const DtNetU32 * | federateAstntCompIdsPtr () const |
| virtual DtNetU128 * | federateHostAddrsPtr () |
| Return pointer to the federate host addresses location in message. More... | |
| virtual const DtNetU128 * | federateHostAddrsPtr () const |
| virtual DtNetU32 * | federateWebServerAddrsPtr () |
| Return pointer to the federates' web server host addresses location in message. More... | |
| virtual const DtNetU32 * | federateWebServerAddrsPtr () const |
| virtual DtNetU16 * | federateWebServerPortsPtr () |
| Return pointer to the federates' web server ports location in message. More... | |
| virtual const DtNetU16 * | federateWebServerPortsPtr () const |
| virtual DtNetU16 * | federateNumInitiatedTestsPtr () |
| Return pointer to the federates' number of initiated tests location in message. More... | |
| virtual const DtNetU16 * | federateNumInitiatedTestsPtr () const |
| virtual DtNetU16 * | federateNumTestReportsPtr () |
| Return pointer to the federates' number of generated test reports location in message. More... | |
| virtual const DtNetU16 * | federateNumTestReportsPtr () const |
| virtual DtNetU8 * | federateTestEnablePtr () |
| Return pointer to the federates' test enable status location in message. More... | |
| virtual const DtNetU8 * | federateTestEnablePtr () const |
| virtual DtNetU8 * | federateTestInProgressPtr () |
| Return pointer to the federates' test in progress status location in message. More... | |
| virtual const DtNetU8 * | federateTestInProgressPtr () const |
| virtual DtNetU8 * | federateContTestPtr () |
| Return pointer to the federates' continuous test status location in message. More... | |
| virtual const DtNetU8 * | federateContTestPtr () const |
| virtual DtNetU8 * | reconnectingPtr () |
| Return pointer to the federates' reconnecting status location in message. More... | |
| virtual const DtNetU8 * | reconnectingPtr () const |
| virtual DtNetU8 * | disconnectedPtr () |
| Return pointer to the federates' disconnected status location in message. More... | |
| virtual const DtNetU8 * | disconnectedPtr () const |
| virtual DtNetU8 * | regulatingPtr () |
| Return pointer to the federates' regulating status location in message. More... | |
| virtual const DtNetU8 * | regulatingPtr () const |
| virtual DtNetU8 * | constrainedPtr () |
| Return pointer to the federates' constrained status location in message. More... | |
| virtual const DtNetU8 * | constrainedPtr () const |
| virtual DtNetU8 * | hlaVersionsPtr () |
| Return pointer to the federates' HLA version location in message. More... | |
| virtual const DtNetU8 * | hlaVersionsPtr () const |
| virtual const char * | federationNamePtr () const |
| Return pointer to federation name location in message. More... | |
| virtual char * | federationNamePtr () |
| virtual const char * | fedFileNamePtr () const |
| Return pointer to FED file name location in message. More... | |
| virtual char * | fedFileNamePtr () |
| virtual const char * | fomModulesPtr () const |
| Return a pointer to FOM Modules location in the message. More... | |
| virtual char * | fomModulesPtr () |
| virtual const char * | federateTypesPtr () const |
| Return pointer to federate types location in message. More... | |
| virtual char * | federateTypesPtr () |
| virtual const char * | federateNamesPtr () const |
| Return a pointer to federate names location in the message. More... | |
| virtual char * | federateNamesPtr () |
| virtual const char * | federateHostNamesPtr () const |
| Return pointer to federate host names location in message. More... | |
| virtual char * | federateHostNamesPtr () |
| virtual const char * | lbtsStringsPtr () const |
| Return pointer to federate LBTS strings location in message. More... | |
| virtual char * | lbtsStringsPtr () |
| virtual const char * | lookAheadStringsPtr () const |
| Return pointer to federate look ahead strings location in message. More... | |
| virtual char * | lookAheadStringsPtr () |
| virtual const char * | timeStringsPtr () const |
| Return pointer to federate time strings location in message. More... | |
| virtual char * | timeStringsPtr () |
Protected Member Functions inherited from DtAssistantMsg | |
| DtAssistantMsg () | |
| Constructor. More... | |
| virtual void | sizeChanged (int size) |
| Called whenever size is changed using changeSize, or insert/deleteBytes. More... | |
| void | initAssistantMsg (int size, DtAssistantMsgKind msgKindVal, DtBufferPtr buffer) |
| Called by ctor, so not virtual. More... | |
| 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. More... | |
| virtual void | adjustBytes (void *address, int numBytes) |
| Adjust the numBytes starting at the indicated address. More... | |
| virtual void | resizeForSrcDestInfo () |
| Allocates memory at the end of the message for source/destination information needed when sending messages between assistants. More... | |
| virtual const DtNetAssistantSrcDestInfo * | srcDestInfoPtr () const |
| Return pointer to source/destination information in the message. More... | |
| virtual DtNetAssistantSrcDestInfo * | srcDestInfoPtr () |
| virtual void | setSourceHostSize (unsigned long size) |
| Set/Get source host name text size. More... | |
| virtual unsigned long | sourceHostSize () const |
| virtual const char * | sourceHostPtr () const |
| Return pointer to source host name in message. More... | |
| virtual char * | sourceHostPtr () |
The DtAssistantFederationStateMsg defines a wrapper for the RTI Assistant federation state message sent to an assistant from a local rtiexec and between assistants to relay federation information.
| DtAssistantFederationStateMsg::DtAssistantFederationStateMsg | ( | DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER | ) |
Constructors.
| DtAssistantFederationStateMsg::DtAssistantFederationStateMsg | ( | const DtNetAssistantFederationStateMsg * | netRepMsg, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) |
|
virtual |
Destructor.
|
static |
Adds or removes a callback with the given Assistant server for this message type.
|
static |
Adds or removes a callback with the given Assistant peer for this message type.
|
protectedvirtual |
|
virtual |
Return a copy/empty object of the same type as this.
Implements DtAssistantMsg.
|
protectedvirtual |
Return pointer to the federates' constrained status location in message.
|
protectedvirtual |
|
static |
Creators.
|
static |
|
protectedvirtual |
Return pointer to the federates' disconnected status location in message.
|
protectedvirtual |
|
protectedvirtual |
Return pointer to the federate handles location in message.
|
protectedvirtual |
|
protectedvirtual |
Return pointer to the federate connection IDs location in message.
|
protectedvirtual |
|
protectedvirtual |
Return pointer to the federates' continuous test status location in message.
|
protectedvirtual |
|
protectedvirtual |
Return pointer to the federate handles location in message.
|
protectedvirtual |
|
protectedvirtual |
Return pointer to the federate host addresses location in message.
|
protectedvirtual |
|
protectedvirtual |
Return pointer to federate host names location in message.
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
Return a pointer to federate names location in the message.
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
Return pointer to the federates' number of initiated tests location in message.
|
protectedvirtual |
|
protectedvirtual |
Return pointer to the federates' number of generated test reports location in message.
|
protectedvirtual |
|
protectedvirtual |
Return pointer to the federates' test enable status location in message.
|
protectedvirtual |
|
protectedvirtual |
Return pointer to the federates' test in progress status location in message.
|
protectedvirtual |
|
protectedvirtual |
Return pointer to federate types location in message.
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
Return pointer to the federates' web server host addresses location in message.
|
protectedvirtual |
|
protectedvirtual |
Return pointer to the federates' web server ports location in message.
|
protectedvirtual |
|
virtual |
Get the federation handle.
|
virtual |
Get the federation name.
|
protectedvirtual |
Return pointer to federation name location in message.
|
protectedvirtual |
|
protectedvirtual |
|
virtual |
Get the FED file name.
|
protectedvirtual |
Return pointer to FED file name location in message.
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
Return a pointer to FOM Modules location in the message.
|
protectedvirtual |
|
protectedvirtual |
|
virtual |
Get the connection to be observed, setting the network interface address as given.
|
virtual |
Get the FOM Modules.
|
virtual |
Adds (or updates) the states of all federates from the message as well as a set of all handles that were NOT updated if such an output set is provided.
|
protectedvirtual |
Return pointer to the federates' HLA version location in message.
|
protectedvirtual |
|
protectedvirtual |
Returns the kind of a DtAssistantFederationStateMsg message.
Implements DtAssistantMsg.
|
virtual |
Get whether or not this federation is being removed.
|
virtual |
Get whether or not network testing is enabled.
|
protectedvirtual |
Return pointer to federate LBTS strings location in message.
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
Return pointer to federate look ahead strings location in message.
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
Returns minimum size of a message, including header.
|
protectedvirtual |
The network representation for the message.
|
protectedvirtual |
|
virtual |
Get whether this rtiexec has any federations.
|
protectedvirtual |
|
virtual |
Print the data section.
Reimplemented from DtAssistantMsg.
|
protectedvirtual |
Return pointer to the federates' reconnecting status location in message.
|
protectedvirtual |
|
protectedvirtual |
Return pointer to the federates' regulating status location in message.
|
protectedvirtual |
|
static |
|
static |
|
protectedvirtual |
Get/set the address family for all of the federates in this federation.
|
virtual |
Set the connection.
|
protectedvirtual |
Set/Get federate host names size.
|
protectedvirtual |
Set/Get federate names size.
|
virtual |
Set the states of all federates.
|
protectedvirtual |
Set/Get federate types size.
|
virtual |
Set the federation handle.
|
virtual |
Set the federation name.
|
protectedvirtual |
Set/Get federation name size.
|
virtual |
Set the FED file name.
|
protectedvirtual |
Set/Get FED file name size.
|
virtual |
Set the FOM Modules.
|
protectedvirtual |
Set/Get FOM Modules size.
|
virtual |
Set whether or not this federation is being removed.
|
virtual |
Set whether or not network testing is enabled.
|
protectedvirtual |
Set/Get the LBTS strings size.
|
protectedvirtual |
Set/Get the look ahead strings size.
|
virtual |
Set whether this rtiexec has any federations.
|
protectedvirtual |
Get/set the number of federates included in this message.
|
protectedvirtual |
Set/Get the time strings size.
|
protectedvirtual |
Return pointer to federate time strings location in message.
|
protectedvirtual |
|
protectedvirtual |