DtAssistantFederationStateMsg Class Reference

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.
	DtAssistantFederationStateMsg (const DtNetAssistantFederationStateMsg *netRepMsg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtAssistantFederationStateMsg ()
	Destructor.
virtual DtAssistantMsg *	clone (bool copy=true) const
	Return a copy/empty object of the same type as this.
virtual bool	noFederations () const
	Get whether this rtiexec has any federations.
virtual void	setNoFederations (bool val)
	Set whether this rtiexec has any federations.
virtual unsigned int	federationHandle () const
	Get the federation handle.
virtual void	setFederationHandle (unsigned int handle)
	Set the federation handle.
virtual bool	isTestEnabled () const
	Get whether or not network testing is enabled.
virtual void	setIsTestEnabled (bool enabled)
	Set whether or not network testing is enabled.
virtual bool	isRemoval () const
	Get whether or not this federation is being removed.
virtual void	setIsRemoval (bool remove)
	Set whether or not this federation is being removed.
virtual MAKRti::DtString	federationName () const
	Get the federation name.
virtual void	setFederationName (const MAKRti::DtString &name)
	Set the federation name.
virtual MAKRti::DtString	fedFileName () const
	Get the FED file name.
virtual void	setFedFileName (const MAKRti::DtString &name)
	Set the FED file name.
virtual void	getFomModules (std::list< MAKRti::DtString > &fomModules) const
	Get the FOM Modules.
virtual void	setFomModules (const std::list< MAKRti::DtString > &fomModules)
	Set the FOM Modules.
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.
virtual void	setFederateStates (const DtFederateInfoByHandleMap &federates)
	Set the states of all federates.
virtual void	getConnection (DtRtiConnectionInfo &conn, const MAKRti::DtInetAddr &address) const
	Get the connection to be observed, setting the network interface address as given.
virtual void	setConnection (const DtRtiConnectionInfo &conn)
	Set the connection.
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, DtAssistantFederationStateCb cb, void *usr)
	Adds or removes a callback with the given Assistant server for this message type.
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.
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.

Protected Member Functions
virtual DtNetAssistantFederationStateMsg *	netAssistantFederationStateMsg ()
	The network representation for the message.
virtual const DtNetAssistantFederationStateMsg *	netAssistantFederationStateMsg () const
virtual DtAssistantMsgKind	internalMsgKind ()
	Returns the kind of a DtAssistantFederationStateMsg message.
virtual int	minSize () const
	Returns minimum size of a message, including header.
virtual void	setAddressFamily (DtInetUtils::DtInetAddrFamily fam)
	Get/set the address family for all of the federates in this federation.
virtual DtInetUtils::DtInetAddrFamily	addressFamily () const
virtual void	setFederationNameSize (unsigned size)
	Set/Get federation name size.
virtual unsigned	federationNameSize () const
virtual void	setFedFileNameSize (unsigned size)
	Set/Get FED file name size.
virtual unsigned	fedFileNameSize () const
virtual void	setFomModulesSize (unsigned size)
	Set/Get FOM Modules size.
virtual unsigned	fomModulesSize () const
virtual void	setNumFederates (unsigned num)
	Get/set the number of federates included in this message.
virtual unsigned	numFederates () const
virtual void	setFederateTypesSize (unsigned size)
	Set/Get federate types size.
virtual unsigned	federateTypesSize () const
virtual void	setFederateNamesSize (unsigned size)
	Set/Get federate names size.
virtual unsigned	federateNamesSize () const
virtual void	setFederateHostNamesSize (unsigned size)
	Set/Get federate host names size.
virtual unsigned	federateHostNamesSize () const
virtual void	setLbtsStringsSize (unsigned size)
	Set/Get the LBTS strings size.
virtual unsigned	lbtsStringsSize () const
virtual void	setLookAheadStringsSize (unsigned size)
	Set/Get the look ahead strings size.
virtual unsigned	lookAheadStringsSize () const
virtual void	setTimeStringsSize (unsigned size)
	Set/Get the time strings size.
virtual unsigned	timeStringsSize () const
virtual DtNetU32 *	federateConnIdsPtr ()
	Return pointer to the federate connection IDs location in message.
virtual const DtNetU32 *	federateConnIdsPtr () const
virtual DtNetU32 *	federateHdlsPtr ()
	Return pointer to the federate handles location in message.
virtual const DtNetU32 *	federateHdlsPtr () const
virtual DtNetU32 *	federateAstntCompIdsPtr ()
	Return pointer to the federate handles location in message.
virtual const DtNetU32 *	federateAstntCompIdsPtr () const
virtual DtNetU128 *	federateHostAddrsPtr ()
	Return pointer to the federate host addresses location in message.
virtual const DtNetU128 *	federateHostAddrsPtr () const
virtual DtNetU32 *	federateWebServerAddrsPtr ()
	Return pointer to the federates' web server host addresses location in message.
virtual const DtNetU32 *	federateWebServerAddrsPtr () const
virtual DtNetU16 *	federateWebServerPortsPtr ()
	Return pointer to the federates' web server ports location in message.
virtual const DtNetU16 *	federateWebServerPortsPtr () const
virtual DtNetU16 *	federateNumInitiatedTestsPtr ()
	Return pointer to the federates' number of initiated tests location in message.
virtual const DtNetU16 *	federateNumInitiatedTestsPtr () const
virtual DtNetU16 *	federateNumTestReportsPtr ()
	Return pointer to the federates' number of generated test reports location in message.
virtual const DtNetU16 *	federateNumTestReportsPtr () const
virtual DtNetU8 *	federateTestEnablePtr ()
	Return pointer to the federates' test enable status location in message.
virtual const DtNetU8 *	federateTestEnablePtr () const
virtual DtNetU8 *	federateTestInProgressPtr ()
	Return pointer to the federates' test in progress status location in message.
virtual const DtNetU8 *	federateTestInProgressPtr () const
virtual DtNetU8 *	federateContTestPtr ()
	Return pointer to the federates' continuous test status location in message.
virtual const DtNetU8 *	federateContTestPtr () const
virtual DtNetU8 *	reconnectingPtr ()
	Return pointer to the federates' reconnecting status location in message.
virtual const DtNetU8 *	reconnectingPtr () const
virtual DtNetU8 *	disconnectedPtr ()
	Return pointer to the federates' disconnected status location in message.
virtual const DtNetU8 *	disconnectedPtr () const
virtual DtNetU8 *	regulatingPtr ()
	Return pointer to the federates' regulating status location in message.
virtual const DtNetU8 *	regulatingPtr () const
virtual DtNetU8 *	constrainedPtr ()
	Return pointer to the federates' constrained status location in message.
virtual const DtNetU8 *	constrainedPtr () const
virtual DtNetU8 *	hlaVersionsPtr ()
	Return pointer to the federates' HLA version location in message.
virtual const DtNetU8 *	hlaVersionsPtr () const
virtual const char *	federationNamePtr () const
	Return pointer to federation name location in message.
virtual char *	federationNamePtr ()
virtual const char *	fedFileNamePtr () const
	Return pointer to FED file name location in message.
virtual char *	fedFileNamePtr ()
virtual const char *	fomModulesPtr () const
	Return a pointer to FOM Modules location in the message.
virtual char *	fomModulesPtr ()
virtual const char *	federateTypesPtr () const
	Return pointer to federate types location in message.
virtual char *	federateTypesPtr ()
virtual const char *	federateNamesPtr () const
	Return a pointer to federate names location in the message.
virtual char *	federateNamesPtr ()
virtual const char *	federateHostNamesPtr () const
	Return pointer to federate host names location in message.
virtual char *	federateHostNamesPtr ()
virtual const char *	lbtsStringsPtr () const
	Return pointer to federate LBTS strings location in message.
virtual char *	lbtsStringsPtr ()
virtual const char *	lookAheadStringsPtr () const
	Return pointer to federate look ahead strings location in message.
virtual char *	lookAheadStringsPtr ()
virtual const char *	timeStringsPtr () const
	Return pointer to federate time strings location in message.
virtual char *	timeStringsPtr ()
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 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.

Constructor & Destructor Documentation

DtAssistantFederationStateMsg::DtAssistantFederationStateMsg

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

References DtAssistantMsg::initAssistantMsg(), internalMsgKind(), and minSize().

Referenced by clone(), and create().

DtAssistantFederationStateMsg::DtAssistantFederationStateMsg	(	const DtNetAssistantFederationStateMsg *	netRepMsg,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

References DtNetAssistantFederationStateMsg::header, and DtAssistantMsg::initAssistantMsg().

DtAssistantFederationStateMsg::~DtAssistantFederationStateMsg ( )

virtual

Destructor.

Member Function Documentation

void DtAssistantFederationStateMsg::addCallback ( DtRtiAssistantServer *  conn, DtAssistantFederationStateCb  cb, void *  usr  )

static

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

References DtRtiAssistantServer::addMsgCallback(), and DtAssistantFederationStateMsgKind.

Referenced by DtAssistantFederationsInfoMgr::DtAssistantFederationsInfoMgr().

void DtAssistantFederationStateMsg::addCallback ( DtRtiAssistantPeer *  conn, DtAssistantFederationStateCb  cb, void *  usr  )

static

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

References DtRtiAssistantPeer::addMsgCallback(), and DtAssistantFederationStateMsgKind.

DtInetUtils::DtInetAddrFamily DtAssistantFederationStateMsg::addressFamily ( ) const

protectedvirtual

References netAssistantFederationStateMsg().

Referenced by getConnection(), and getUpdatedFederateStates().

DtAssistantMsg * DtAssistantFederationStateMsg::clone ( bool  copy = true ) const

virtual

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

Implements DtAssistantMsg.

References DtAssistantFederationStateMsg(), and netAssistantFederationStateMsg().

DtNetU8 * DtAssistantFederationStateMsg::constrainedPtr ( )

protectedvirtual

Return pointer to the federates' constrained status location in message.

References numFederates(), and regulatingPtr().

Referenced by getUpdatedFederateStates(), hlaVersionsPtr(), and setFederateStates().

const DtNetU8 * DtAssistantFederationStateMsg::constrainedPtr ( ) const

protectedvirtual

References numFederates(), and regulatingPtr().

DtAssistantMsg * DtAssistantFederationStateMsg::create ( const DtNetAssistantMsgHeader *  initial, DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER  )

static

Creators.

References DtAssistantFederationStateMsg().

DtAssistantMsg * DtAssistantFederationStateMsg::create ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER )

static

References DtAssistantFederationStateMsg().

DtNetU8 * DtAssistantFederationStateMsg::disconnectedPtr ( )

protectedvirtual

Return pointer to the federates' disconnected status location in message.

References numFederates(), and reconnectingPtr().

Referenced by getUpdatedFederateStates(), regulatingPtr(), and setFederateStates().

const DtNetU8 * DtAssistantFederationStateMsg::disconnectedPtr ( ) const

protectedvirtual

References numFederates(), and reconnectingPtr().

DtNetU32 * DtAssistantFederationStateMsg::federateAstntCompIdsPtr ( )

protectedvirtual

Return pointer to the federate handles location in message.

References federateHdlsPtr(), and numFederates().

Referenced by federateWebServerPortsPtr(), getUpdatedFederateStates(), and setFederateStates().

const DtNetU32 * DtAssistantFederationStateMsg::federateAstntCompIdsPtr ( ) const

protectedvirtual

References federateHdlsPtr(), and numFederates().

DtNetU32 * DtAssistantFederationStateMsg::federateConnIdsPtr ( )

protectedvirtual

Return pointer to the federate connection IDs location in message.

References federateWebServerAddrsPtr(), and numFederates().

Referenced by federateHdlsPtr(), getUpdatedFederateStates(), and setFederateStates().

const DtNetU32 * DtAssistantFederationStateMsg::federateConnIdsPtr ( ) const

protectedvirtual

References federateWebServerAddrsPtr(), and numFederates().

DtNetU8 * DtAssistantFederationStateMsg::federateContTestPtr ( )

protectedvirtual

Return pointer to the federates' continuous test status location in message.

References federateTestInProgressPtr(), and numFederates().

Referenced by getUpdatedFederateStates(), reconnectingPtr(), and setFederateStates().

const DtNetU8 * DtAssistantFederationStateMsg::federateContTestPtr ( ) const

protectedvirtual

References federateTestInProgressPtr(), and numFederates().

DtNetU32 * DtAssistantFederationStateMsg::federateHdlsPtr ( )

protectedvirtual

Return pointer to the federate handles location in message.

References federateConnIdsPtr(), and numFederates().

Referenced by federateAstntCompIdsPtr(), getUpdatedFederateStates(), and setFederateStates().

const DtNetU32 * DtAssistantFederationStateMsg::federateHdlsPtr ( ) const

protectedvirtual

References federateConnIdsPtr(), and numFederates().

DtNetU128 * DtAssistantFederationStateMsg::federateHostAddrsPtr ( )

protectedvirtual

Return pointer to the federate host addresses location in message.

References netAssistantFederationStateMsg().

Referenced by federateWebServerAddrsPtr(), getUpdatedFederateStates(), and setFederateStates().

const DtNetU128 * DtAssistantFederationStateMsg::federateHostAddrsPtr ( ) const

protectedvirtual

References netAssistantFederationStateMsg().

const char * DtAssistantFederationStateMsg::federateHostNamesPtr ( ) const

protectedvirtual

Return pointer to federate host names location in message.

References federateNamesPtr(), and federateNamesSize().

Referenced by getUpdatedFederateStates(), lbtsStringsPtr(), and setFederateStates().

char * DtAssistantFederationStateMsg::federateHostNamesPtr ( )

protectedvirtual

References federateNamesPtr(), and federateNamesSize().

unsigned DtAssistantFederationStateMsg::federateHostNamesSize ( ) const

protectedvirtual

References DtNetAssistantFederationStateMsg::federateHostNamesSize, and netAssistantFederationStateMsg().

Referenced by lbtsStringsPtr(), and setFederateStates().

const char * DtAssistantFederationStateMsg::federateNamesPtr ( ) const

protectedvirtual

Return a pointer to federate names location in the message.

References federateTypesPtr(), and federateTypesSize().

Referenced by federateHostNamesPtr(), getUpdatedFederateStates(), and setFederateStates().

char * DtAssistantFederationStateMsg::federateNamesPtr ( )

protectedvirtual

References federateTypesPtr(), and federateTypesSize().

unsigned DtAssistantFederationStateMsg::federateNamesSize ( ) const

protectedvirtual

References DtNetAssistantFederationStateMsg::federateNamesSize, and netAssistantFederationStateMsg().

Referenced by federateHostNamesPtr(), and setFederateStates().

DtNetU16 * DtAssistantFederationStateMsg::federateNumInitiatedTestsPtr ( )

protectedvirtual

Return pointer to the federates' number of initiated tests location in message.

References federateWebServerPortsPtr(), and numFederates().

Referenced by federateNumTestReportsPtr(), getUpdatedFederateStates(), and setFederateStates().

const DtNetU16 * DtAssistantFederationStateMsg::federateNumInitiatedTestsPtr ( ) const

