DtAssistantFederationInfo Class Reference

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

void DtAssistantFederationInfo::clearFederates

(

)

Clears all federates from the federation.

void DtAssistantFederationInfo::enableTesting ( bool  enabled )

inline

const DtAssistantFederateInfo* DtAssistantFederationInfo::federateInfo

(

unsigned

handle

)

const

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

DtAssistantFederateInfo* DtAssistantFederationInfo::federateInfo

(

unsigned

handle

)

const DtFederateInfoByHandleMap* DtAssistantFederationInfo::federates ( ) const

inline

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

DtFederateInfoByHandleMap* DtAssistantFederationInfo::federates ( )

inline

int DtAssistantFederationInfo::federationHandle ( ) const

inline

const MAKRti::DtString& DtAssistantFederationInfo::federationName ( ) const

inline

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

inline

bool DtAssistantFederationInfo::heartbeated ( ) const

inline

int DtAssistantFederationInfo::localFederateCompId

(

int

federateHandle

)

const

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

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

unsigned DtAssistantFederationInfo::numFederates ( ) const

inline

Returns the number of federates in the federation.

unsigned DtAssistantFederationInfo::numLocalFederates ( ) const

inline

Returns the number of local federates in the federation.

bool DtAssistantFederationInfo::removeFederate

(

int

handle

)

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

void DtAssistantFederationInfo::removeSyncPoint ( const MAKRti::DtString &  name )

inline

Removes a sync point.

void DtAssistantFederationInfo::replaceFederateList

(

const DtFederateInfoByHandleMap &

federates

)

Replaces the existing federate list with the new one.

Existing federates not in the list will be removed.

void DtAssistantFederationInfo::setFederationHandle ( int  val )

inline

void DtAssistantFederationInfo::setFederationName ( const MAKRti::DtString &  val )

inline

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

inline

void DtAssistantFederationInfo::setHeartbeated ( bool  hb )

inline

Set/Get whether this federation has been heartbeated.

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

inline

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

const DtSyncPtToAchievedFederatesMap* DtAssistantFederationInfo::syncPoints ( ) const

inline

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

bool DtAssistantFederationInfo::testingEnabled ( ) const

inline

bool DtAssistantFederationInfo::updateFederate

(

const DtAssistantFederateInfo &

federate

)

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

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.

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

Updates a sync points. Adds if not present.

Member Data Documentation

DtFederateInfoByHandleMap DtAssistantFederationInfo::myFederates

protected

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.

std::map< int, int > DtAssistantFederationInfo::myLocalFederatesByHandle

protected

Local federate component IDs by federate handle.

DtSyncPtToAchievedFederatesMap DtAssistantFederationInfo::mySyncPts

protected

bool DtAssistantFederationInfo::myTestEnabled

protected

---

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

• federationInfo.h