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, std::shared_ptr< DtRtiAssistantLrcClient > assistantClient)
	Constructor. More...

virtual	~DtSimpleFederateMgr ()
	Destructor. More...

virtual void	testSaveProgress () const
	Test if save/restore in progress. More...

virtual void	addNonDuplicateFoms (std::vector< MAKRti::DtString > &fomModules, const std::vector< MAKRti::DtString > &fomModulesToAdd)

CreateDestoryJoinServices
Handle the create/destroy and join/resign services
virtual void	createFederationExecution (const char executionName, const char timeImplName, const std::vector< DtString > &fomModules, const char *mimModule)
	Process the create federation execution service. More...

virtual void	destroyFederationExecution (const char *executionName)
	Process the destroy federation execution service. More...

virtual void	listFederationExecutions () const
	List the federation executions. More...

virtual void	listFederationMembers (DtString const &federationName) const
	List the list of federates in the joined federation execution. More...

virtual RTI_API::FederateHandle	joinFederationExecution (const char federateName, const char federateType, const char *executionName, const std::vector< DtString > &fomModules, unsigned long flags)
	Process the join federation execution service. More...

virtual void	resignFederationExecution (RTI_API::ResignAction theAction)
	Process the resign federation execution service. More...

SynchronizationPointServices
Handle the synchronization point services
virtual void	registerFederationSynchronizationPoint (char const *label, DtRtiApiTagConstRef theTag)
	Process the register synchronization point service. More...

virtual void	registerFederationSynchronizationPoint (char const *label, DtRtiApiTagConstRef theTag, DtFederateHandleSet const &syncSet)
	Process the register synchronization point service. More...

virtual void	synchronizationPointAchieved (const char *label, bool successfully=true)
	Process the synchronization point achieved service. More...

SaveRestoreServices
Process the save and restore services
virtual void	requestFederationSave (char const label, DtRtiApiTime const time=NULL)
	Process request federation save. More...

virtual void	queryFederationSaveStatus ()
	Process query federation save status. More...

virtual void	queryFederationRestoreStatus ()
	Process query federation restore status. More...

virtual void	abortFederationSave ()
	Process the abort federation save service. More...

virtual void	abortFederationRestore ()
	Process the abort federation restore service. More...

virtual void	federateSaveBegun ()
	Process federate save begun. More...

virtual void	federateSaveComplete ()
	Process federate save complete. More...

virtual void	federateSaveNotComplete ()
	Process federate save complete. More...

virtual void	requestFederationRestore (const char *label)
	Process request federation restore. More...

virtual void	federateRestoreComplete ()
	Process federate restore complete. More...

virtual void	federateRestoreNotComplete ()
	Process federate restore complete. More...

Public Member Functions inherited from DtFederateMgr
virtual	~DtFederateMgr ()
	Destructor. More...

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

virtual void	registerFederationSynchronizationPoint (const char *label, RTI_API::VariableLengthData const &theTag)=0
	Process the register federation synchronization point service. More...

virtual void	waitForResignResponse (bool serviceCall=true)
	Wait for Resign Response. More...

virtual void	waitForReserveNameResponse (bool serviceCall=true)
	Wait for Resign Response. More...

virtual void	registerFederationSynchronizationPoint (const char *label, RTI_API::VariableLengthData const &theTag, DtFederateHandleSet const &syncSet)=0
	Process the register federation synchronization point service. More...

virtual void	init ()
	Virtual initialization within create. More...

virtual bool	tick ()
	Update the state of the federation. More...

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

virtual char *	getOrderName (MAKRti::DtOrderType order)
	Get order name service. More...

virtual MAKRti::DtTransportType	getTransportationHandle (MAKRti::DtString transport)
	Get transport handle service. More...

virtual MAKRti::DtOrderType	getOrderHandle (MAKRti::DtString order)
	Get order handle service. More...

virtual DtFederateHandle	federateHandle () const
	Get the federate handle. More...

virtual MAKRti::DtString const &	fedType () const
	Get the federate type. More...