protectedvirtual

References federateWebServerPortsPtr(), and numFederates().

DtNetU16 * DtAssistantFederationStateMsg::federateNumTestReportsPtr ( )

protectedvirtual

Return pointer to the federates' number of generated test reports location in message.

References federateNumInitiatedTestsPtr(), and numFederates().

Referenced by federateTestEnablePtr(), getUpdatedFederateStates(), and setFederateStates().

const DtNetU16 * DtAssistantFederationStateMsg::federateNumTestReportsPtr ( ) const

protectedvirtual

References federateNumInitiatedTestsPtr(), and numFederates().

DtNetU8 * DtAssistantFederationStateMsg::federateTestEnablePtr ( )

protectedvirtual

Return pointer to the federates' test enable status location in message.

References federateNumTestReportsPtr(), and numFederates().

Referenced by federateTestInProgressPtr(), getUpdatedFederateStates(), and setFederateStates().

const DtNetU8 * DtAssistantFederationStateMsg::federateTestEnablePtr ( ) const

protectedvirtual

References federateNumTestReportsPtr(), and numFederates().

DtNetU8 * DtAssistantFederationStateMsg::federateTestInProgressPtr ( )

protectedvirtual

Return pointer to the federates' test in progress status location in message.

References federateTestEnablePtr(), and numFederates().

Referenced by federateContTestPtr(), getUpdatedFederateStates(), and setFederateStates().

const DtNetU8 * DtAssistantFederationStateMsg::federateTestInProgressPtr ( ) const

protectedvirtual

References federateTestEnablePtr(), and numFederates().

const char * DtAssistantFederationStateMsg::federateTypesPtr ( ) const

protectedvirtual

Return pointer to federate types location in message.

References fomModulesPtr(), and fomModulesSize().

Referenced by federateNamesPtr(), getUpdatedFederateStates(), and setFederateStates().

char * DtAssistantFederationStateMsg::federateTypesPtr ( )

protectedvirtual

References fomModulesPtr(), and fomModulesSize().

unsigned DtAssistantFederationStateMsg::federateTypesSize ( ) const

protectedvirtual

References DtNetAssistantFederationStateMsg::federateTypesSize, and netAssistantFederationStateMsg().

Referenced by federateNamesPtr(), and setFederateStates().

DtNetU32 * DtAssistantFederationStateMsg::federateWebServerAddrsPtr ( )

protectedvirtual

Return pointer to the federates' web server host addresses location in message.

References federateHostAddrsPtr(), and numFederates().

Referenced by federateConnIdsPtr(), getUpdatedFederateStates(), and setFederateStates().

const DtNetU32 * DtAssistantFederationStateMsg::federateWebServerAddrsPtr ( ) const

protectedvirtual

References federateHostAddrsPtr(), and numFederates().

DtNetU16 * DtAssistantFederationStateMsg::federateWebServerPortsPtr ( )

protectedvirtual

Return pointer to the federates' web server ports location in message.

References federateAstntCompIdsPtr(), and numFederates().

Referenced by federateNumInitiatedTestsPtr(), getUpdatedFederateStates(), and setFederateStates().

const DtNetU16 * DtAssistantFederationStateMsg::federateWebServerPortsPtr ( ) const

protectedvirtual

References federateAstntCompIdsPtr(), and numFederates().

unsigned int DtAssistantFederationStateMsg::federationHandle ( ) const

virtual

Get the federation handle.

References DtNetAssistantFederationStateMsg::federationHandle, and netAssistantFederationStateMsg().

Referenced by printData(), and DtAssistantFederationsInfoMgr::processFederationStateMsg().

DtString DtAssistantFederationStateMsg::federationName ( ) const

virtual

Get the federation name.

References federationNamePtr(), and federationNameSize().

Referenced by printData(), and DtAssistantFederationsInfoMgr::processFederationStateMsg().

const char * DtAssistantFederationStateMsg::federationNamePtr ( ) const

protectedvirtual

Return pointer to federation name location in message.

References hlaVersionsPtr(), and numFederates().

Referenced by federationName(), fedFileNamePtr(), and setFederationName().

char * DtAssistantFederationStateMsg::federationNamePtr ( )

protectedvirtual

References hlaVersionsPtr(), and numFederates().

unsigned DtAssistantFederationStateMsg::federationNameSize ( ) const

protectedvirtual

References DtNetAssistantFederationStateMsg::federationNameSize, and netAssistantFederationStateMsg().

Referenced by federationName(), fedFileNamePtr(), and setFederationName().

DtString DtAssistantFederationStateMsg::fedFileName ( ) const

virtual

Get the FED file name.

References fedFileNamePtr(), and fedFileNameSize().

Referenced by printData().

const char * DtAssistantFederationStateMsg::fedFileNamePtr ( ) const

protectedvirtual

Return pointer to FED file name location in message.

References federationNamePtr(), and federationNameSize().

Referenced by fedFileName(), fomModulesPtr(), and setFedFileName().

char * DtAssistantFederationStateMsg::fedFileNamePtr ( )

protectedvirtual

References federationNamePtr(), and federationNameSize().

