DtRtiexecObserver Class Reference

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

Inheritance diagram for DtRtiexecObserver:

Collaboration diagram for DtRtiexecObserver:

Public Member Functions
	DtRtiexecObserver ()
	Constructor. More...
virtual	~DtRtiexecObserver ()
	Destructor. More...
virtual void	setMgr (DtRtiexecObserverMgr *mgr)
	Sets the manager for this observer. More...
virtual void	removeMgr ()
	Removes the manager for this observer. More...
virtual void	startObservation ()
	Indicates that observation of the exec has begun. More...
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. More...
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. More...
virtual void	addTickCallback (DtTickCbFn fcn, DtTime interval)
	Add a tick callback function to be called periodically at the given time interval. More...
virtual void	removeTickCallback (DtTickCbFn fcn)
	Remove tick callback. More...
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. More...
virtual void	removeTickCallback (DtTickWithExecCbFn fcn)
	Remove tick callback that takes a reference to a DtRtiExec. More...
virtual unsigned long	connectionId () const
	Get the connection ID for this exec (threadsafe) More...
Event processing functions
Process rtiexec events
virtual void	processFedExCreatedEvent (DtFedExec *exec)
	Process a new federation execution created event. More...
virtual void	processFedExDestroyedEvent (DtFedExec *exec)
	Process a federation execution destroyed event. More...
virtual void	processFederateJoinedEvent (DtFedExec *exec, DtFederate *federate)
	Process a federate joined event. More...
virtual void	processFederateResignedEvent (DtFedExec *exec, DtFederate *federate)
	Process a federate resigned event. More...
virtual void	processSyncPtRegisteredEvent (DtFedExec *exec, DtSyncPt *pt)
	Process a new sync. point registered event. More...
virtual void	processFederationSynchronizedEvent (DtFedExec *exec, DtSyncPt *pt)
	Process a federation synchronized to an existing sync. point event. More...
virtual void	processSyncPtAchievedEvent (DtFedExec *exec, DtFederate *fed, DtSyncPt *pt)
	Process an existing sync. point achieved event. More...
virtual void	processFederateDisconnectedEvent (DtFedExec *exec, DtFederate *fed)
	Process a federate disconnect event. More...
virtual void	processFederateReconnectSucceededEvent (DtFedExec *exec, DtFederate *fed)
	Process a federate reconnect succeeded event. More...
virtual void	processFederateReconnectFailedEvent (DtFedExec *exec, DtFederateHandle federateHandle)
	Process a federate reconnect failed event. More...
virtual void	processLogFileUpdatedEvent (const MAKRti::DtFilename &logFile)
	Process a log file name update event. More...

Protected Member Functions
virtual void	addCallbacks ()=0
	Adds all RTI message and tick callbacks. Called when a manager is set. More...
virtual void	removeCallbacks ()=0
	Removes all RTI message and tick callbacks. More...

Protected Attributes
DtRtiexecObserverMgr *	myMgr
	Pointer to the observer manager. More...

Private Member Functions
	DtRtiexecObserver (const DtRtiexecObserver &orig)
	Copy constructor unimplemented. More...
DtRtiexecObserver &	operator= (const DtRtiexecObserver &orig)
	Assignment unimplemented. More...

Detailed Description

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

Constructor & Destructor Documentation

DtRtiexecObserver::DtRtiexecObserver

(

)

Constructor.

virtual DtRtiexecObserver::~DtRtiexecObserver ( )

virtual

Destructor.

DtRtiexecObserver::DtRtiexecObserver ( const DtRtiexecObserver &  orig )

private

Copy constructor unimplemented.

Member Function Documentation

virtual void DtRtiexecObserver::addCallbacks ( )

protectedpure virtual

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

Implemented in DtRtiexecObserverForAssistant.

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

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

virtual

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

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

unsigned long DtRtiexecObserver::connectionId ( ) const

inlinevirtual

Get the connection ID for this exec (threadsafe)

References DtRtiexecObserverMgr::connectionId(), and myMgr.

DtRtiexecObserver& DtRtiexecObserver::operator= ( const DtRtiexecObserver &  orig )

private

Assignment unimplemented.

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

inlinevirtual

Process a federate disconnect event.

Reimplemented in DtRtiexecObserverForAssistant.

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

inlinevirtual

Process a federate joined event.

Reimplemented in DtRtiexecObserverForAssistant.

virtual void DtRtiexecObserver::processFederateReconnectFailedEvent ( DtFedExec *  exec, DtFederateHandle  federateHandle  )

inlinevirtual

Process a federate reconnect failed event.

Reimplemented in DtRtiexecObserverForAssistant.

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

inlinevirtual

Process a federate reconnect succeeded event.

Reimplemented in DtRtiexecObserverForAssistant.

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

inlinevirtual

Process a federate resigned event.

Reimplemented in DtRtiexecObserverForAssistant.

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

inlinevirtual

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

Reimplemented in DtRtiexecObserverForAssistant.

virtual void DtRtiexecObserver::processFedExCreatedEvent ( DtFedExec *  exec )

inlinevirtual

Process a new federation execution created event.

Reimplemented in DtRtiexecObserverForAssistant.

virtual void DtRtiexecObserver::processFedExDestroyedEvent ( DtFedExec *  exec )

inlinevirtual

Process a federation execution destroyed event.

Reimplemented in DtRtiexecObserverForAssistant.

virtual void DtRtiexecObserver::processLogFileUpdatedEvent ( const MAKRti::DtFilename &  logFile )

inlinevirtual

Process a log file name update event.

Reimplemented in DtRtiexecObserverForAssistant.

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

inlinevirtual

Process an existing sync. point achieved event.

Reimplemented in DtRtiexecObserverForAssistant.

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

inlinevirtual

Process a new sync. point registered event.

Reimplemented in DtRtiexecObserverForAssistant.

virtual void DtRtiexecObserver::removeCallbacks ( )

protectedpure virtual

Removes all RTI message and tick callbacks.

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

Implemented in DtRtiexecObserverForAssistant.

virtual void DtRtiexecObserver::removeMgr ( )

virtual

Removes the manager for this observer.

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

virtual void DtRtiexecObserver::removeTickCallback ( DtTickCbFn  fcn )

virtual

Remove tick callback.

virtual void DtRtiexecObserver::removeTickCallback ( DtTickWithExecCbFn  fcn )

virtual

Remove tick callback that takes a reference to a DtRtiExec.

virtual void DtRtiexecObserver::setMgr ( DtRtiexecObserverMgr *  mgr )

virtual

Sets the manager for this observer.

virtual void DtRtiexecObserver::startObservation ( )

inlinevirtual

Indicates that observation of the exec has begun.

Reimplemented in DtRtiexecObserverForAssistant.

Member Data Documentation

DtRtiexecObserverMgr* DtRtiexecObserver::myMgr

protected

Pointer to the observer manager.

Referenced by connectionId().

---

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

• execObserver.h