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:

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 DtAssistantMsg *	clone (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)
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, MAKRti::DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Creators.
static DtAssistantMsg *	create (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)
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 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 ()
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 ()

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

DtAssistantExecStateMsg::~DtAssistantExecStateMsg ( )

virtual

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

protectedvirtual

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

protectedvirtual

Get / Set vector containing all federate handles.

References federateHandlesPtr(), and numFederates().

Referenced by getAllData().

const DtNetU32 * DtAssistantExecStateMsg::federateHandlesPtr ( ) const

protectedvirtual

Get pointer at start of federateHandles data.

References federationHandlesPtr(), and numFederations().

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

DtNetU32 * DtAssistantExecStateMsg::federateHandlesPtr ( )

protectedvirtual

References federationHandlesPtr(), and numFederations().

void DtAssistantExecStateMsg::federateHlaVersions ( std::vector< DtHlaVersionId > & versions ) const

protectedvirtual

Get / Set vector containing all federate HLA versions.

References federateHlaVersionsPtr(), and numFederates().

Referenced by getAllData().

const DtNetU8 * DtAssistantExecStateMsg::federateHlaVersionsPtr ( ) const

protectedvirtual

Get pointer at start of federateHlaVersions data.

References federatesInEachFederationPtr(), and numFederations().

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

DtNetU8 * DtAssistantExecStateMsg::federateHlaVersionsPtr ( )

protectedvirtual

References federatesInEachFederationPtr(), and numFederations().

void DtAssistantExecStateMsg::federateHostAddresses ( std::vector< MAKRti::DtInetAddr > & addrs ) const

protectedvirtual

Get / Set vector containing all federate host Addresses.

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

Referenced by getAllData().

const DtNetU128 * DtAssistantExecStateMsg::federateHostAddrsPtr ( ) const

protectedvirtual

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

protectedvirtual

References netAssistantExecStateMsg().

void DtAssistantExecStateMsg::federateHostNames ( std::vector< MAKRti::DtString > & names ) const

protectedvirtual

References federateHostNamesPtr(), and numFederates().

Referenced by getAllData().

const char * DtAssistantExecStateMsg::federateHostNamesPtr ( ) const

protectedvirtual

Get pointer at start of federate Host names data.

References federateNamesPtr(), and federateNamesSize().

Referenced by federateHostNames(), and setFederateHostNames().

char * DtAssistantExecStateMsg::federateHostNamesPtr ( )

protectedvirtual

References federateNamesPtr(), and federateNamesSize().

unsigned long DtAssistantExecStateMsg::federateHostNamesSize ( ) const

protectedvirtual

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

protectedvirtual

References federateNamesPtr(), and numFederates().

Referenced by getAllData().

const char * DtAssistantExecStateMsg::federateNamesPtr ( ) const

protectedvirtual

Get pointer at start of federate Names data.

References federationNamesPtr(), and federationNamesSize().

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

char * DtAssistantExecStateMsg::federateNamesPtr ( )

protectedvirtual

References federationNamesPtr(), and federationNamesSize().

unsigned long DtAssistantExecStateMsg::federateNamesSize ( ) const

protectedvirtual

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

protectedvirtual

Get pointer at start of numFederatesInEachFederation data.

References federateHandlesPtr(), and numFederates().

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

DtNetU16 * DtAssistantExecStateMsg::federatesInEachFederationPtr ( )

protectedvirtual

References federateHandlesPtr(), and numFederates().

void DtAssistantExecStateMsg::federationHandles ( std::vector< unsigned int > & handles ) const

protectedvirtual

Get / Set vector containing all federation handles.

References federationHandlesPtr(), and numFederations().

Referenced by getAllData().

const DtNetU32 * DtAssistantExecStateMsg::federationHandlesPtr ( ) const

protectedvirtual

Get pointer at start of federationHandles data.

References federateHostAddrsPtr(), and numFederates().

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

DtNetU32 * DtAssistantExecStateMsg::federationHandlesPtr ( )

protectedvirtual

References federateHostAddrsPtr(), and numFederates().

void DtAssistantExecStateMsg::federationNames ( std::vector< MAKRti::DtString > & names ) const

protectedvirtual

References federationNamesPtr(), and numFederations().

Referenced by getAllData().

const char * DtAssistantExecStateMsg::federationNamesPtr ( ) const

protectedvirtual

Get pointer at start of federation Names data.

References federateHlaVersionsPtr(), and numFederates().

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

char * DtAssistantExecStateMsg::federationNamesPtr ( )

protectedvirtual

References federateHlaVersionsPtr(), and numFederates().

unsigned long DtAssistantExecStateMsg::federationNamesSize ( ) const

protectedvirtual

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

References federateHandles(), federateHlaVersions(), federateHostAddresses(), federateHostNames(), federateNames(), federationHandles(), federationNames(), numFederatesInEachFederation(), and numFederations().

Referenced by DtAssistantComponentMgr::printFederationList().

DtAssistantMsgKind DtAssistantExecStateMsg::internalMsgKind ( )

protectedvirtual

Returns the kind of a DtAssistantExecStateMsg message.

Implements DtAssistantMsg.

References DtAssistantExecStateMsgKind.

int DtAssistantExecStateMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

DtNetAssistantExecStateMsg * DtAssistantExecStateMsg::netAssistantExecStateMsg ( )

protectedvirtual

The network representation for the message.

Referenced by addressFamily(), clone(), federateHostAddrsPtr(), federateHostNamesSize(), federateNamesSize(), federationNamesSize(), numFederates(), numFederations(), setAddressFamily(), setFederateHostNamesSize(), setFederateNamesSize(), setFederationNamesSize(), setNumFederates(), and setNumFederations().

const DtNetAssistantExecStateMsg * DtAssistantExecStateMsg::netAssistantExecStateMsg ( ) const

protectedvirtual

unsigned int DtAssistantExecStateMsg::numFederates ( ) const

protectedvirtual

Get / Set the total number of federates in all federations.

References netAssistantExecStateMsg(), and DtNetAssistantExecStateMsg::totalNumFederates.

Referenced by federateHandles(), federateHlaVersions(), federateHostAddresses(), federateHostNames(), federateNames(), federatesInEachFederationPtr(), federationHandlesPtr(), federationNamesPtr(), printData(), setAllData(), setFederateHostNames(), and setFederateNames().

void DtAssistantExecStateMsg::numFederatesInEachFederation ( std::vector< unsigned int > & numFeds ) const

protectedvirtual

Get / Set vector containing num Federates in each federation.

References federatesInEachFederationPtr(), and numFederations().

Referenced by getAllData().

unsigned int DtAssistantExecStateMsg::numFederations ( ) const

protectedvirtual

Get / Set total number of federations this exec has.

References netAssistantExecStateMsg(), and DtNetAssistantExecStateMsg::numFederations.

Referenced by federateHandlesPtr(), federateHlaVersionsPtr(), federationHandles(), federationNames(), getAllData(), numFederatesInEachFederation(), printData(), setAllData(), and setFederationNames().

void DtAssistantExecStateMsg::printData ( ) const

virtual

Print the data section.

Reimplemented from DtAssistantMsg.

References numFederates(), and numFederations().

void DtAssistantExecStateMsg::removeCallback	(	DtRtiAssistantServer *	conn,
		DtAssistantExecStateCb	cb,
		void *	usr
	)

static

References DtAssistantExecStateMsgKind, and DtRtiAssistantServer::removeMsgCallback().

Referenced by DtAssistantFederationsInfoMgr::processExecStateMsgForConnection(), and DtAssistantFederationsInfoMgr::pruneTimedOutSingleUpdates().

void DtAssistantExecStateMsg::removeCallback	(	DtRtiAssistantPeer *	conn,
		DtAssistantExecStateCb	cb,
		void *	usr
	)

static

References DtAssistantExecStateMsgKind, and DtRtiAssistantPeer::removeMsgCallback().

void DtAssistantExecStateMsg::setAddressFamily ( MAKRti::DtInetUtils::DtInetAddrFamily totalNum )

protectedvirtual

References DtNetAssistantExecStateMsg::inetAddrFamily, and netAssistantExecStateMsg().

Referenced by setFederateHostAddresses().

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
	)