virtual MAKRti::DtString const &	fedName () const
	Get the federate name (HLA Evolved) More...

virtual MAKRti::DtString const &	fedExName () const
	Get the federation execution name. More...

virtual unsigned long	fedExHandle () const
	Get the federation execution handle. More...

virtual bool	isJoined () const
	Return boolean: federate is joined? More...

virtual DtConnectionMgr *	connectMgr ()
	Access to the connection manager. More...

virtual DtConnectionMgr *	connectMgr () const

virtual DtRIDParameters *	params ()
	Access to the RID parameters. More...

virtual DtRIDParameters *	params () const

virtual DtFomModuleManager *	fomManager ()
	Access to the fom modules. More...

virtual DtFomModuleManager *	fomManager () const

virtual DtFomClassMgr *	fom ()
	Access to the fom classes. More...

virtual DtFomClassMgr *	fom () const

virtual DtInteractionMgr *	interMgr ()
	Access to the interaction mgr. More...

virtual DtInteractionMgr *	interMgr () const

virtual DtTestManager *	testMgr ()
	Access to the test Manager. More...

virtual DtTestManager *	testMgr () const

virtual DtObjectMgr *	objMgr ()
	Access to the object mgr. More...

virtual DtObjectMgr *	objMgr () const

virtual DtLogicalTimeFactory *	timeFactory ()
	Access to the time factory. More...

virtual DtLogicalTimeFactory *	timeFactory () const

virtual DtRtiAssistantLrcClient *	assistantClient ()
	Access to the RTI Assistant client. More...

virtual DtRtiAssistantLrcClient *	assistantClient () const

virtual bool	isJoinedFederate (DtFederateHandle federateHandleValue) const
	Return bool: Is the federate handle known to be in the federation. More...

virtual bool	forcedToResign () const
	Return bool: Was federate forced to resign? More...

virtual void	setMomResign ()
	Marks that MOM is invoking resign. More...

virtual void	resetMomResign ()
	Unmark that MOM is invoking resign. More...

virtual bool	saveInitiated () const
	return bool: save initiated? More...

virtual bool	saveBegun () const
	return bool: save begun? More...

virtual bool	restoreRequested () const
	return bool: restore requested? More...

virtual bool	restoreInitiated () const
	return bool: restore initiated ? More...

virtual bool	restoreBegun () const
	return bool: restore begun? More...

virtual const MAKRti::DtString &	restoreLabel () const
	return current restore label More...

virtual const MAKRti::DtString &	lastRestoreLabel () const
	return last restore label More...

const MAKRti::DtString &	currentTimeImplName () const
	get/set current time implementation name More...

void	setCurrentTimeImplName (const MAKRti::DtString &)

virtual const MAKRti::DtString &	saveLabel () const
	Set/Get save label. More...

virtual void	setSaveLabel (const MAKRti::DtString &value)

virtual const MAKRti::DtString &	lastSaveLabel () const
	Set/Get last save label. More...

virtual void	setLastSaveLabel (const MAKRti::DtString &value)

virtual void	initiateSave ()
	Perform the actual save possibly after waiting to enter time advancing state. More...

virtual void	initiateTimedSave (DtRtiApiTime const &saveTime)
	Save is initiated possibly after waiting to enter time advancing state. More...

virtual bool	save (DtRtiSaveFile &file)
	Perform the actual save. More...

virtual bool	restore (DtRtiSaveFile &file)
	Perform the actual restore. More...

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

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

virtual unsigned long	tickCount () const
	Return the number of ticks. More...

virtual bool	isTicking () const
	Return true if currently processing tick. More...

virtual void	reportLatencyTestResults (const DtLatencyReportMsg &msg)
	Report results of a latency test. More...

virtual void	reportLatencyTestStatus (const DtTestMgrStatusMsg &msg)
	Report current latency test status. More...

unsigned long	flags () const

virtual void	setEnableCallbacks (bool enableCallbacks)
	Set/Get whether callbacks are enabled/disabled. More...

virtual bool	callbacksEnabled () const
	Set/Get whether callbacks are enabled/disabled. More...

