Structure containing State information from a single federation. More...

Collaboration diagram for DtAssistantFederationInfo:

Public Member Functions
	DtAssistantFederationInfo (const MAKRti::DtString &name=MAKRti::DtString::nullString(), int handle=-1, const std::list< MAKRti::DtString > &files=std::list< MAKRti::DtString >(), bool testEn=true)
void	setFederationName (const MAKRti::DtString &val)
const MAKRti::DtString &	federationName () const
void	setFederationHandle (int val)
int	federationHandle () const
void	addFomModule (const MAKRti::DtString &module)
void	setFomModules (const std::list< MAKRti::DtString > &modules)
const std::list < MAKRti::DtString > *	fomModules () const
void	enableTesting (bool enabled)
bool	testingEnabled () const
bool	updateFederates (const DtFederateInfoByHandleMap &federates)
	Updates or adds federates from given list.
bool	updateFederate (const DtAssistantFederateInfo &federate)
	Updates or adds a single federate. Returns true if list was updated.
void	replaceFederateList (const DtFederateInfoByHandleMap &federates)
	Replaces the existing federate list with the new one.
bool	removeFederate (int handle)
	Removes a federate from the federation, returns true if it was removed.
void	clearFederates ()
	Clears all federates from the federation.
const DtAssistantFederateInfo *	federateInfo (unsigned handle) const
	Gets the federate info for a federate with the given handle.
DtAssistantFederateInfo *	federateInfo (unsigned handle)
const DtFederateInfoByHandleMap *	federates () const
	Returns a pointer to the map of federate info by handle.
DtFederateInfoByHandleMap *	federates ()
unsigned	numFederates () const
	Returns the number of federates in the federation.
unsigned	numLocalFederates () const
	Returns the number of local federates in the federation.
int	localFederateCompId (int federateHandle) const
	Returns the local component ID if the federate is local, otherwise -1.
int	localFederateHandle (int compId) const
	Returns the federate handle if the federate with the specified local component ID is in this federation, otherwise -1;.
void	updateSyncPoint (const MAKRti::DtString &name, const DtPendingAchievedPair &pendAchv)
	Updates a sync points. Adds if not present.
void	removeSyncPoint (const MAKRti::DtString &name)
	Removes a sync point.
DtPendingAchievedPair *	syncPoint (const MAKRti::DtString &name)
	Gets a pointer to the pending and achieved federates for the given sync point.
const DtSyncPtToAchievedFederatesMap *	syncPoints () const
	Returns a pointer to the map of federate info by handle.
void	setHeartbeated (bool hb)
	Set/Get whether this federation has been heartbeated.
bool	heartbeated () const
Protected Attributes
MAKRti::DtString	myFederationName
int	myFederationHandle
std::list< MAKRti::DtString >	myFomModuleNames
bool	myTestEnabled
DtFederateInfoByHandleMap	myFederates
DtSyncPtToAchievedFederatesMap	mySyncPts
bool	myHeartbeated
std::map< int, int >	myLocalFederatesByHandle
	Local federate component IDs by federate handle.
std::map< int, int >	myLocalFederatesByCompId
	Local federate handles by component ID.

Detailed Description

Structure containing State information from a single federation.

Constructor & Destructor Documentation

DtAssistantFederationInfo::DtAssistantFederationInfo	(	const MAKRti::DtString &	name = `MAKRti::DtString::nullString()`,
		int	handle = `-1`,
		const std::list< MAKRti::DtString > &	files = `std::list<MAKRti::DtString>()`,
		bool	testEn = `true`
	)

Member Function Documentation

void DtAssistantFederationInfo::addFomModule ( const MAKRti::DtString & module ) [inline]

Referenced by DtRtiexecObserverForAssistant::processFederateJoinedEvent(), and DtRtiexecObserverForAssistant::processFedExCreatedEvent().

void DtAssistantFederationInfo::clearFederates ( )

Clears all federates from the federation.

References myFederates, myLocalFederatesByCompId, and myLocalFederatesByHandle.

void DtAssistantFederationInfo::enableTesting ( bool enabled ) [inline]

Referenced by DtAssistantFederationsInfoMgr::processFederationStateMsg(), DtRtiexecObserverForAssistant::processFedExCreatedEvent(), and DtAssistantFederationsInfoMgr::processLocalFederateJoined().

const DtAssistantFederateInfo * DtAssistantFederationInfo::federateInfo ( unsigned handle ) const

Gets the federate info for a federate with the given handle.

References myFederates.

Referenced by DtAssistantFederationsInfoMgr::federateInfo(), DtRtiexecObserverForAssistant::processFederateDisconnectedEvent(), DtRtiexecObserverForAssistant::processFederateReconnectFailedEvent(), DtRtiexecObserverForAssistant::processFederateReconnectSucceededEvent(), DtRtiexecObserverForAssistant::processFederateResignedEvent(), DtRtiexecObserverForAssistant::processLatencyTestStatusMsg(), and DtRtiexecObserverForAssistant::processTimeStateEvent().

