Instances of DtSimpleFederateMgr process federation-level messages (such as create, destroy, join, resign, and sync points) for LRCs that are communicating peer to peer. More...

Inheritance diagram for DtSimpleFederateMgr:

Collaboration diagram for DtSimpleFederateMgr:

Public Member Functions
	DtSimpleFederateMgr (DtRIDParameters params, DtRtiAmbassadorBaseImplementor ambImplPtr, DtConnectionMgr *connMgr, DtBoost::shared_ptr< DtRtiAssistantLrcClient > assistantClient)
	Constructor.
virtual	~DtSimpleFederateMgr ()
	Destructor.
virtual void	testSaveProgress ()
	Test if save/restore in progress.
virtual void	mergeFomModules (const std::vector< MAKRti::DtString > &fomModules)
CreateDestoryJoinServices
Handle the create/destroy and join/resign services
virtual void	createFederationExecution (const char executionName, const char timeImplName, const char *fed)
	Process the create federation execution service.
virtual void	destroyFederationExecution (const char *executionName)
	Process the destroy federation execution service.
virtual RTI::FederateHandle	joinFederationExecution (const char federateType, const char executionName, RTI::FederateAmbassador *federateAmbassadorReference, unsigned long flags)
	Process the join federation execution service.
virtual void	resignFederationExecution (RTI::ResignAction theAction)
	Process the resign federation execution service.
SynchronizationPointServices
Handle the synchronization point services
virtual void	registerFederationSynchronizationPoint (char const label, char const theTag)
	Process the register synchronization point service.
virtual void	registerFederationSynchronizationPoint (char const label, char const theTag, DtFederateHandleSet const &syncSet)
	Process the register synchronization point service.
virtual void	synchronizationPointAchieved (const char *label, bool successfully=true)
	Process the synchronization point achieved service.
SaveRestoreServices
Process the save and restore services
virtual void	requestFederationSave (char const label, RTI::FedTime const time=NULL)
	Process request federation save.
virtual void	federateSaveBegun ()
	Process federate save begun.
virtual void	federateSaveComplete ()
	Process federate save complete.
virtual void	federateSaveNotComplete ()
	Process federate save complete.
virtual void	requestFederationRestore (const char *label)
	Process request federation restore.
virtual void	federateRestoreComplete ()
	Process federate restore complete.
virtual void	federateRestoreNotComplete ()
	Process federate restore complete.
Public Member Functions inherited from DtFederateMgr
virtual	~DtFederateMgr ()
	Destructor.
virtual bool	automaticReserveObjectName (const char *)
	HLA 1.3 does not have the ability to reserve an object name, so this function allows us to implici.
virtual void	waitForResignResponse (bool serviceCall=true)
	Wait for Resign Response.
virtual void	waitForReserveNameResponse (bool serviceCall=true)
	Wait for Resign Response.
virtual MAKRti::DtString	fedFileName (MAKRti::DtString execName)
	Return the .fed file name associated with the federation execution name.
virtual MAKRti::DtString	timeImplName (MAKRti::DtString execName)
	Return the time implementation name associated with the federation execution name.
virtual void	init ()
	Virtual initialization within create.
virtual bool	tick ()
	Update the state of the federation.
virtual void	pretick ()
virtual void	posttick ()
virtual void	postTickCallbacks ()
virtual void	addPostTickCallback (const MAKRti::DtString &label, const DtFedMgrPostTickCallbackInfo &cb)
virtual void	removePostTickCallback (const MAKRti::DtString &label)
virtual char *	getTransportationName (MAKRti::DtTransportType transport)
	Get transport name service.
virtual char *	getOrderName (MAKRti::DtOrderType order)
	Get order name service.
virtual MAKRti::DtTransportType	getTransportationHandle (MAKRti::DtString transport)
	Get transport handle service.
virtual MAKRti::DtOrderType	getOrderHandle (MAKRti::DtString order)
	Get order handle service.
virtual DtFederateHandle	federateHandle () const
	Get the federate handle.
virtual MAKRti::DtString const &	fedType () const
	Get the federate type.
virtual MAKRti::DtString const &	fedName () const
	Get the federate name (HLA Evolved)