virtual void	setTopLevelAmbassador (RTI_API::RTIambassador ambPtr, RTI_API::FederateAmbassador federateAmbassador)
	Provide access to top level RTI Ambassador (and Federate Ambassador for 1516E) More...

RTI_API::RTIambassador *	rtiAmb ()
	Access to the top level RTI Ambassador given to the federate. More...

RTI_API::RTIambassador *	rtiAmb () const
	Access to the top level RTI Ambassador given to the federate. More...

virtual RTI_API::FederateAmbassador *	federateAmbassador ()
	Access to the Federate Ambassador submitted by the federate. More...

virtual RTI_API::FederateAmbassador *	federateAmbassador () const
	Access to the Federate Ambassador submitted by the federate. More...

virtual DtResignAction	automaticResignDirective () const
	Get/Set the resign action as internal value. More...

virtual void	setAutomaticResignDirective (DtResignAction action)
	Send message to fedEx updating its list of resign actions. More...

virtual RTI_API::ResignAction	getAutomaticResignDirective () const
	Get/Set the resign action as RTI API value. More...

virtual void	setAutomaticResignDirective (RTI_API::ResignAction action)
	Send message to fedEx updating its list of resign actions. More...

virtual const MAKRti::DtString &	getFederateNameFromHandle (DtFederateHandle handle)
	Get Federate Name / Handle from Handle / Name. More...

virtual DtFederateHandle	getFederateHandleFromName (const MAKRti::DtString &name)
	Get Federate Name / Handle from Handle / Name. More...

Static Public Member Functions
static DtFederateMgr *	create (DtRIDParameters params, DtRtiAmbassadorBaseImplementor ambImplPtr, DtConnectionMgr *connMgr, std::shared_ptr< DtRtiAssistantLrcClient > assistantClient)
	Creates an instance of this derived class;. More...

Static Public Member Functions inherited from DtFederateMgr
static DtFederateMgr *	create (DtRIDParameters params, DtRtiAmbassadorBaseImplementor ambImplPtr, DtConnectionMgr *connMgr, std::shared_ptr< DtRtiAssistantLrcClient > assistantClient)
	A Federate Manager instance is created, initialized, and its pointer is returned. More...

static void	setCreatorFunction (DtFederateMgrCreator fn)
	Register a creator function. More...

static void	setInternalCreatorFunction (DtFederateMgrCreator fn)
	Register alternate internal creators. More...

Protected Attributes
std::map< DtString, std::vector< DtString > >	myFederationsToCreateFomModulesMap

Protected Attributes inherited from DtFederateMgr
RTI_API::RTIambassador *	myRtiAmb
	The federate's RTI Ambassador. More...

DtRtiAmbassadorBaseImplementor *	myAmbImpl
	The federate's RTI Ambassador Implementor. More...

MAKRti::DtTime	myResponseInterval
	Interval to wait for response message during a message protocol. More...

MAKRti::DtString	myFedExName
	Federation execution name. More...

unsigned long	myFedExHandle
	Federation handle. More...

MAKRti::DtString	myFedType
	Federate type. More...

MAKRti::DtString	myFedName
	Federate name. More...

DtFederateHandle	myFedHandle
	Federate handle. More...

MAKRti::DtString	myCurrentTimeImplName
	Current time implementation name. More...

MAKRti::DtTime	myLastHeartbeat
	Time of last heartbeat. More...

DtLogicalTimeFactory *	myLogicalTimeFactory
	Logical time factory Even if NULL, need to have this factory. More...

DtFedAmbWrapper *	myPrinter
	Prints data for federate ambassador calls. More...

DtFedAmbWrapper *	myFedAmbCatch
	Catches exceptions from federate ambassador calls. More...

DtRIDParameters *	myParams
	Initialization data. More...

std::shared_ptr < DtRtiAssistantLrcClient >	myAssistantClient
	Manages the connection to the RTI Assistant. More...

bool	myIgnoreForcedResign
	Prevents forcing duplicate resign. More...

bool	myForcedToResign
	Indicates forced resign occurred. More...

bool	myMomResign
	Indicates MOM caused resign. More...

bool	myMomSaveEvokeCallbacks
	State of evoking callbacks prior to MOM resign. More...

bool	myResignInProgress
	Indicates a resign is in progress. More...

MAKRti::DtClock	myClock
	Clock for timing. More...

unsigned long	myTickCount
	Tick counter. More...

bool	myIsTicking
	indicates currently processing tick More...

bool	myEnableFederateHeartbeat
	is heartbeating enabled? More...

bool	myCallbacksEnabled
	Callbacks are enabled. More...

unsigned long	myFlags

DtTestManager *	myTestMgr

bool	myNetworkTestEnabled

float	mySignalTickInterval
	The Signal Tick Interval. More...

DtTime	myLastTickTime
	The last tick time. More...

DtPostTickCallbackMap	myPostTickCallbacks

MAKRti::DtFilename	myStandardMimPath

std::map< MAKRti::DtString, DtFederateHandle >	myFederateNameToHandle

std::map< DtFederateHandle, MAKRti::DtString >	myFederateHandleToName

MAKRti::DtResignAction	myResignAction
	The resign action. More...

DtConnectionMgr *	myConnectMgr
	The connection manager. More...

DtFomModuleManager *	myFomManager
	The FOM Module Manager. More...

DtInteractionMgr *	myInterMgr
	The interaction manager. More...

DtObjectMgr *	myObjMgr
	The object manager. More...

DtMomMgr *	myMomMgr
	The MOM manager. More...

bool	mySaveInitiated
	Indicates save initiated. More...

bool	mySaveBegun
	Indicates save begun. More...

bool	myRestoreRequested
	Indicates restore requested. More...

bool	myRestoreInitiated
	Indicates restore initiated. More...

bool	myRestoreBegun
	Indicates restore begun. More...

MAKRti::DtString	mySaveLabel
	The save label. More...

MAKRti::DtString	myLastSaveLabel
	The last save label. More...

MAKRti::DtString	myRestoreLabel
	The restore label. More...

MAKRti::DtString	myLastRestoreLabel
	The last restore label. More...

Private Member Functions
	DtSimpleFederateMgr (DtFederateMgr const &)
	Copy Constructor not implemented – Copy Not Allowed! More...

DtSimpleFederateMgr &	operator= (DtSimpleFederateMgr const &)
	Assignment not implemented – Assignment Not Allowed! More...

Additional Inherited Members
Public Types inherited from DtFederateMgr
typedef DtFederateMgr (	DtFederateMgrCreator )(DtRIDParameters ridParams, DtRtiAmbassadorBaseImplementor ambImplPtr, DtConnectionMgr *connMgr, std::shared_ptr< DtRtiAssistantLrcClient > assistantClient)
	Federate manager creator. More...

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, std::shared_ptr< DtRtiAssistantLrcClient > assistantClient)
	Constructor. More...

virtual void	processResignDirective (const DtResignDirectiveMsg &msg)
	Process updated resign directive message. More...

virtual void	sendAlive ()
	Send the alive message. More...

virtual void	sendResignMsg (const char *fedExName, DtFederateHandle fedHandle, DtResignAction action)
	Send the resign message. More...

void	sendTickedMsg ()
	Send the signal ticked message. More...

virtual void	applyRidParameters ()
	Apply RID parameters. More...

virtual DtResignAction	testResign (RTI_API::ResignAction theAction)
	Test the resign action and return the internal representation. More...

virtual void	postJoinInit (const char federateType, const char executionName, const char *federateName)
	Uses the given information to initialize federate data. More...

virtual void	handleFailedJoin (unsigned long sourceID, DtJoinConfirmMsg::errorCodes code)
	Handle the join failure before throwing an exception. More...

virtual void	postJoinConfirmInit ()

virtual void	processResign (const DtResignMsg &msg)
	Process resign message. More...

virtual void	processEnableDisableNetworkTesting (const DtEnableDisableNetworkTestingMsg &msg)
	disable network testing More...