unsigned DtAssistantFederationStateMsg::fedFileNameSize ( ) const

protectedvirtual

References DtNetAssistantFederationStateMsg::fedFileNameSize, and netAssistantFederationStateMsg().

Referenced by fedFileName(), fomModulesPtr(), and setFedFileName().

const char * DtAssistantFederationStateMsg::fomModulesPtr ( ) const

protectedvirtual

Return a pointer to FOM Modules location in the message.

References fedFileNamePtr(), and fedFileNameSize().

Referenced by federateTypesPtr(), getFomModules(), and setFomModules().

char * DtAssistantFederationStateMsg::fomModulesPtr ( )

protectedvirtual

References fedFileNamePtr(), and fedFileNameSize().

unsigned DtAssistantFederationStateMsg::fomModulesSize ( ) const

protectedvirtual

References DtNetAssistantFederationStateMsg::fomModulesSize, and netAssistantFederationStateMsg().

Referenced by federateTypesPtr(), getFomModules(), and setFomModules().

void DtAssistantFederationStateMsg::getConnection ( DtRtiConnectionInfo &  conn, const MAKRti::DtInetAddr &  address  ) const

virtual

Get the connection to be observed, setting the network interface address as given.

References addressFamily(), netAssistantFederationStateMsg(), DtRtiConnectionInfo::setBestEffortIp(), DtRtiConnectionInfo::setForwarderPort(), DtRtiConnectionInfo::setNetworkInterfaceAddr(), DtRtiConnectionInfo::setReliableIp(), DtRtiConnectionInfo::setTcpPort(), DtRtiConnectionInfo::setUdpPort(), DtRtiConnectionInfo::setUseRtiexec(), and tcpPort.

Referenced by printData(), and DtAssistantFederationsInfoMgr::processFederationStateMsg().

void DtAssistantFederationStateMsg::getFomModules ( std::list< MAKRti::DtString > &  fomModules ) const

virtual

Get the FOM Modules.

References fomModulesPtr(), and fomModulesSize().

Referenced by DtAssistantFederationsInfoMgr::processFederationStateMsg().

void DtAssistantFederationStateMsg::getUpdatedFederateStates ( DtFederateInfoByHandleMap &  federates, const MAKRti::DtString &  federation = MAKRti::DtString::nullString(), std::set< unsigned > *  notUpdated = 0  ) const

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.

References addressFamily(), DtAssistantMsg::compId(), constrainedPtr(), disconnectedPtr(), federateAstntCompIdsPtr(), federateConnIdsPtr(), federateContTestPtr(), federateHdlsPtr(), federateHostAddrsPtr(), federateHostNamesPtr(), federateNamesPtr(), federateNumInitiatedTestsPtr(), federateNumTestReportsPtr(), federateTestEnablePtr(), federateTestInProgressPtr(), federateTypesPtr(), federateWebServerAddrsPtr(), federateWebServerPortsPtr(), hlaVersionsPtr(), lbtsStringsPtr(), lookAheadStringsPtr(), numFederates(), reconnectingPtr(), regulatingPtr(), DtAssistantFederateInfo::setAssistantCompId(), DtAssistantFederateInfo::setConnId(), DtAssistantFederateInfo::setContinuousTest(), DtAssistantFederateInfo::setFederateHandle(), DtAssistantFederateInfo::setFederateHostAddr(), DtAssistantFederateInfo::setFederateHostName(), DtAssistantFederateInfo::setFederateName(), DtAssistantFederateInfo::setFederateType(), DtAssistantFederateInfo::setFederationName(), DtAssistantFederateInfo::setHeartbeated(), DtAssistantFederateInfo::setHlaVersion(), DtAssistantFederateInfo::setIsConstrained(), DtAssistantFederateInfo::setIsDisconnected(), DtAssistantFederateInfo::setIsReconnecting(), DtAssistantFederateInfo::setIsRegulating(), DtAssistantFederateInfo::setLbtsString(), DtAssistantFederateInfo::setLookAheadString(), DtAssistantFederateInfo::setNumInitiatedTests(), DtAssistantFederateInfo::setNumTestReports(), DtAssistantFederateInfo::setTestEnabled(), DtAssistantFederateInfo::setTestInProgress(), DtAssistantFederateInfo::setTimeString(), and timeStringsPtr().

Referenced by DtAssistantFederationsInfoMgr::processFederationStateMsg().

DtNetU8 * DtAssistantFederationStateMsg::hlaVersionsPtr ( )

protectedvirtual

Return pointer to the federates' HLA version location in message.

References constrainedPtr(), and numFederates().

Referenced by federationNamePtr(), getUpdatedFederateStates(), and setFederateStates().

const DtNetU8 * DtAssistantFederationStateMsg::hlaVersionsPtr ( ) const

protectedvirtual

References constrainedPtr(), and numFederates().

DtAssistantMsgKind DtAssistantFederationStateMsg::internalMsgKind ( )

protectedvirtual

Returns the kind of a DtAssistantFederationStateMsg message.

Implements DtAssistantMsg.

References DtAssistantFederationStateMsgKind.

Referenced by DtAssistantFederationStateMsg().

bool DtAssistantFederationStateMsg::isRemoval ( ) const

virtual

Get whether or not this federation is being removed.

References DtNetAssistantFederationStateMsg::isRemoval, and netAssistantFederationStateMsg().

Referenced by DtAssistantFederationsInfoMgr::processFederationStateMsg().

bool DtAssistantFederationStateMsg::isTestEnabled ( ) const

virtual

Get whether or not network testing is enabled.

References netAssistantFederationStateMsg(), and DtNetAssistantFederationStateMsg::testEnabled.

Referenced by printData(), and DtAssistantFederationsInfoMgr::processFederationStateMsg().

const char * DtAssistantFederationStateMsg::lbtsStringsPtr ( ) const

protectedvirtual

Return pointer to federate LBTS strings location in message.

References federateHostNamesPtr(), and federateHostNamesSize().

Referenced by getUpdatedFederateStates(), lookAheadStringsPtr(), and setFederateStates().

char * DtAssistantFederationStateMsg::lbtsStringsPtr ( )

protectedvirtual

References federateHostNamesPtr(), and federateHostNamesSize().

unsigned DtAssistantFederationStateMsg::lbtsStringsSize ( ) const

protectedvirtual

References DtNetAssistantFederationStateMsg::lbtsSize, and netAssistantFederationStateMsg().

Referenced by lookAheadStringsPtr(), and setFederateStates().

const char * DtAssistantFederationStateMsg::lookAheadStringsPtr ( ) const

protectedvirtual

Return pointer to federate look ahead strings location in message.

References lbtsStringsPtr(), and lbtsStringsSize().

Referenced by getUpdatedFederateStates(), setFederateStates(), and timeStringsPtr().

char * DtAssistantFederationStateMsg::lookAheadStringsPtr ( )

protectedvirtual

References lbtsStringsPtr(), and lbtsStringsSize().

unsigned DtAssistantFederationStateMsg::lookAheadStringsSize ( ) const

protectedvirtual

References DtNetAssistantFederationStateMsg::lookAheadSize, and netAssistantFederationStateMsg().

Referenced by setFederateStates(), and timeStringsPtr().

int DtAssistantFederationStateMsg::minSize ( ) const

protectedvirtual

Returns minimum size of a message, including header.

Referenced by DtAssistantFederationStateMsg().

DtNetAssistantFederationStateMsg * DtAssistantFederationStateMsg::netAssistantFederationStateMsg ( )

protectedvirtual

The network representation for the message.

Referenced by addressFamily(), clone(), federateHostAddrsPtr(), federateHostNamesSize(), federateNamesSize(), federateTypesSize(), federationHandle(), federationNameSize(), fedFileNameSize(), fomModulesSize(), getConnection(), isRemoval(), isTestEnabled(), lbtsStringsSize(), lookAheadStringsSize(), noFederations(), numFederates(), setAddressFamily(), setConnection(), setFederateHostNamesSize(), setFederateNamesSize(), setFederateTypesSize(), setFederationHandle(), setFederationNameSize(), setFedFileNameSize(), setFomModulesSize(), setIsRemoval(), setIsTestEnabled(), setLbtsStringsSize(), setLookAheadStringsSize(), setNoFederations(), setNumFederates(), setTimeStringsSize(), and timeStringsSize().

const DtNetAssistantFederationStateMsg * DtAssistantFederationStateMsg::netAssistantFederationStateMsg ( ) const

protectedvirtual

bool DtAssistantFederationStateMsg::noFederations ( ) const

virtual

Get whether this rtiexec has any federations.

References netAssistantFederationStateMsg(), and DtNetAssistantFederationStateMsg::noFederations.

Referenced by DtAssistantFederationsInfoMgr::processFederationStateMsg().

unsigned DtAssistantFederationStateMsg::numFederates ( ) const

protectedvirtual

References netAssistantFederationStateMsg(), and DtNetAssistantFederationStateMsg::numFederates.

Referenced by constrainedPtr(), disconnectedPtr(), federateAstntCompIdsPtr(), federateConnIdsPtr(), federateContTestPtr(), federateHdlsPtr(), federateNumInitiatedTestsPtr(), federateNumTestReportsPtr(), federateTestEnablePtr(), federateTestInProgressPtr(), federateWebServerAddrsPtr(), federateWebServerPortsPtr(), federationNamePtr(), getUpdatedFederateStates(), hlaVersionsPtr(), printData(), reconnectingPtr(), regulatingPtr(), and setFederateStates().

void DtAssistantFederationStateMsg::printData ( ) const

virtual

Print the data section.

Reimplemented from DtAssistantMsg.

References DtRtiConnectionInfo::defaultName(), federationHandle(), federationName(), fedFileName(), getConnection(), isTestEnabled(), and numFederates().

DtNetU8 * DtAssistantFederationStateMsg::reconnectingPtr ( )

protectedvirtual

Return pointer to the federates' reconnecting status location in message.

References federateContTestPtr(), and numFederates().

Referenced by disconnectedPtr(), getUpdatedFederateStates(), and setFederateStates().

const DtNetU8 * DtAssistantFederationStateMsg::reconnectingPtr ( ) const