virtual MAKRti::DtString const &	fedExName () const
	Get the federation execution name.
virtual unsigned long	fedExHandle () const
	Get the federation execution handle.
virtual bool	isJoined () const
	Return boolean: federate is joined?
virtual DtConnectionMgr *	connectMgr ()
	Access to the connection manager.
virtual DtConnectionMgr *	connectMgr () const
virtual DtRIDParameters *	params ()
	Access to the RID parameters.
virtual DtRIDParameters *	params () const
virtual DtFomClassMgr *	fom ()
	Access to the fom.
virtual DtFomClassMgr *	fom () const
virtual DtInteractionMgr *	interMgr ()
	Access to the interaction mgr.
virtual DtInteractionMgr *	interMgr () const
virtual DtTestManager *	testMgr ()
	Access to the test Manager.
virtual DtTestManager *	testMgr () const
virtual DtObjectMgr *	objMgr ()
	Access to the object mgr.
virtual DtObjectMgr *	objMgr () const
virtual DtLogicalTimeFactory *	timeFactory ()
	Access to the time factory.
virtual DtLogicalTimeFactory *	timeFactory () const
virtual DtRtiAssistantLrcClient *	assistantClient ()
	Access to the RTI Assistant client.
virtual DtRtiAssistantLrcClient *	assistantClient () const
virtual bool	isJoinedFederate (DtFederateHandle federateHandleValue) const
	Return bool: Is the federate handle known to be in the federation.
virtual bool	forcedToResign () const
	Return bool: Was federate forced to resign?
virtual void	setMomResign ()
	Marks that MOM is invoking resign.
virtual void	resetMomResign ()
	Unmark that MOM is invoking resign.
virtual bool	saveInitiated () const
	return bool: save initiated?
virtual bool	saveBegun () const
	return bool: save begun?
virtual bool	restoreRequested () const
	return bool: restore requested?
virtual bool	restoreInitiated () const
	return bool: restore initiated ?
virtual bool	restoreBegun () const
	return bool: restore begun?
virtual const MAKRti::DtString &	restoreLabel () const
	return current restore label
virtual const MAKRti::DtString &	lastRestoreLabel () const
	return last restore label
const MAKRti::DtString &	currentFedFileName () const
	get/set current FED file name
void	setCurrentFedFileName (const MAKRti::DtString &)
const MAKRti::DtString &	mimName () const
	get/set MIM name
void	setMimName (const MAKRti::DtString &)
const MAKRti::DtString &	currentTimeImplName () const
	get/set current time implementation name
void	setCurrentTimeImplName (const MAKRti::DtString &)
virtual const MAKRti::DtString &	saveLabel () const
	Set/Get save label.
virtual void	setSaveLabel (const MAKRti::DtString &value)
virtual const MAKRti::DtString &	lastSaveLabel () const
	Set/Get last save label.
virtual void	setLastSaveLabel (const MAKRti::DtString &value)
virtual void	initiateSave ()
	Perform the actual save possibly after waiting to enter time advancing state.
virtual void	initiateTimedSave (RTI::FedTime const &saveTime)
	Save is initiated possibly after waiting to enter time advancing state.
virtual bool	save (DtRtiSaveFile &file)
	Perform the actual save.
virtual bool	restore (DtRtiSaveFile &file)
	Perform the actual restore.
virtual MAKRti::DtString &	getSaveFileName (const char *label, DtFederateHandle fedHandle, MAKRti::DtString &fileName, bool extendName=true)
	Create a save file name from the label and return in supplied parameter.
virtual MAKRti::DtString &	getRestoreFileName (const char *label, DtFederateHandle fedHandle, MAKRti::DtString &fileName)
	Create a restore file name from the label and return in supplied parameter.
virtual unsigned long	tickCount () const
	Return the number of ticks.
virtual bool	isTicking () const
	Return true if currently processing tick.
virtual void	reportLatencyTestResults (const DtLatencyReportMsg &msg)
	Report results of a latency test.
virtual void	reportLatencyTestStatus (const DtTestMgrStatusMsg &msg)
	Report current latency test status.
unsigned long	flags () const
DtResignAction	automaticResignDirective () const
virtual const MAKRti::DtString &	getFederateNameFromHandle (DtFederateHandle handle)
	Get Federate Name / Handle from Handle / Name.
virtual DtFederateHandle	getFederateHandleFromName (const MAKRti::DtString &name)
virtual void	setTopLevelAmbassador (RTI::RTIambassador *ambPtr)
	Provide access to top level RTI Ambassador (and Federate Ambassador for 1516E)
RTI::RTIambassador *	rtiAmb ()
	Access to the top level RTI Ambassador given to the federate.
RTI::RTIambassador *	rtiAmb () const
	Access to the top level RTI Ambassador given to the federate.
virtual RTI::FederateAmbassador *	federateAmbassador () const
	Access to the Federate Ambassador submitted by the federate.

Static Public Member Functions
static DtFederateMgr *	create (DtRIDParameters params, DtRtiAmbassadorBaseImplementor ambImplPtr, DtConnectionMgr *connMgr, DtBoost::shared_ptr< DtRtiAssistantLrcClient > assistantClient)
	Creates an instance of this derived class;.
Static Public Member Functions inherited from DtFederateMgr
static void	setCreatorFunction (DtFederateMgrCreator fn)
	Register a creator function.
static void	setInternalCreatorFunction (DtFederateMgrCreator fn)
	Register alternate internal creators.

Protected Attributes
std::map< DtString, std::vector< DtString > >	myFederationsToCreateFomModulesMap
Protected Attributes inherited from DtFederateMgr
RTI::RTIambassador *	myRtiAmb
	The federate's RTI Ambassador.
DtRtiAmbassadorBaseImplementor *	myAmbImpl
	The federate's RTI Ambassador Implementor.
MAKRti::DtTime	myResponseInterval
	Interval to wait for response message during a message protocol.
MAKRti::DtString	myFedExName
	Federation execution name.
unsigned long	myFedExHandle
	Federation handle.
MAKRti::DtString	myFedType
	Federate type.
MAKRti::DtString	myFedName
	Federate name.
DtFederateHandle	myFedHandle
	Federate handle.
MAKRti::DtString	myCurrentFedFileName
	Current FED/FDD file name.
MAKRti::DtString	myMimName
	MIM name.
MAKRti::DtString	myCurrentTimeImplName
	Current time implementation name.
MAKRti::DtTime	myLastHeartbeat
	Time of last heartbeat.
DtLogicalTimeFactory *	myLogicalTimeFactory
	Logical time factory Even if NULL, need to have this factory.
RTI::FedTimeFactory	myHlaTimeFactory
DtFedAmbWrapper *	myPrinter
	Prints data for federate ambassador calls.
DtFedAmbWrapper *	myFedAmbCatch
	Catches exceptions from federate ambassador calls.
DtRIDParameters *	myParams
	Initialization data.
DtFedReader *	myFedReader
	Temporary internal reader used until changes made to VR-Link fed reader.
DtFedReader *	myFedReader13
DtFedReader *	myFedReader1516
DtFedReader *	myFedReader1516e
MAKRti::DtList	myMappingList
	List of federation execution names with FED files names and time implementation names.
std::map< MAKRti::DtString, std::set< MAKRti::DtString > >	myFedFileNames
std::map< MAKRti::DtString, DtFomClassMgr * >	myParsedFoms
	Map containing FOMs parsed into FedTargets.
DtBoost::shared_ptr < DtRtiAssistantLrcClient >	myAssistantClient
	Manages the connection to the RTI Assistant.
bool	myIgnoreForcedResign
	Prevents forcing duplicate resign.
bool	myForcedToResign
	Indicates forced resign occurred.
bool	myMomResign
	Indicates MOM caused resign.
bool	myMomSaveEvokeCallbacks
	State of evoking callbacks prior to MOM resign.
bool	myResignInProgress
	Indicates a resign is in progress.
MAKRti::DtClock	myClock
	Clock for timing.
unsigned long	myTickCount
	Tick counter.
bool	myIsTicking
	indicates currently processing tick
bool	myEnableFederateHeartbeat
	is heartbeating enabled?