virtual void	processSaveInitiate (const DtSaveInitiateMsg &msg)
	Process save initiate message. More...

virtual void	processSaveResponse (const DtSaveResponseMsg &msg)
	Process save resonse message. More...

virtual void	processSaveFinished (const DtSaveFinishedMsg &msg)
	Process save finished message. More...

virtual void	processRestoreReply (const DtRestoreReplyMsg &msg)
	Process restore reply message. More...

virtual void	processRestoreInitiate (const DtRestoreInitiateMsg &msg)
	Process restore initiate message. More...

virtual void	processRestoreEnd (const DtRestoreEndMsg &msg)
	Process restore end message. More...

virtual void	processRestore (const DtRestoreMsg &msg)
	Process restore message. More...

virtual void	processAssistantResign (const DtAssistantExitMsg &msg)
	Process resign message from Assistant. More...

virtual void	processAssistantEnableLogging (const DtAssistantLogEnableMsg &msg)
	Process resign message from Assistant. More...

virtual void	processSignalTickInterval (const DtAssistantFederateSignalTickIntervalMsg &msg)
	Process a change in the interval at which a federate is expected to tick. More...

virtual void	processRidParamRequest (const DtAssistantRidParamsMsg &msg)
	Process a RID parameter request from the Assistant. More...

virtual void	createObjectMgr ()
	Create the Object Manager. More...

virtual void	createInteractionMgr ()
	Create the Interaction Manager. More...

virtual void	createDdmMgr ()
	Create the DDM Manager. More...

virtual void	createTimeMgr ()
	Create the Time manager. More...

virtual void	createMomMgr ()
	Create the MOM Manager. More...

virtual void	createTestMgr ()
	Create the test Manager. More...

virtual MAKRti::DtResignAction	convertResignAction (RTI_API::ResignAction) const
	Convert resign action between RTI API and internal representation. More...

virtual RTI_API::ResignAction	convertResignAction (MAKRti::DtResignAction) const
	Convert resign action between RTI API and internal representation. More...

Static Protected Member Functions inherited from DtFederateMgr
static void	processResignDirective (const DtResignDirectiveMsg &msg, void *usr)
	Process the resign directive message. More...

static void	processResign (const DtResignMsg &msg, void *usr)
	resign message callback More...

static void	processEnableDisableNetworkTesting (const DtEnableDisableNetworkTestingMsg &msg, void *usr)
	process enable / disable network testing callback More...

static void	processSaveInitiate (const DtSaveInitiateMsg &msg, void *usr)
	save initiate message callback More...

static void	processSaveResponse (const DtSaveResponseMsg &msg, void *usr)
	save response message callback More...

static void	processSaveFinished (const DtSaveFinishedMsg &msg, void *usr)
	save finished message callback More...

static void	processRestoreReply (const DtRestoreReplyMsg &msg, void *usr)
	restore reply message callback More...

static void	processRestore (const DtRestoreMsg &msg, void *usr)
	restore message callback More...

static void	processRestoreInitiate (const DtRestoreInitiateMsg &msg, void *usr)
	restore initiate message callback More...

static void	processRestoreEnd (const DtRestoreEndMsg &msg, void *usr)
	restore end message callback More...

static void	processAssistantResign (const DtAssistantExitMsg &msg, void *usr)
	Assistant resign message callback. More...

static void	processAssistantEnableLogging (const DtAssistantLogEnableMsg &msg, void *usr)
	Assistant logging enable message callback. More...

static void	processSignalTickInterval (const DtAssistantFederateSignalTickIntervalMsg &msg, void *usr)
	Assistant signal tick interval message callback. More...

static void	processRidParamRequest (const DtAssistantRidParamsMsg &msg, void *usr)
	Assistant RID parameter request message callback. More...

Static Protected Attributes inherited from DtFederateMgr
static DtFederateMgrCreator	theCreator
	The plugin creator. More...

static DtFederateMgrCreator	theInternalCreator
	The internal creator. More...

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,
		std::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

virtual void DtSimpleFederateMgr::abortFederationRestore ( )

virtual

Process the abort federation restore service.

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation