DtRtiexecObserver Class Reference

The DtRtiexecObserver is the base class for all observers of rtiexec events. More...

Inheritance diagram for DtRtiexecObserver:

Collaboration diagram for DtRtiexecObserver:

List of all members.

Public Member Functions
	DtRtiexecObserver ()
	Constructor.
virtual	~DtRtiexecObserver ()
	Destructor.
virtual void	setMgr (DtRtiexecObserverMgr *mgr)
	Sets the manager for this observer.
virtual void	removeMgr ()
	Removes the manager for this observer.
virtual void	startObservation ()
	Indicates that observation of the exec has begun.
virtual void	addRtiMsgCallback (DtRtiMsgKind msgKind, DtRtiMsgCbMgr::DtCallbackFcn fcn, bool isMomCallback=false)
	Register to receive an event whenever an RTI Msg of the specified kind is received.
virtual void	removeRtiMsgCallback (DtRtiMsgKind msgKind, DtRtiMsgCbMgr::DtCallbackFcn fcn, bool isMomCallback=false)
	Unregister to receive an event whenever an RTI Msg of the specified kind is received.
virtual void	addTickCallback (DtTickCbFn fcn, DtTime interval)
	Add a tick callback function to be called periodically at the given time interval.
virtual void	removeTickCallback (DtTickCbFn fcn)
	Remove tick callback.
virtual void	addTickCallback (DtTickWithExecCbFn fcn, DtTime interval)
	Add a tick callback function that takes a reference to a DtRtiExec to be called periodically at the given time interval.
virtual void	removeTickCallback (DtTickWithExecCbFn fcn)
	Remove tick callback that takes a reference to a DtRtiExec.
virtual unsigned long	connectionId () const
	Get the connection ID for this exec (threadsafe)
Event processing functions
Process rtiexec events
virtual void	processFedExCreatedEvent (DtFedExec *exec)
	Process a new federation execution created event.
virtual void	processFedExDestroyedEvent (DtFedExec *exec)
	Process a federation execution destroyed event.
virtual void	processFederateJoinedEvent (DtFedExec *exec, DtFederate *federate)
	Process a federate joined event.
virtual void	processFederateResignedEvent (DtFedExec *exec, DtFederate *federate)
	Process a federate resigned event.
virtual void	processSyncPtRegisteredEvent (DtFedExec *exec, DtSyncPt *pt)
	Process a new sync. point registered event.
virtual void	processFederationSynchronizedEvent (DtFedExec *exec, DtSyncPt *pt)
	Process a federation synchronized to an existing sync. point event.
virtual void	processSyncPtAchievedEvent (DtFedExec *exec, DtFederate *fed, DtSyncPt *pt)
	Process an existing sync. point achieved event.
virtual void	processFederateDisconnectedEvent (DtFedExec *exec, DtFederate *fed)
	Process a federate disconnect event.
virtual void	processFederateReconnectSucceededEvent (DtFedExec *exec, DtFederate *fed)
	Process a federate reconnect succeeded event.
virtual void	processFederateReconnectFailedEvent (DtFedExec *exec, DtFederate *fed)
	Process a federate reconnect failed event.
virtual void	processLogFileUpdatedEvent (const MAKRti::DtFilename &logFile)
	Process a log file name update event.
virtual void	processWebServerUpdatedEvent (const MAKRti::DtInetAddr &webSpyIpAddr, int webSpyPort)
	Process a web server update event.
Protected Member Functions
virtual void	addCallbacks ()=0
	Adds all RTI message and tick callbacks. Called when a manager is set.
virtual void	removeCallbacks ()=0
	Removes all RTI message and tick callbacks.
Protected Attributes
DtRtiexecObserverMgr *	myMgr
	Pointer to the observer manager.
Private Member Functions
	DtRtiexecObserver (const DtRtiexecObserver &orig)
	Copy constructor unimplemented.
DtRtiexecObserver &	operator= (const DtRtiexecObserver &orig)
	Assignment unimplemented.

---

Detailed Description

The DtRtiexecObserver is the base class for all observers of rtiexec events.

---

Constructor & Destructor Documentation

DtRtiexecObserver::DtRtiexecObserver