unsigned long	myFlags
DtTestManager *	myTestMgr
bool	myNetworkTestEnabled
float	mySignalTickInterval
	The Signal Tick Interval.
DtTime	myLastTickTime
	The last tick time.
DtPostTickCallbackMap	myPostTickCallbacks
MAKRti::DtFilename	myStandardMimPath
std::map< MAKRti::DtString, DtFederateHandle >	myFederateNameToHandle
std::map< DtFederateHandle, MAKRti::DtString >	myFederateHandleToName
MAKRti::DtResignAction	myResignAction
	The resign action.
DtConnectionMgr *	myConnectMgr
	The connection manager.
DtFomClassMgr *	myFom
	The FOM manager.
DtInteractionMgr *	myInterMgr
	The interaction manager.
DtObjectMgr *	myObjMgr
	The object manager.
DtMomMgr *	myMomMgr
	The MOM manager.
bool	mySaveInitiated
	Indicates save initiated.
bool	mySaveBegun
	Indicates save begun.
bool	myRestoreRequested
	Indicates restore requested.
bool	myRestoreInitiated
	Indicates restore initiated.
bool	myRestoreBegun
	Indicates restore begun.
MAKRti::DtString	mySaveLabel
	The save label.
MAKRti::DtString	myLastSaveLabel
	The last save label.
MAKRti::DtString	myRestoreLabel
	The restore label.
MAKRti::DtString	myLastRestoreLabel
	The last restore label.

Private Member Functions
	DtSimpleFederateMgr (DtFederateMgr const &)
	Copy Constructor not implemented – Copy Not Allowed!
DtSimpleFederateMgr &	operator= (DtSimpleFederateMgr const &)
	Assignment not implemented – Assignment Not Allowed!

Additional Inherited Members
Public Types inherited from DtFederateMgr
typedef DtFederateMgr (	DtFederateMgrCreator )(DtRIDParameters ridParams, DtRtiAmbassadorBaseImplementor ambImplPtr, DtConnectionMgr *connMgr, DtBoost::shared_ptr< DtRtiAssistantLrcClient > assistantClient)
	Federate manager creator.
typedef void(*	DtFedMgrPostTickCallbackFcn )(void *)
typedef std::pair < DtFedMgrPostTickCallbackFcn, void * >	DtFedMgrPostTickCallbackInfo
typedef std::map < MAKRti::DtString, DtFedMgrPostTickCallbackInfo >	DtPostTickCallbackMap
Public Attributes inherited from DtFederateMgr
bool	myFedCallbackReached
Protected Member Functions inherited from DtFederateMgr
	DtFederateMgr (DtRIDParameters params, DtRtiAmbassadorBaseImplementor ambImplPtr, DtConnectionMgr *connMgr, DtBoost::shared_ptr< DtRtiAssistantLrcClient > assistantClient)
	Constructor.
virtual void	sendAlive ()
	Send the alive message.
virtual void	sendResignMsg (const char *fedExName, DtFederateHandle fedHandle, DtResignAction action)
	Send the resign message.
void	sendTickedMsg ()
	Send the signal ticked message.
virtual void	applyRidParameters ()
	Apply RID parameters.
virtual MAKRti::DtFilename	fedFileNameToUse (MAKRti::DtString fileName, MAKRti::DtString executionName)
	Utility function, finds fed file name to use based on fed file name and exeution name.
virtual void	testReadFedFile (MAKRti::DtString fileName, MAKRti::DtString executionName)
	Attempts to read a fed file but does not fill in the fom class.
virtual void	readFedFile (MAKRti::DtString fileName, MAKRti::DtString executionName)
	Reads a FED file into a DtFomClassMgr object.
virtual void	readFedFilePtr (const FILE *fp, const MAKRti::DtString &fileName, const MAKRti::DtString &executionName)
	Reads a FED file into a DtFomClassMgr object.
virtual void	addFedExNameMapping (const MAKRti::DtString &execName, const MAKRti::DtString &timeImplName, const MAKRti::DtString &fed)
	Add mapping between federation execution name, time Impl Name and fed file name.