protectedvirtual

References federateContTestPtr(), and numFederates().

DtNetU8 * DtAssistantFederationStateMsg::regulatingPtr ( )

protectedvirtual

Return pointer to the federates' regulating status location in message.

References disconnectedPtr(), and numFederates().

Referenced by constrainedPtr(), getUpdatedFederateStates(), and setFederateStates().

const DtNetU8 * DtAssistantFederationStateMsg::regulatingPtr ( ) const

protectedvirtual

References disconnectedPtr(), and numFederates().

void DtAssistantFederationStateMsg::removeCallback ( DtRtiAssistantServer *  conn, DtAssistantFederationStateCb  cb, void *  usr  )

static

References DtAssistantFederationStateMsgKind, and DtRtiAssistantServer::removeMsgCallback().

Referenced by DtAssistantFederationsInfoMgr::~DtAssistantFederationsInfoMgr().

void DtAssistantFederationStateMsg::removeCallback ( DtRtiAssistantPeer *  conn, DtAssistantFederationStateCb  cb, void *  usr  )

static

References DtAssistantFederationStateMsgKind, and DtRtiAssistantPeer::removeMsgCallback().

void DtAssistantFederationStateMsg::setAddressFamily ( DtInetUtils::DtInetAddrFamily  fam )

protectedvirtual

Get/set the address family for all of the federates in this federation.

References DtNetAssistantFederationStateMsg::addressFamily, and netAssistantFederationStateMsg().

Referenced by setFederateStates().

void DtAssistantFederationStateMsg::setConnection ( const DtRtiConnectionInfo &  conn )

virtual

Set the connection.

References DtNetAssistantFederationStateMsg::addressFamily, DtRtiConnectionInfo::bestEffortIp(), DtNetAssistantFederationStateMsg::bestEffortIpAddress, DtNetAssistantFederationStateMsg::forwarderPort, DtRtiConnectionInfo::forwarderPort(), netAssistantFederationStateMsg(), DtRtiConnectionInfo::reliableIp(), DtNetAssistantFederationStateMsg::reliableIpAddress, DtNetAssistantFederationStateMsg::tcpPort, DtRtiConnectionInfo::tcpPort(), DtNetAssistantFederationStateMsg::udpPort, DtRtiConnectionInfo::udpPort(), DtNetAssistantFederationStateMsg::useRtiexec, and DtRtiConnectionInfo::useRtiexec().

Referenced by DtRtiAssistantPeer::sendFederationStateMsg(), and DtRtiAssistantPeer::sendNoFederationMsg().

void DtAssistantFederationStateMsg::setFederateHostNamesSize ( unsigned  size )

protectedvirtual

Set/Get federate host names size.

References DtNetAssistantFederationStateMsg::federateHostNamesSize, and netAssistantFederationStateMsg().

Referenced by setFederateStates().

void DtAssistantFederationStateMsg::setFederateNamesSize ( unsigned  size )

protectedvirtual

Set/Get federate names size.

References DtNetAssistantFederationStateMsg::federateNamesSize, and netAssistantFederationStateMsg().

Referenced by setFederateStates().

void DtAssistantFederationStateMsg::setFederateStates ( const DtFederateInfoByHandleMap &  federates )

virtual

Set the states of all federates.

References constrainedPtr(), disconnectedPtr(), federateAstntCompIdsPtr(), federateConnIdsPtr(), federateContTestPtr(), federateHdlsPtr(), federateHostAddrsPtr(), federateHostNamesPtr(), federateHostNamesSize(), federateNamesPtr(), federateNamesSize(), federateNumInitiatedTestsPtr(), federateNumTestReportsPtr(), federateTestEnablePtr(), federateTestInProgressPtr(), federateTypesPtr(), federateTypesSize(), federateWebServerAddrsPtr(), federateWebServerPortsPtr(), hlaVersionsPtr(), rti1516e::insertBytes(), lbtsStringsPtr(), lbtsStringsSize(), lookAheadStringsPtr(), lookAheadStringsSize(), numFederates(), reconnectingPtr(), regulatingPtr(), setAddressFamily(), setFederateHostNamesSize(), setFederateNamesSize(), setFederateTypesSize(), setLbtsStringsSize(), setLookAheadStringsSize(), setNumFederates(), setTimeStringsSize(), timeStringsPtr(), and timeStringsSize().

Referenced by DtRtiAssistantExecClient::sendFederationStateMsg(), and DtRtiAssistantPeer::sendFederationStateMsg().

void DtAssistantFederationStateMsg::setFederateTypesSize ( unsigned  size )

protectedvirtual

Set/Get federate types size.

References DtNetAssistantFederationStateMsg::federateTypesSize, and netAssistantFederationStateMsg().

Referenced by setFederateStates().

void DtAssistantFederationStateMsg::setFederationHandle ( unsigned int  handle )

virtual

Set the federation handle.

References DtNetAssistantFederationStateMsg::federationHandle, and netAssistantFederationStateMsg().

Referenced by DtRtiAssistantExecClient::sendFederationStateMsg(), and DtRtiAssistantPeer::sendFederationStateMsg().