(

)

Constructor.

DtRtiexecObserver::~DtRtiexecObserver

(

)

[virtual]

Destructor.

DtRtiexecObserver::DtRtiexecObserver

(

const DtRtiexecObserver &

orig

)

[private]

Copy constructor unimplemented.

---

Member Function Documentation

virtual void DtRtiexecObserver::addCallbacks

(

)

[protected, pure virtual]

Adds all RTI message and tick callbacks. Called when a manager is set.

Implemented in DtRtiexecObserverForAssistant, and DtRtiexecObserverForWebService.

Referenced by setMgr().

void DtRtiexecObserver::addRtiMsgCallback	(	DtRtiMsgKind	msgKind,
		DtRtiMsgCbMgr::DtCallbackFcn	fcn,
		bool	isMomCallback = false
	)		[virtual]

Register to receive an event whenever an RTI Msg of the specified kind is received.

References DtRtiexecObserverMgr::addRtiMsgCallback(), and myMgr.

Referenced by DtRtiexecObserverForWebService::addCallbacks(), and DtRtiexecObserverForAssistant::addCallbacks().

void DtRtiexecObserver::addTickCallback	(	DtTickCbFn	fcn,
		DtTime	interval
	)		[virtual]

Add a tick callback function to be called periodically at the given time interval.

References DtRtiexecObserverMgr::addTickCallback(), and myMgr.

Referenced by DtRtiexecObserverForWebService::addCallbacks(), DtRtiexecObserverForAssistant::addCallbacks(), and DtRtiexecObserverForAssistant::processExecObserveMsg().

void DtRtiexecObserver::addTickCallback	(	DtTickWithExecCbFn	fcn,
		DtTime	interval
	)		[virtual]

Add a tick callback function that takes a reference to a DtRtiExec to be called periodically at the given time interval.

References DtRtiexecObserverMgr::addTickCallback(), and myMgr.

unsigned long DtRtiexecObserver::connectionId

(

)

const [inline, virtual]

Get the connection ID for this exec (threadsafe)

References DtRtiexecObserverMgr::connectionId(), and myMgr.

Referenced by DtRtiexecObserverForWebService::setConnectionId().

DtRtiexecObserver& DtRtiexecObserver::operator=

(

const DtRtiexecObserver &

orig

)

[private]

Assignment unimplemented.

virtual void DtRtiexecObserver::processFederateDisconnectedEvent	(	DtFedExec *	exec,
		DtFederate *	fed
	)		[inline, virtual]

Process a federate disconnect event.

Reimplemented in DtRtiexecObserverForAssistant.

virtual void DtRtiexecObserver::processFederateJoinedEvent	(	DtFedExec *	exec,
		DtFederate *	federate
	)		[inline, virtual]

Process a federate joined event.

Reimplemented in DtRtiexecObserverForAssistant, and DtRtiexecObserverForWebService.

virtual void DtRtiexecObserver::processFederateReconnectFailedEvent	(	DtFedExec *	exec,
		DtFederate *	fed
	)		[inline, virtual]

Process a federate reconnect failed event.

Reimplemented in DtRtiexecObserverForAssistant.

virtual void DtRtiexecObserver::processFederateReconnectSucceededEvent	(	DtFedExec *	exec,
		DtFederate *	fed
	)		[inline, virtual]

Process a federate reconnect succeeded event.

Reimplemented in DtRtiexecObserverForAssistant.

virtual void DtRtiexecObserver::processFederateResignedEvent	(	DtFedExec *	exec,
		DtFederate *	federate
	)		[inline, virtual]

Process a federate resigned event.

Reimplemented in DtRtiexecObserverForAssistant, and DtRtiexecObserverForWebService.

virtual void DtRtiexecObserver::processFederationSynchronizedEvent	(	DtFedExec *	exec,
		DtSyncPt *	pt
	)		[inline, virtual]

Process a federation synchronized to an existing sync. point event.

Reimplemented in DtRtiexecObserverForAssistant, and DtRtiexecObserverForWebService.

virtual void DtRtiexecObserver::processFedExCreatedEvent

(

DtFedExec *

exec

)

[inline, virtual]