virtual void	addFomModuleNameMapping (const MAKRti::DtString executionName, const std::vector< MAKRti::DtString > &modules)
virtual void	addFomModuleNameMapping (const MAKRti::DtString executionName, const MAKRti::DtString &modules)
virtual DtResignAction	testResign (RTI::ResignAction theAction)
	Test the resign action and return the internal representation.
virtual void	postJoinInit (const char federateType, const char executionName, const char federateName, RTI::FederateAmbassador federateAmbassadorReference)
	Uses the given information to initialize federate data.
virtual void	postJoinConfirmInit ()
virtual MAKRti::DtResignAction	convertResignAction (RTI::ResignAction) const
virtual RTI::ResignAction	convertResignAction (MAKRti::DtResignAction) const
DtFedReader *	getReader (DtFomType theFomType, DtFomClassMgr *target)
DtFedReader *	getReader (DtFomType theFomType)
void	addToParsedFomMap (DtFedReader myFedReader, const MAKRti::DtString &fileNameToUse, DtFomClassMgr fedTarget, unsigned long theCrc=0)
MAKRti::DtFilename &	getStandardMimPath ()
virtual void	processResign (const DtResignMsg &msg)
	Process resign message.
virtual void	processEnableDisableNetworkTesting (const DtEnableDisableNetworkTestingMsg &msg)
	disable network testing
virtual void	processSaveInitiate (const DtSaveInitiateMsg &msg)
	Process save initiate message.
virtual void	processSaveResponse (const DtSaveResponseMsg &msg)
	Process save resonse message.
virtual void	processSaveFinished (const DtSaveFinishedMsg &msg)
	Process save finished message.
virtual void	processRestoreReply (const DtRestoreReplyMsg &msg)
	Process restore reply message.
virtual void	processRestoreInitiate (const DtRestoreInitiateMsg &msg)
	Process restore initiate message.
virtual void	processRestoreEnd (const DtRestoreEndMsg &msg)
	Process restore end message.
virtual void	processRestore (const DtRestoreMsg &msg)
	Process restore message.
virtual void	processAssistantResign (const DtAssistantExitMsg &msg)
	Process resign message from Assistant.
virtual void	processAssistantEnableLogging (const DtAssistantLogEnableMsg &msg)
	Process resign message from Assistant.
virtual void	processSignalTickInterval (const DtAssistantFederateSignalTickIntervalMsg &msg)
	Process a change in the interval at which a federate is expected to tick.
virtual void	processRidParamRequest (const DtAssistantRidParamsMsg &msg)
	Process a RID parameter request from the Assistant.
virtual void	createObjectMgr ()
	Create the Object Manager.
virtual void	createInteractionMgr ()
	Create the Interaction Manager.
virtual void	createDdmMgr ()
	Create the DDM Manager.
virtual void	createTimeMgr ()
	Create the Time manager.
virtual void	createMomMgr ()
	Create the MOM Manager.
virtual void	createTestMgr ()
	Create the test Manager.
Static Protected Member Functions inherited from DtFederateMgr
static void	processResign (const DtResignMsg &msg, void *usr)
	resign message callback
static void	processEnableDisableNetworkTesting (const DtEnableDisableNetworkTestingMsg &msg, void *usr)
	process enable / disable network testing callback
static void	processSaveInitiate (const DtSaveInitiateMsg &msg, void *usr)
	save initiate message callback
static void	processSaveResponse (const DtSaveResponseMsg &msg, void *usr)
	save response message callback
static void	processSaveFinished (const DtSaveFinishedMsg &msg, void *usr)
	save finished message callback
static void	processRestoreReply (const DtRestoreReplyMsg &msg, void *usr)
	restore reply message callback
static void	processRestore (const DtRestoreMsg &msg, void *usr)
	restore message callback
static void	processRestoreInitiate (const DtRestoreInitiateMsg &msg, void *usr)
	restore initiate message callback
static void	processRestoreEnd (const DtRestoreEndMsg &msg, void *usr)
	restore end message callback
static void	processAssistantResign (const DtAssistantExitMsg &msg, void *usr)
	Assistant resign message callback.
static void	processAssistantEnableLogging (const DtAssistantLogEnableMsg &msg, void *usr)
	Assistant logging enable message callback.
