MAK RTIspy API Documentation for HLA Evolved
Public Member Functions | Static Public Member Functions | Protected Member Functions
DtAssistantExecStateMsg Class Reference

The DtAssistantExecStateMsg 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 DtAssistantExecStateMsg:
+ Collaboration diagram for DtAssistantExecStateMsg:

List of all members.

Public Member Functions

 DtAssistantExecStateMsg (MAKRti::DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructors.
 DtAssistantExecStateMsg (const DtNetAssistantExecStateMsg *netRepMsg, MAKRti::DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual ~DtAssistantExecStateMsg ()
 Destructor.
virtual DtAssistantMsgclone (bool copy=true) const
 Return a copy/empty object of the same type as this.
virtual void printData () const
 Print the data section.
void getAllData (unsigned int &numFedexs, std::vector< unsigned int > &fedexHandles, std::vector< MAKRti::DtString > &fedexNames, std::vector< unsigned int > &fedsInEachFedex, std::vector< unsigned int > &fedHandles, std::vector< MAKRti::DtString > &fedNames, std::vector< MAKRti::DtString > &fedHostNames, std::vector< MAKRti::DtInetAddr > &federateAddrs, std::vector< DtHlaVersionId > &hlaVers) const
bool setAllData (unsigned int numFedexs, const std::vector< unsigned int > &fedexHandles, const std::vector< MAKRti::DtString > &fedexNames, const std::vector< unsigned int > &federatesInEachFedex, const std::vector< unsigned int > &fedHandles, const std::vector< MAKRti::DtString > &fedNames, const std::vector< MAKRti::DtString > &fedHostNames, const std::vector< MAKRti::DtInetAddr > &federateAddrs, const std::vector< DtHlaVersionId > &hlaVers)

Static Public Member Functions

static DtAssistantMsgcreate (const DtNetAssistantMsgHeader *initial, MAKRti::DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Creators.
static DtAssistantMsgcreate (MAKRti::DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void addCallback (DtRtiAssistantServer *conn, DtAssistantExecStateCb cb, void *usr)
 Adds or removes a callback with the given Assistant server for this message type.
static void removeCallback (DtRtiAssistantServer *conn, DtAssistantExecStateCb cb, void *usr)
static void addCallback (DtRtiAssistantPeer *conn, DtAssistantExecStateCb cb, void *usr)
 Adds or removes a callback with the given Assistant peer for this message type.
static void removeCallback (DtRtiAssistantPeer *conn, DtAssistantExecStateCb cb, void *usr)

Protected Member Functions

virtual
DtNetAssistantExecStateMsg
netAssistantExecStateMsg ()
 The network representation for the message.
virtual const
DtNetAssistantExecStateMsg
netAssistantExecStateMsg () const
virtual DtAssistantMsgKind internalMsgKind ()
 Returns the kind of a DtAssistantExecStateMsg message.
virtual int minSize () const
 Returns minimum size of a message, including header.
virtual unsigned int numFederations () const
 Get / Set total number of federations this exec has.
virtual void setNumFederations (unsigned int numFed)
virtual unsigned long federationNamesSize () const
 Get / Set total size of the names of all of the { sizeOfThisFedexName + thisFedexName }.
virtual void setFederationNamesSize (unsigned long)
virtual const char * federationNamesPtr () const
 Get pointer at start of federation Names data.
virtual char * federationNamesPtr ()
virtual bool setFederationNames (const std::vector< MAKRti::DtString > &fedexNames)
virtual void federationNames (std::vector< MAKRti::DtString > &names) const
virtual unsigned int numFederates () const
 Get / Set the total number of federates in all federations.
virtual void setNumFederates (unsigned int totalNum)
virtual
MAKRti::DtInetUtils::DtInetAddrFamily 
addressFamily () const
 Get / Set address family of the federation host addresses.
virtual void setAddressFamily (MAKRti::DtInetUtils::DtInetAddrFamily totalNum)
virtual unsigned long federateNamesSize () const
 Get / Set total size of the names of all the { sizeOfThisFederateName + thisFederateName }.
virtual void setFederateNamesSize (unsigned long)
virtual const char * federateNamesPtr () const
 Get pointer at start of federate Names data.
virtual char * federateNamesPtr ()
virtual bool setFederateNames (const std::vector< MAKRti::DtString > &fedNames)
virtual void federateNames (std::vector< MAKRti::DtString > &fedNames) const
virtual unsigned long federateHostNamesSize () const
 Get / Set total size of the names of all the { sizeOfThisFederateHostName + thisFederateHostNameName }.
virtual void setFederateHostNamesSize (unsigned long)
virtual const char * federateHostNamesPtr () const
 Get pointer at start of federate Host names data.
virtual char * federateHostNamesPtr ()
virtual bool setFederateHostNames (const std::vector< MAKRti::DtString > &fedHostNames)
virtual void federateHostNames (std::vector< MAKRti::DtString > &names) const
virtual void federationHandles (std::vector< unsigned int > &handles) const
 Get / Set vector containing all federation handles.
virtual bool setFederationHandles (const std::vector< unsigned int > &fedexHandles)
virtual const DtNetU32 * federationHandlesPtr () const
 Get pointer at start of federationHandles data.
virtual DtNetU32 * federationHandlesPtr ()
virtual void federateHandles (std::vector< unsigned int > &handles) const
 Get / Set vector containing all federate handles.
virtual bool setFederateHandles (const std::vector< unsigned int > &fedHandles)
virtual const DtNetU32 * federateHandlesPtr () const
 Get pointer at start of federateHandles data.
virtual DtNetU32 * federateHandlesPtr ()
virtual void federateHlaVersions (std::vector< DtHlaVersionId > &versions) const
 Get / Set vector containing all federate HLA versions.
virtual bool setFederateHlaVersions (const std::vector< DtHlaVersionId > &versions)
virtual const DtNetU8 * federateHlaVersionsPtr () const
 Get pointer at start of federateHlaVersions data.
virtual DtNetU8 * federateHlaVersionsPtr ()
virtual void federateHostAddresses (std::vector< MAKRti::DtInetAddr > &addrs) const
 Get / Set vector containing all federate host Addresses.
virtual bool setFederateHostAddresses (const std::vector< MAKRti::DtInetAddr > &federateAddrs)
virtual const DtNetU128 * federateHostAddrsPtr () const
 Get pointer at start of federate Host Addresses data.
virtual DtNetU128 * federateHostAddrsPtr ()
virtual void numFederatesInEachFederation (std::vector< unsigned int > &numFeds) const
 Get / Set vector containing num Federates in each federation.
virtual bool setNumFederatesInEachFederation (const std::vector< unsigned int > &federatesInEachFedex)
virtual const DtNetU16 * federatesInEachFederationPtr () const
 Get pointer at start of numFederatesInEachFederation data.
virtual DtNetU16 * federatesInEachFederationPtr ()

Detailed Description

The DtAssistantExecStateMsg 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.


Constructor & Destructor Documentation

DtAssistantExecStateMsg::DtAssistantExecStateMsg ( MAKRti::DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructors.

Referenced by clone().

DtAssistantExecStateMsg::DtAssistantExecStateMsg ( const DtNetAssistantExecStateMsg netRepMsg,
MAKRti::DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
)

Destructor.


Member Function Documentation

void DtAssistantExecStateMsg::addCallback ( DtRtiAssistantServer conn,
DtAssistantExecStateCb  cb,
void *  usr 
) [static]

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

References DtRtiAssistantServer::addMsgCallback(), and DtAssistantExecStateMsgKind.

Referenced by DtAssistantFederationsInfoMgr::requestSingleUpdateFromConnectedRtiexecs().

void DtAssistantExecStateMsg::addCallback ( DtRtiAssistantPeer conn,
DtAssistantExecStateCb  cb,
void *  usr 
) [static]

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

References DtRtiAssistantPeer::addMsgCallback(), and DtAssistantExecStateMsgKind.

MAKRti::DtInetUtils::DtInetAddrFamily DtAssistantExecStateMsg::addressFamily ( ) const [protected, virtual]

Get / Set address family of the federation host addresses.

References netAssistantExecStateMsg().

Referenced by federateHostAddresses().

DtAssistantMsg * DtAssistantExecStateMsg::clone ( bool  copy = true) const [virtual]

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

Implements DtAssistantMsg.

References DtAssistantExecStateMsg(), and netAssistantExecStateMsg().

static DtAssistantMsg* DtAssistantExecStateMsg::create ( const DtNetAssistantMsgHeader initial,
MAKRti::DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER 
) [static]

Creators.

static DtAssistantMsg* DtAssistantExecStateMsg::create ( MAKRti::DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER) [static]
void DtAssistantExecStateMsg::federateHandles ( std::vector< unsigned int > &  handles) const [protected, virtual]

Get / Set vector containing all federate handles.

References federateHandlesPtr(), and numFederates().

Referenced by getAllData().

const DtNetU32 * DtAssistantExecStateMsg::federateHandlesPtr ( ) const [protected, virtual]

Get pointer at start of federateHandles data.

References federationHandlesPtr(), and numFederations().

Referenced by federateHandles(), federatesInEachFederationPtr(), and setFederateHandles().

DtNetU32 * DtAssistantExecStateMsg::federateHandlesPtr ( ) [protected, virtual]
void DtAssistantExecStateMsg::federateHlaVersions ( std::vector< DtHlaVersionId > &  versions) const [protected, virtual]

Get / Set vector containing all federate HLA versions.

References federateHlaVersionsPtr(), and numFederates().

Referenced by getAllData().

const DtNetU8 * DtAssistantExecStateMsg::federateHlaVersionsPtr ( ) const [protected, virtual]

Get pointer at start of federateHlaVersions data.

References federatesInEachFederationPtr(), and numFederations().

Referenced by federateHlaVersions(), federationNamesPtr(), and setFederateHlaVersions().

DtNetU8 * DtAssistantExecStateMsg::federateHlaVersionsPtr ( ) [protected, virtual]
void DtAssistantExecStateMsg::federateHostAddresses ( std::vector< MAKRti::DtInetAddr > &  addrs) const [protected, virtual]

Get / Set vector containing all federate host Addresses.

References addressFamily(), federateHostAddrsPtr(), and numFederates().

Referenced by getAllData().

const DtNetU128 * DtAssistantExecStateMsg::federateHostAddrsPtr ( ) const [protected, virtual]

Get pointer at start of federate Host Addresses data.

Get pointer at start of federateHostAddrs data.

References netAssistantExecStateMsg().

Referenced by federateHostAddresses(), federationHandlesPtr(), setAllData(), and setFederateHostAddresses().

DtNetU128 * DtAssistantExecStateMsg::federateHostAddrsPtr ( ) [protected, virtual]
void DtAssistantExecStateMsg::federateHostNames ( std::vector< MAKRti::DtString > &  names) const [protected, virtual]

References federateHostNamesPtr(), and numFederates().

Referenced by getAllData().

const char * DtAssistantExecStateMsg::federateHostNamesPtr ( ) const [protected, virtual]

Get pointer at start of federate Host names data.

References federateNamesPtr(), and federateNamesSize().

Referenced by federateHostNames(), and setFederateHostNames().

char * DtAssistantExecStateMsg::federateHostNamesPtr ( ) [protected, virtual]
unsigned long DtAssistantExecStateMsg::federateHostNamesSize ( ) const [protected, virtual]

Get / Set total size of the names of all the { sizeOfThisFederateHostName + thisFederateHostNameName }.

References netAssistantExecStateMsg(), and DtNetAssistantExecStateMsg::totalFederateHostNamesSize.

Referenced by setAllData().

void DtAssistantExecStateMsg::federateNames ( std::vector< MAKRti::DtString > &  fedNames) const [protected, virtual]

References federateNamesPtr(), and numFederates().

Referenced by getAllData().

const char * DtAssistantExecStateMsg::federateNamesPtr ( ) const [protected, virtual]

Get pointer at start of federate Names data.

References federationNamesPtr(), and federationNamesSize().

Referenced by federateHostNamesPtr(), federateNames(), and setFederateNames().

char * DtAssistantExecStateMsg::federateNamesPtr ( ) [protected, virtual]
unsigned long DtAssistantExecStateMsg::federateNamesSize ( ) const [protected, virtual]

Get / Set total size of the names of all the { sizeOfThisFederateName + thisFederateName }.

References netAssistantExecStateMsg(), and DtNetAssistantExecStateMsg::totalFederateNamesSize.

Referenced by federateHostNamesPtr(), and setAllData().

const DtNetU16 * DtAssistantExecStateMsg::federatesInEachFederationPtr ( ) const [protected, virtual]

Get pointer at start of numFederatesInEachFederation data.

References federateHandlesPtr(), and numFederates().

Referenced by federateHlaVersionsPtr(), numFederatesInEachFederation(), and setNumFederatesInEachFederation().

DtNetU16 * DtAssistantExecStateMsg::federatesInEachFederationPtr ( ) [protected, virtual]
void DtAssistantExecStateMsg::federationHandles ( std::vector< unsigned int > &  handles) const [protected, virtual]

Get / Set vector containing all federation handles.

References federationHandlesPtr(), and numFederations().

Referenced by getAllData().

const DtNetU32 * DtAssistantExecStateMsg::federationHandlesPtr ( ) const [protected, virtual]

Get pointer at start of federationHandles data.

References federateHostAddrsPtr(), and numFederates().

Referenced by federateHandlesPtr(), federationHandles(), and setFederationHandles().

DtNetU32 * DtAssistantExecStateMsg::federationHandlesPtr ( ) [protected, virtual]
void DtAssistantExecStateMsg::federationNames ( std::vector< MAKRti::DtString > &  names) const [protected, virtual]

References federationNamesPtr(), and numFederations().

Referenced by getAllData().

const char * DtAssistantExecStateMsg::federationNamesPtr ( ) const [protected, virtual]

Get pointer at start of federation Names data.

References federateHlaVersionsPtr(), and numFederates().

Referenced by federateNamesPtr(), federationNames(), and setFederationNames().

char * DtAssistantExecStateMsg::federationNamesPtr ( ) [protected, virtual]
unsigned long DtAssistantExecStateMsg::federationNamesSize ( ) const [protected, virtual]

Get / Set total size of the names of all of the { sizeOfThisFedexName + thisFedexName }.

References netAssistantExecStateMsg(), and DtNetAssistantExecStateMsg::totalFederationNamesSize.

Referenced by federateNamesPtr(), and setAllData().

void DtAssistantExecStateMsg::getAllData ( unsigned int &  numFedexs,
std::vector< unsigned int > &  fedexHandles,
std::vector< MAKRti::DtString > &  fedexNames,
std::vector< unsigned int > &  fedsInEachFedex,
std::vector< unsigned int > &  fedHandles,
std::vector< MAKRti::DtString > &  fedNames,
std::vector< MAKRti::DtString > &  fedHostNames,
std::vector< MAKRti::DtInetAddr > &  federateAddrs,
std::vector< DtHlaVersionId > &  hlaVers 
) const

Returns the kind of a DtAssistantExecStateMsg message.

Implements DtAssistantMsg.

References DtAssistantExecStateMsgKind.

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

Returns minimum size of a message, including header.

unsigned int DtAssistantExecStateMsg::numFederates ( ) const [protected, virtual]
void DtAssistantExecStateMsg::numFederatesInEachFederation ( std::vector< unsigned int > &  numFeds) const [protected, virtual]

Get / Set vector containing num Federates in each federation.

References federatesInEachFederationPtr(), and numFederations().

Referenced by getAllData().

unsigned int DtAssistantExecStateMsg::numFederations ( ) const [protected, virtual]
void DtAssistantExecStateMsg::printData ( ) const [virtual]

Print the data section.

Reimplemented from DtAssistantMsg.

References numFederates(), and numFederations().

void DtAssistantExecStateMsg::removeCallback ( DtRtiAssistantPeer conn,
DtAssistantExecStateCb  cb,
void *  usr 
) [static]
void DtAssistantExecStateMsg::setAddressFamily ( MAKRti::DtInetUtils::DtInetAddrFamily  totalNum) [protected, virtual]
bool DtAssistantExecStateMsg::setAllData ( unsigned int  numFedexs,
const std::vector< unsigned int > &  fedexHandles,
const std::vector< MAKRti::DtString > &  fedexNames,
const std::vector< unsigned int > &  federatesInEachFedex,
const std::vector< unsigned int > &  fedHandles,
const std::vector< MAKRti::DtString > &  fedNames,
const std::vector< MAKRti::DtString > &  fedHostNames,
const std::vector< MAKRti::DtInetAddr > &  federateAddrs,
const std::vector< DtHlaVersionId > &  hlaVers 
)
bool DtAssistantExecStateMsg::setFederateHandles ( const std::vector< unsigned int > &  fedHandles) [protected, virtual]

References federateHandlesPtr().

Referenced by setAllData().

bool DtAssistantExecStateMsg::setFederateHlaVersions ( const std::vector< DtHlaVersionId > &  versions) [protected, virtual]

References federateHlaVersionsPtr().

Referenced by setAllData().

bool DtAssistantExecStateMsg::setFederateHostAddresses ( const std::vector< MAKRti::DtInetAddr > &  federateAddrs) [protected, virtual]

References federateHostAddrsPtr(), and setAddressFamily().

Referenced by setAllData().

bool DtAssistantExecStateMsg::setFederateHostNames ( const std::vector< MAKRti::DtString > &  fedHostNames) [protected, virtual]

References federateHostNamesPtr(), and numFederates().

Referenced by setAllData().

void DtAssistantExecStateMsg::setFederateHostNamesSize ( unsigned long  size) [protected, virtual]
bool DtAssistantExecStateMsg::setFederateNames ( const std::vector< MAKRti::DtString > &  fedNames) [protected, virtual]

References federateNamesPtr(), and numFederates().

Referenced by setAllData().

void DtAssistantExecStateMsg::setFederateNamesSize ( unsigned long  size) [protected, virtual]
bool DtAssistantExecStateMsg::setFederationHandles ( const std::vector< unsigned int > &  fedexHandles) [protected, virtual]

References federationHandlesPtr().

Referenced by setAllData().

bool DtAssistantExecStateMsg::setFederationNames ( const std::vector< MAKRti::DtString > &  fedexNames) [protected, virtual]

References federationNamesPtr(), and numFederations().

Referenced by setAllData().

void DtAssistantExecStateMsg::setFederationNamesSize ( unsigned long  size) [protected, virtual]
void DtAssistantExecStateMsg::setNumFederates ( unsigned int  totalNum) [protected, virtual]
bool DtAssistantExecStateMsg::setNumFederatesInEachFederation ( const std::vector< unsigned int > &  federatesInEachFedex) [protected, virtual]

References federatesInEachFederationPtr().

Referenced by setAllData().

void DtAssistantExecStateMsg::setNumFederations ( unsigned int  numFed) [protected, 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)