void DtAssistantFederationStateMsg::setFederationName ( const MAKRti::DtString &  name )

virtual

Set the federation name.

References federationNamePtr(), federationNameSize(), rti1516e::insertBytes(), and setFederationNameSize().

Referenced by DtRtiAssistantExecClient::sendFederationStateMsg(), and DtRtiAssistantPeer::sendFederationStateMsg().

void DtAssistantFederationStateMsg::setFederationNameSize ( unsigned  size )

protectedvirtual

Set/Get federation name size.

References DtNetAssistantFederationStateMsg::federationNameSize, and netAssistantFederationStateMsg().

Referenced by setFederationName().

void DtAssistantFederationStateMsg::setFedFileName ( const MAKRti::DtString &  name )

virtual

Set the FED file name.

References fedFileNamePtr(), fedFileNameSize(), rti1516e::insertBytes(), and setFedFileNameSize().

Referenced by DtRtiAssistantExecClient::sendFederationStateMsg(), and DtRtiAssistantPeer::sendFederationStateMsg().

void DtAssistantFederationStateMsg::setFedFileNameSize ( unsigned  size )

protectedvirtual

Set/Get FED file name size.

References DtNetAssistantFederationStateMsg::fedFileNameSize, and netAssistantFederationStateMsg().

Referenced by setFedFileName().

void DtAssistantFederationStateMsg::setFomModules ( const std::list< MAKRti::DtString > &  fomModules )

virtual

Set the FOM Modules.

References fomModulesPtr(), fomModulesSize(), rti1516e::insertBytes(), and setFomModulesSize().

Referenced by DtRtiAssistantExecClient::sendFederationStateMsg(), and DtRtiAssistantPeer::sendFederationStateMsg().

void DtAssistantFederationStateMsg::setFomModulesSize ( unsigned  size )

protectedvirtual

Set/Get FOM Modules size.

References DtNetAssistantFederationStateMsg::fomModulesSize, and netAssistantFederationStateMsg().

Referenced by setFomModules().

void DtAssistantFederationStateMsg::setIsRemoval ( bool  remove )

virtual

Set whether or not this federation is being removed.

References DtNetAssistantFederationStateMsg::isRemoval, and netAssistantFederationStateMsg().

Referenced by DtRtiAssistantExecClient::sendFederationStateMsg(), and DtRtiAssistantPeer::sendFederationStateMsg().

void DtAssistantFederationStateMsg::setIsTestEnabled ( bool  enabled )

virtual

Set whether or not network testing is enabled.

References netAssistantFederationStateMsg(), and DtNetAssistantFederationStateMsg::testEnabled.

Referenced by DtRtiAssistantExecClient::sendFederationStateMsg(), and DtRtiAssistantPeer::sendFederationStateMsg().

void DtAssistantFederationStateMsg::setLbtsStringsSize ( unsigned  size )

protectedvirtual

Set/Get the LBTS strings size.

References DtNetAssistantFederationStateMsg::lbtsSize, and netAssistantFederationStateMsg().

Referenced by setFederateStates().

void DtAssistantFederationStateMsg::setLookAheadStringsSize ( unsigned  size )

protectedvirtual

Set/Get the look ahead strings size.

References DtNetAssistantFederationStateMsg::lookAheadSize, and netAssistantFederationStateMsg().

Referenced by setFederateStates().

void DtAssistantFederationStateMsg::setNoFederations ( bool  val )

virtual

Set whether this rtiexec has any federations.

References netAssistantFederationStateMsg(), and DtNetAssistantFederationStateMsg::noFederations.

Referenced by DtRtiAssistantExecClient::sendFederationStateMsg(), DtRtiAssistantPeer::sendFederationStateMsg(), DtRtiAssistantExecClient::sendNoFederationMsg(), and DtRtiAssistantPeer::sendNoFederationMsg().

void DtAssistantFederationStateMsg::setNumFederates ( unsigned  num )

protectedvirtual

Get/set the number of federates included in this message.

References netAssistantFederationStateMsg(), and DtNetAssistantFederationStateMsg::numFederates.

Referenced by setFederateStates().

void DtAssistantFederationStateMsg::setTimeStringsSize ( unsigned  size )

protectedvirtual

Set/Get the time strings size.

References netAssistantFederationStateMsg(), and DtNetAssistantFederationStateMsg::timeSize.

Referenced by setFederateStates().

const char * DtAssistantFederationStateMsg::timeStringsPtr ( ) const

protectedvirtual

Return pointer to federate time strings location in message.

References lookAheadStringsPtr(), and lookAheadStringsSize().

Referenced by getUpdatedFederateStates(), and setFederateStates().

char * DtAssistantFederationStateMsg::timeStringsPtr ( )

protectedvirtual

References lookAheadStringsPtr(), and lookAheadStringsSize().

unsigned DtAssistantFederationStateMsg::timeStringsSize ( ) const

protectedvirtual

References netAssistantFederationStateMsg(), and DtNetAssistantFederationStateMsg::timeSize.

Referenced by setFederateStates().

---

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

• assistantFederationStateMsg.h
• assistantFederationStateMsg.cxx