static void	processSignalTickInterval (const DtAssistantFederateSignalTickIntervalMsg &msg, void *usr)
	Assistant signal tick interval message callback.
static void	processRidParamRequest (const DtAssistantRidParamsMsg &msg, void *usr)
	Assistant RID parameter request message callback.
Static Protected Attributes inherited from DtFederateMgr
static DtFederateMgrCreator	theCreator
	The plugin creator.
static DtFederateMgrCreator	theInternalCreator
	The internal creator.

Detailed Description

Instances of DtSimpleFederateMgr process federation-level messages (such as create, destroy, join, resign, and sync points) for LRCs that are communicating peer to peer.

It also manages the objects responsible for handling general communication, objects, interactions, the FOM, MOM, and data distribution mmg. Override this class if you want to change how federation-level messages get processed. To inspect federation data, users can obtain a pointer to an instance of this class through the RTI's DtRtiAmbassadorImplementor instance.

Constructor & Destructor Documentation

DtSimpleFederateMgr::DtSimpleFederateMgr	(	DtRIDParameters *	params,
		DtRtiAmbassadorBaseImplementor *	ambImplPtr,
		DtConnectionMgr *	connMgr,
		DtBoost::shared_ptr< DtRtiAssistantLrcClient >	assistantClient
	)

Constructor.

virtual DtSimpleFederateMgr::~DtSimpleFederateMgr ( )

virtual

Destructor.

DtSimpleFederateMgr::DtSimpleFederateMgr ( DtFederateMgr const & )

private

Copy Constructor not implemented – Copy Not Allowed!

Member Function Documentation

static DtFederateMgr* DtSimpleFederateMgr::create	(	DtRIDParameters *	params,
		DtRtiAmbassadorBaseImplementor *	ambImplPtr,
		DtConnectionMgr *	connMgr,
		DtBoost::shared_ptr< DtRtiAssistantLrcClient >	assistantClient
	)

static

Creates an instance of this derived class;.

Reimplemented from DtFederateMgr.

virtual void DtSimpleFederateMgr::createFederationExecution	(	const char *	executionName,
		const char *	timeImplName,
		const char *	fed
	)

virtual

Process the create federation execution service.

Implements DtFederateMgr.

virtual void DtSimpleFederateMgr::destroyFederationExecution ( const char * executionName )

virtual

Process the destroy federation execution service.

Implements DtFederateMgr.

virtual void DtSimpleFederateMgr::federateRestoreComplete ( )

virtual

Process federate restore complete.

Implements DtFederateMgr.

virtual void DtSimpleFederateMgr::federateRestoreNotComplete ( )

virtual

Process federate restore complete.

Implements DtFederateMgr.

virtual void DtSimpleFederateMgr::federateSaveBegun ( )

virtual

Process federate save begun.

Implements DtFederateMgr.

virtual void DtSimpleFederateMgr::federateSaveComplete ( )

virtual

Process federate save complete.

Implements DtFederateMgr.

virtual void DtSimpleFederateMgr::federateSaveNotComplete ( )

virtual

Process federate save complete.

Implements DtFederateMgr.

virtual RTI::FederateHandle DtSimpleFederateMgr::joinFederationExecution	(	const char *	federateType,
		const char *	executionName,
		RTI::FederateAmbassador *	federateAmbassadorReference,
		unsigned long	flags
	)

virtual

Process the join federation execution service.

Implements DtFederateMgr.

virtual void DtSimpleFederateMgr::mergeFomModules ( const std::vector< MAKRti::DtString > & fomModules )

virtual

DtSimpleFederateMgr& DtSimpleFederateMgr::operator= ( DtSimpleFederateMgr const & )

private

Assignment not implemented – Assignment Not Allowed!

virtual void DtSimpleFederateMgr::registerFederationSynchronizationPoint	(	char const *	label,
		char const *	theTag
	)

virtual

Process the register synchronization point service.

Implements DtFederateMgr.

virtual void DtSimpleFederateMgr::registerFederationSynchronizationPoint	(	char const *	label,
		char const *	theTag,
		DtFederateHandleSet const &	syncSet
	)