Process a new federation execution created event.

Reimplemented in DtRtiexecObserverForAssistant, and DtRtiexecObserverForWebService.

virtual void DtRtiexecObserver::processFedExDestroyedEvent

(

DtFedExec *

exec

)

[inline, virtual]

Process a federation execution destroyed event.

Reimplemented in DtRtiexecObserverForAssistant, and DtRtiexecObserverForWebService.

virtual void DtRtiexecObserver::processLogFileUpdatedEvent

(

const MAKRti::DtFilename &

logFile

)

[inline, virtual]

Process a log file name update event.

Reimplemented in DtRtiexecObserverForAssistant.

virtual void DtRtiexecObserver::processSyncPtAchievedEvent	(	DtFedExec *	exec,
		DtFederate *	fed,
		DtSyncPt *	pt
	)		[inline, virtual]

Process an existing sync. point achieved event.

Reimplemented in DtRtiexecObserverForAssistant, and DtRtiexecObserverForWebService.

virtual void DtRtiexecObserver::processSyncPtRegisteredEvent	(	DtFedExec *	exec,
		DtSyncPt *	pt
	)		[inline, virtual]

Process a new sync. point registered event.

Reimplemented in DtRtiexecObserverForAssistant, and DtRtiexecObserverForWebService.

virtual void DtRtiexecObserver::processWebServerUpdatedEvent	(	const MAKRti::DtInetAddr &	webSpyIpAddr,
		int	webSpyPort
	)		[inline, virtual]

Process a web server update event.

Reimplemented in DtRtiexecObserverForAssistant.

virtual void DtRtiexecObserver::removeCallbacks

(

)

[protected, pure virtual]

Removes all RTI message and tick callbacks.

Called when a manager is removed or the observer is destroyed.

Implemented in DtRtiexecObserverForAssistant, and DtRtiexecObserverForWebService.

Referenced by removeMgr().

void DtRtiexecObserver::removeMgr

(

)

[virtual]

Removes the manager for this observer.

References myMgr, and removeCallbacks().

Referenced by setMgr(), and DtRtiexecObserverForAssistant::~DtRtiexecObserverForAssistant().

void DtRtiexecObserver::removeRtiMsgCallback	(	DtRtiMsgKind	msgKind,
		DtRtiMsgCbMgr::DtCallbackFcn	fcn,
		bool	isMomCallback = false
	)		[virtual]

Unregister to receive an event whenever an RTI Msg of the specified kind is received.

References myMgr, and DtRtiexecObserverMgr::removeRtiMsgCallback().

Referenced by DtRtiexecObserverForWebService::removeCallbacks(), and DtRtiexecObserverForAssistant::removeCallbacks().

void DtRtiexecObserver::removeTickCallback

(

DtTickCbFn

fcn

)

[virtual]

Remove tick callback.

References myMgr, and DtRtiexecObserverMgr::removeTickCallback().

Referenced by DtRtiexecObserverForAssistant::processExecObserveMsg(), DtRtiexecObserverForWebService::removeCallbacks(), and DtRtiexecObserverForAssistant::removeCallbacks().

void DtRtiexecObserver::removeTickCallback

(

DtTickWithExecCbFn

fcn

)

[virtual]

Remove tick callback that takes a reference to a DtRtiExec.

References myMgr, and DtRtiexecObserverMgr::removeTickCallback().

void DtRtiexecObserver::setMgr

(

DtRtiexecObserverMgr *

mgr

)

[virtual]

Sets the manager for this observer.

References addCallbacks(), myMgr, and removeMgr().

virtual void DtRtiexecObserver::startObservation

(

)

[inline, virtual]

Indicates that observation of the exec has begun.

Reimplemented in DtRtiexecObserverForAssistant, and DtRtiexecObserverForWebService.

---

Member Data Documentation

DtRtiexecObserverMgr* DtRtiexecObserver::myMgr [protected]

Pointer to the observer manager.

Referenced by addRtiMsgCallback(), addTickCallback(), connectionId(), removeMgr(), removeRtiMsgCallback(), removeTickCallback(), and setMgr().

---

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

• execObserver.h
• execObserver.cxx