DtAssistantFederateInfo * DtAssistantFederationInfo::federateInfo ( unsigned handle )

References myFederates.

const DtFederateInfoByHandleMap* DtAssistantFederationInfo::federates ( ) const [inline]

Returns a pointer to the map of federate info by handle.

Referenced by DtAssistantFederationsInfoMgr::federates(), DtRtiexecObserverForAssistant::processDeleteFederateMsg(), DtRtiexecObserverForAssistant::processDeleteFederationMsg(), DtAssistantFederationsInfoMgr::pruneStaleFederationsAndObservers(), replaceFederateList(), DtAssistantFederationsInfoMgr::sendAllFederationInfo(), DtRtiAssistantExecClient::sendExecStateMsg(), DtRtiAssistantExecClient::sendFederationStateMsg(), DtRtiAssistantPeer::sendFederationStateMsg(), DtRtiAssistantExecClient::sendFederationTimeStateMsg(), DtRtiFederationWidget::update(), and DtFederateTree::updateFederation().

DtFederateInfoByHandleMap* DtAssistantFederationInfo::federates ( ) [inline]

int DtAssistantFederationInfo::federationHandle ( ) const [inline]

Referenced by DtFederationsViewDialog::addFederationWidget(), DtAssistantFederationsViewMgr::destroyFederation(), DtRtiexecObserverForAssistant::processFedExCreatedEvent(), DtAssistantFederationsViewMgr::resignFederate(), DtAssistantFederationsInfoMgr::sendAllFederationInfo(), DtRtiAssistantExecClient::sendExecStateMsg(), DtRtiAssistantExecClient::sendFederationStateMsg(), DtRtiAssistantPeer::sendFederationStateMsg(), DtAssistantFederationsViewMgr::sendNetworkTestingDisableMsg(), DtAssistantFederationsViewMgr::sendNetworkTestingEnableMsg(), DtAssistantFederationsViewMgr::showLatencyTestDialog(), DtRtiFederationWidget::update(), and DtFederateTree::updateFederation().

const MAKRti::DtString& DtAssistantFederationInfo::federationName ( ) const [inline]

Referenced by DtFederationsViewDialog::addFederationWidget(), DtAssistantFederationsInfoMgr::processFederationStateMsg(), DtRtiexecObserverForAssistant::processFedExCreatedEvent(), DtAssistantFederationsInfoMgr::processLocalFederateResigned(), DtAssistantFederationsInfoMgr::pruneStaleFederationsAndObservers(), DtAssistantFederationsInfoMgr::sendAllFederationInfo(), DtRtiAssistantExecClient::sendExecStateMsg(), DtRtiAssistantExecClient::sendFederationStateMsg(), DtRtiAssistantPeer::sendFederationStateMsg(), DtRtiAssistantExecClient::sendFederationTimeStateMsg(), DtAssistantFederationsInfoMgr::tick(), DtRtiFederationWidget::update(), DtFederateTree::updateFederation(), and DtFederationsViewDialog::updateFederation().

const std::list<MAKRti::DtString>* DtAssistantFederationInfo::fomModules ( ) const [inline]

Referenced by DtRtiexecObserverForAssistant::processFederateJoinedEvent(), DtAssistantFederationsInfoMgr::sendAllFederationInfo(), DtRtiAssistantExecClient::sendFederationStateMsg(), DtRtiAssistantPeer::sendFederationStateMsg(), and DtRtiFederationWidget::update().

bool DtAssistantFederationInfo::heartbeated ( ) const [inline]

Referenced by DtAssistantFederationsInfoMgr::pruneStaleFederationsAndObservers().

int DtAssistantFederationInfo::localFederateCompId ( int federateHandle ) const

Returns the local component ID if the federate is local, otherwise -1.

References myLocalFederatesByHandle.

Referenced by DtAssistantFederationsViewMgr::showLatencyTestDialog().

int DtAssistantFederationInfo::localFederateHandle ( int compId ) const

Returns the federate handle if the federate with the specified local component ID is in this federation, otherwise -1;.

References myLocalFederatesByCompId.

unsigned DtAssistantFederationInfo::numFederates ( ) const [inline]

Returns the number of federates in the federation.

Referenced by DtAssistantFederationsInfoMgr::processLocalFederateResigned(), and DtRtiFederationWidget::update().

unsigned DtAssistantFederationInfo::numLocalFederates ( ) const [inline]

Returns the number of local federates in the federation.

Referenced by DtAssistantFederationsInfoMgr::pruneStaleFederationsAndObservers().

bool DtAssistantFederationInfo::removeFederate ( int handle )

Removes a federate from the federation, returns true if it was removed.

References myFederates, myLocalFederatesByCompId, and myLocalFederatesByHandle.

Referenced by DtRtiexecObserverForAssistant::processFederateResignedEvent(), DtAssistantFederationsInfoMgr::processLocalFederateResigned(), and DtAssistantFederationsInfoMgr::pruneStaleFederationsAndObservers().

void DtAssistantFederationInfo::removeSyncPoint ( const MAKRti::DtString & name ) [inline]

Removes a sync point.

Referenced by DtRtiexecObserverForAssistant::processFederationSynchronizedEvent().

void DtAssistantFederationInfo::replaceFederateList ( const DtFederateInfoByHandleMap & federates )

Replaces the existing federate list with the new one.

Existing federates not in the list will be removed.

References federates(), and myFederates.

Referenced by DtAssistantFederationsInfoMgr::processFederationStateMsg().

void DtAssistantFederationInfo::setFederationHandle ( int val ) [inline]

Referenced by DtAssistantFederationsInfoMgr::processFederationStateMsg(), and DtRtiexecObserverForAssistant::processFedExCreatedEvent().

void DtAssistantFederationInfo::setFederationName ( const MAKRti::DtString & val ) [inline]

Referenced by DtAssistantFederationsInfoMgr::processFederationStateMsg(), and DtRtiexecObserverForAssistant::processFedExCreatedEvent().

void DtAssistantFederationInfo::setFomModules ( const std::list< MAKRti::DtString > & modules ) [inline]

Referenced by DtAssistantFederationsInfoMgr::processFederationStateMsg().

void DtAssistantFederationInfo::setHeartbeated ( bool hb ) [inline]

Set/Get whether this federation has been heartbeated.

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

DtPendingAchievedPair* DtAssistantFederationInfo::syncPoint ( const MAKRti::DtString & name ) [inline]

Gets a pointer to the pending and achieved federates for the given sync point.

Referenced by DtRtiexecObserverForAssistant::processExecObserveMsg(), DtRtiexecObserverForAssistant::processFederationSynchronizedEvent(), DtRtiexecObserverForAssistant::processSyncPtAchievedEvent(), and DtRtiexecObserverForAssistant::processSyncPtRegisteredEvent().

const DtSyncPtToAchievedFederatesMap* DtAssistantFederationInfo::syncPoints ( ) const [inline]

Returns a pointer to the map of federate info by handle.

Referenced by DtRtiFederationWidget::update().

bool DtAssistantFederationInfo::testingEnabled ( ) const [inline]

Referenced by DtAssistantFederationsInfoMgr::sendAllFederationInfo(), DtRtiAssistantExecClient::sendFederationStateMsg(), DtRtiAssistantPeer::sendFederationStateMsg(), DtRtiFederationWidget::update(), and DtFederateTree::updateFederation().

bool DtAssistantFederationInfo::updateFederate ( const DtAssistantFederateInfo & federate )

Updates or adds a single federate. Returns true if list was updated.

References DtAssistantFederateInfo::federateHandle(), DtAssistantFederateInfo::localCompId(), myFederates, myLocalFederatesByCompId, and myLocalFederatesByHandle.

Referenced by DtRtiexecObserverForAssistant::processFederateDisconnectedEvent(), DtRtiexecObserverForAssistant::processFederateJoinedEvent(), DtRtiexecObserverForAssistant::processFederateReconnectFailedEvent(), DtRtiexecObserverForAssistant::processFederateReconnectSucceededEvent(), and DtRtiexecObserverForAssistant::processTimeStateEvent().

bool DtAssistantFederationInfo::updateFederates ( const DtFederateInfoByHandleMap & federates )

Updates or adds federates from given list.

Existing federates not in the list remain the same. Returns true if list was updated.

References myFederates.

Referenced by DtAssistantFederationsInfoMgr::processFederationStateMsg().

void DtAssistantFederationInfo::updateSyncPoint	(	const MAKRti::DtString &	name,
		const DtPendingAchievedPair &	pendAchv
	)

Updates a sync points. Adds if not present.

References mySyncPts.

Referenced by DtRtiexecObserverForAssistant::processSyncPtRegisteredEvent().

Member Data Documentation

DtFederateInfoByHandleMap DtAssistantFederationInfo::myFederates [protected]

Referenced by clearFederates(), federateInfo(), removeFederate(), replaceFederateList(), updateFederate(), and updateFederates().

int DtAssistantFederationInfo::myFederationHandle [protected]

MAKRti::DtString DtAssistantFederationInfo::myFederationName [protected]

std::list<MAKRti::DtString> DtAssistantFederationInfo::myFomModuleNames [protected]

bool DtAssistantFederationInfo::myHeartbeated [protected]

std::map< int, int > DtAssistantFederationInfo::myLocalFederatesByCompId [protected]

Local federate handles by component ID.

Referenced by clearFederates(), localFederateHandle(), removeFederate(), and updateFederate().

std::map< int, int > DtAssistantFederationInfo::myLocalFederatesByHandle [protected]

Local federate component IDs by federate handle.

Referenced by clearFederates(), localFederateCompId(), removeFederate(), and updateFederate().

DtSyncPtToAchievedFederatesMap DtAssistantFederationInfo::mySyncPts [protected]

Referenced by updateSyncPoint().

bool DtAssistantFederationInfo::myTestEnabled [protected]

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation