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 void	printSrcDest () 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)
virtual const DtAssistantUuid &	sourceUuid () const
	Get/Set the uuid of the source of this message.
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.
virtual void	setIsForeign (bool isForeignDestination)
virtual DtU32	sequence () const
	Get/Set sequence number Assistant-to-Assistant messages only.
virtual void	setSequence (DtU32 sequenceNumber)

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

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

virtual DtAssistantExecStateMsg::~DtAssistantExecStateMsg ( )

virtual

Destructor.

Member Function Documentation

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

static

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

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

static

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

virtual MAKRti::DtInetUtils::DtInetAddrFamily DtAssistantExecStateMsg::addressFamily ( ) const

protectedvirtual

Get / Set address family of the federation host addresses.

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

virtual

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

Implements DtAssistantMsg.

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

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

protectedvirtual

Get / Set vector containing all federate handles.

virtual const DtNetU32* DtAssistantExecStateMsg::federateHandlesPtr ( ) const

protectedvirtual

Get pointer at start of federateHandles data.

virtual DtNetU32* DtAssistantExecStateMsg::federateHandlesPtr ( )

protectedvirtual

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

protectedvirtual

Get / Set vector containing all federate HLA versions.

virtual const DtNetU8* DtAssistantExecStateMsg::federateHlaVersionsPtr ( ) const

protectedvirtual

Get pointer at start of federateHlaVersions data.

virtual DtNetU8* DtAssistantExecStateMsg::federateHlaVersionsPtr ( )

protectedvirtual

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

protectedvirtual

Get / Set vector containing all federate host Addresses.

virtual const DtNetU128* DtAssistantExecStateMsg::federateHostAddrsPtr ( ) const

protectedvirtual

Get pointer at start of federate Host Addresses data.

virtual DtNetU128* DtAssistantExecStateMsg::federateHostAddrsPtr ( )

protectedvirtual

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

protectedvirtual

virtual const char* DtAssistantExecStateMsg::federateHostNamesPtr ( ) const

protectedvirtual

Get pointer at start of federate Host names data.

virtual char* DtAssistantExecStateMsg::federateHostNamesPtr ( )

protectedvirtual

virtual unsigned long DtAssistantExecStateMsg::federateHostNamesSize ( ) const

protectedvirtual

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

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

protectedvirtual

virtual const char* DtAssistantExecStateMsg::federateNamesPtr ( ) const

protectedvirtual

Get pointer at start of federate Names data.

virtual char* DtAssistantExecStateMsg::federateNamesPtr ( )

protectedvirtual

virtual unsigned long DtAssistantExecStateMsg::federateNamesSize ( ) const

protectedvirtual

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

virtual const DtNetU16* DtAssistantExecStateMsg::federatesInEachFederationPtr ( ) const

protectedvirtual

virtual DtNetU16* DtAssistantExecStateMsg::federatesInEachFederationPtr ( )

protectedvirtual

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

protectedvirtual

Get / Set vector containing all federation handles.

virtual const DtNetU32* DtAssistantExecStateMsg::federationHandlesPtr ( ) const

protectedvirtual

Get pointer at start of federationHandles data.

virtual DtNetU32* DtAssistantExecStateMsg::federationHandlesPtr ( )

protectedvirtual

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

protectedvirtual

virtual const char* DtAssistantExecStateMsg::federationNamesPtr ( ) const

protectedvirtual

Get pointer at start of federation Names data.

virtual char* DtAssistantExecStateMsg::federationNamesPtr ( )

protectedvirtual

virtual unsigned long DtAssistantExecStateMsg::federationNamesSize ( ) const

protectedvirtual

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

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

virtual DtAssistantMsgKind DtAssistantExecStateMsg::internalMsgKind ( )

protectedvirtual

Returns the kind of a DtAssistantExecStateMsg message.

Implements DtAssistantMsg.

virtual int DtAssistantExecStateMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

virtual DtNetAssistantExecStateMsg* DtAssistantExecStateMsg::netAssistantExecStateMsg ( )

protectedvirtual

The network representation for the message.

virtual const DtNetAssistantExecStateMsg* DtAssistantExecStateMsg::netAssistantExecStateMsg ( ) const

protectedvirtual

virtual unsigned int DtAssistantExecStateMsg::numFederates ( ) const

protectedvirtual

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

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

protectedvirtual

Get / Set vector containing num Federates in each federation.

virtual unsigned int DtAssistantExecStateMsg::numFederations ( ) const

protectedvirtual

Get / Set total number of federations this exec has.

virtual void DtAssistantExecStateMsg::printData ( ) const

virtual

Print the data section.

Reimplemented from DtAssistantMsg.

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

static

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

static

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

protectedvirtual

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
	)

virtual bool DtAssistantExecStateMsg::setFederateHandles ( const std::vector< unsigned int > & fedHandles )

protectedvirtual

virtual bool DtAssistantExecStateMsg::setFederateHlaVersions ( const std::vector< DtHlaVersionId > & versions )

protectedvirtual

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

protectedvirtual

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

protectedvirtual

virtual void DtAssistantExecStateMsg::setFederateHostNamesSize ( unsigned long )

protectedvirtual

virtual bool DtAssistantExecStateMsg::setFederateNames ( const std::vector< MAKRti::DtString > & fedNames )

protectedvirtual

virtual void DtAssistantExecStateMsg::setFederateNamesSize ( unsigned long )

protectedvirtual

virtual bool DtAssistantExecStateMsg::setFederationHandles ( const std::vector< unsigned int > & fedexHandles )

protectedvirtual

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

protectedvirtual

virtual void DtAssistantExecStateMsg::setFederationNamesSize ( unsigned long )

protectedvirtual

virtual void DtAssistantExecStateMsg::setNumFederates ( unsigned int totalNum )

protectedvirtual

virtual bool DtAssistantExecStateMsg::setNumFederatesInEachFederation ( const std::vector< unsigned int > & federatesInEachFedex )

protectedvirtual

virtual void DtAssistantExecStateMsg::setNumFederations ( unsigned int numFed )

protectedvirtual

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

assistantExecStateMsg.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation