MAK RTIspy API Documentation for HLA 1516
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
DtRtiexecObserverMgr Class Reference
The RTIspy Executive Library (exec)

The DtRtiexecObserverMgr is the class which manages all rtiexec observers. More...

+ Collaboration diagram for DtRtiexecObserverMgr:

List of all members.

Public Member Functions

 DtRtiexecObserverMgr ()
 Constructor.
virtual ~DtRtiexecObserverMgr ()
 Destructor.
virtual void setExec (DtBoost::shared_ptr< DtRtiExec > exec)
 Sets the exec to be observed.
virtual void addObserver (DtBoost::shared_ptr< DtRtiexecObserver > observer)
 Add a new rtiexec observer.
virtual void removeObserver (DtBoost::shared_ptr< DtRtiexecObserver > observer)
 Remove rtiexec observer.
virtual void removeAllObservers ()
 Remove all rtiexec observers.
virtual void addRtiMsgCallback (DtRtiMsgKind msgKind, DtRtiMsgCbMgr::DtCallbackFcn fcn, DtRtiexecObserver *observer, bool isMomCallback)
 Add callback for incoming RTI message.
virtual void removeRtiMsgCallback (DtRtiMsgKind msgKind, DtRtiMsgCbMgr::DtCallbackFcn fcn, DtRtiexecObserver *observer, bool isMomCallback)
 Remove callback for incoming RTI message.
virtual void addTickCallback (DtTickCbFn fcn, DtRtiexecObserver *observer, DtTime interval)
 Add a tick callback function to be called periodically at the given time interval.
virtual void removeTickCallback (DtTickCbFn fcn, DtRtiexecObserver *observer)
 Remove tick callback.
virtual void addTickCallback (DtTickWithExecCbFn fcn, DtRtiexecObserver *observer, 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, DtRtiexecObserver *observer)
 Remove tick callback that takes a reference to a DtRtiExec.
void federationCreatedCallback (DtFedExec *exec)
void federationDestroyedCallback (DtFedExec *exec)
void federateJoinedCallback (DtFedExec *exec, DtFederate *federate)
void federateResignedCallback (DtFedExec *exec, DtFederate *federate)
void syncPtRegisteredCallback (DtFedExec *exec, DtSyncPt *pt)
void federationSynchronizedCallback (DtFedExec *exec, DtSyncPt *pt)
void syncPtAchievedCallback (DtFedExec *exec, DtFederate *fed, DtSyncPt *pt)
void federateDisconnectedCallback (DtFedExec *exec, DtFederate *fed)
void federateReconnectSucceededCallback (DtFedExec *exec, DtFederate *fed)
void federateReconnectFailedCallback (DtFedExec *exec, DtFederate *fed)
void updateLogFileNameCallback (const DtFilename &logFile)
void updateWebServerCallback (const DtInetAddr &webSpyIpAddr, int webSpyPort)
virtual unsigned long connectionId () const
 Get the connection ID for this exec.

Static Public Member Functions

static void federationCreatedCallback (DtFedExec *exec, void *usr)
 Callback for new federations.
static void federationDestroyedCallback (DtFedExec *exec, void *usr)
 Callback for destroyed federations.
static void federateJoinedCallback (DtFederate *federate, void *usr)
 Callback for joined federates.
static void federateResignedCallback (DtFederate *federate, void *usr)
 Callback for resigned federates.
static void syncPtRegisteredCallback (DtSyncPt *pt, void *usr)
 Callback for registered sync. points.
static void federationSynchronizedCallback (DtSyncPt *pt, void *usr)
 Callback for federation synchronized announcements.
static void syncPtAchievedCallback (DtFederate *fed, DtSyncPt *pt, void *usr)
 Callback for achieved sync. points.
static void federateDisconnectedCallback (DtFederate *fed, void *usr)
 Callback for disconnected federate connections.
static void federateReconnectSucceededCallback (DtFederate *fed, void *usr)
 Callback for successfully reconnected federate connections.
static void federateReconnectFailedCallback (DtFederate *fed, void *usr)
 Callback for unsuccessfully reconnected federate connections.
static void updateLogFileNameCallback (const DtFilename &logFile, void *usr)
 Callback for updated log file name.
static void updateWebServerCallback (const DtInetAddr &webSpyIpAddr, int webSpyPort, void *usr)
 Callback for updated web server.

Protected Types

typedef std::map< DtFedExec
*, DtFedExCbInfo * > 		DtFedexToCbInfoMap
typedef std::set< DtMsgCbInfo > DtMsgCbSet
typedef std::set
< DtTickCallbackInfo > 		DtTickCbSet
typedef std::set
< DtTickWithExecCallbackInfo > 		DtTickWithExecCbSet
typedef std::list
< DtBoost::shared_ptr
< DtRtiexecObserver > > 		DtExecObsList

Protected Member Functions

 DtRtiexecObserverMgr (const DtRtiexecObserverMgr &orig)
 Copy constructor unimplemented.
DtRtiexecObserverMgr & operator= (const DtRtiexecObserverMgr &orig)
 Assignment unimplemented.

Protected Attributes

DtBoost::shared_ptr< DtRtiExec > myExec
 The rtiexec which is being observed.
DtExecObsList myObservers
 List of rtiexec observers.
DtMsgCbSet myMsgCbSet
 Set of all registered message callbacks.
DtTickCbSet myTickCbSet
 Set of all registered tick callbacks.
DtTickWithExecCbSet myTickWithExecCbSet
 Set of all registered tick callbacks that take a DtRtiExec reference.
DtFedexToCbInfoMap myFedexInfoMap
 Map from fedex to fedex callback info.

Detailed Description

The DtRtiexecObserverMgr is the class which manages all rtiexec observers.

Member Typedef Documentation

typedef std::list< DtBoost::shared_ptr<DtRtiexecObserver> > DtRtiexecObserverMgr::DtExecObsList [protected]
typedef std::map<DtFedExec*, DtFedExCbInfo*> DtRtiexecObserverMgr::DtFedexToCbInfoMap [protected]
typedef std::set<DtMsgCbInfo> DtRtiexecObserverMgr::DtMsgCbSet [protected]
typedef std::set<DtTickCallbackInfo> DtRtiexecObserverMgr::DtTickCbSet [protected]
typedef std::set<DtTickWithExecCallbackInfo> DtRtiexecObserverMgr::DtTickWithExecCbSet [protected]

Constructor & Destructor Documentation

DtRtiexecObserverMgr::DtRtiexecObserverMgr ( )

Constructor.

DtRtiexecObserverMgr::~DtRtiexecObserverMgr ( ) [virtual]

Destructor.

References federationCreatedCallback(), federationDestroyedCallback(), myExec, removeAllObservers(), updateLogFileNameCallback(), and updateWebServerCallback().

DtRtiexecObserverMgr::DtRtiexecObserverMgr ( const DtRtiexecObserverMgr &  orig) [protected]

Copy constructor unimplemented.

Member Function Documentation

void DtRtiexecObserverMgr::addObserver ( DtBoost::shared_ptr< DtRtiexecObserver >  observer) [virtual]

Add a new rtiexec observer.

References myObservers.

void DtRtiexecObserverMgr::addRtiMsgCallback ( DtRtiMsgKind  msgKind,
DtRtiMsgCbMgr::DtCallbackFcn  fcn,
DtRtiexecObserver *  observer,
bool  isMomCallback 
) [virtual]

Add callback for incoming RTI message.

References myExec, and myMsgCbSet.

Referenced by DtRtiexecObserver::addRtiMsgCallback().

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

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

References myExec, and myTickCbSet.

Referenced by DtRtiexecObserver::addTickCallback().

void DtRtiexecObserverMgr::addTickCallback ( DtTickWithExecCbFn  fcn,
DtRtiexecObserver *  observer,
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 myExec, and myTickWithExecCbSet.

unsigned long DtRtiexecObserverMgr::connectionId ( ) const [virtual]

Get the connection ID for this exec.

References myExec.

Referenced by DtRtiexecObserver::connectionId().

void DtRtiexecObserverMgr::federateDisconnectedCallback ( DtFederate *  fed,
void *  usr 
) [static]

Callback for disconnected federate connections.

References federateDisconnectedCallback(), DtFedExCbInfo::myExec, and DtFedExCbInfo::myObserverMgr.

Referenced by federateDisconnectedCallback(), federationCreatedCallback(), and federationDestroyedCallback().

void DtRtiexecObserverMgr::federateDisconnectedCallback ( DtFedExec *  exec,
DtFederate *  fed 
)

References myObservers.

void DtRtiexecObserverMgr::federateJoinedCallback ( DtFederate *  federate,
void *  usr 
) [static]

Callback for joined federates.

References federateJoinedCallback(), DtFedExCbInfo::myExec, and DtFedExCbInfo::myObserverMgr.

Referenced by federateJoinedCallback(), federationCreatedCallback(), and federationDestroyedCallback().

void DtRtiexecObserverMgr::federateJoinedCallback ( DtFedExec *  exec,
DtFederate *  federate 
)

References myObservers.

void DtRtiexecObserverMgr::federateReconnectFailedCallback ( DtFederate *  fed,
void *  usr 
) [static]

Callback for unsuccessfully reconnected federate connections.

References federateReconnectFailedCallback(), DtFedExCbInfo::myExec, and DtFedExCbInfo::myObserverMgr.

Referenced by federateReconnectFailedCallback(), federationCreatedCallback(), and federationDestroyedCallback().

void DtRtiexecObserverMgr::federateReconnectFailedCallback ( DtFedExec *  exec,
DtFederate *  fed 
)

References myObservers.

void DtRtiexecObserverMgr::federateReconnectSucceededCallback ( DtFederate *  fed,
void *  usr 
) [static]

Callback for successfully reconnected federate connections.

References federateReconnectSucceededCallback(), DtFedExCbInfo::myExec, and DtFedExCbInfo::myObserverMgr.

Referenced by federateReconnectSucceededCallback(), federationCreatedCallback(), and federationDestroyedCallback().

void DtRtiexecObserverMgr::federateReconnectSucceededCallback ( DtFedExec *  exec,
DtFederate *  fed 
)

References myObservers.

void DtRtiexecObserverMgr::federateResignedCallback ( DtFederate *  federate,
void *  usr 
) [static]

Callback for resigned federates.

References federateResignedCallback(), DtFedExCbInfo::myExec, and DtFedExCbInfo::myObserverMgr.

Referenced by federateResignedCallback(), federationCreatedCallback(), and federationDestroyedCallback().

void DtRtiexecObserverMgr::federateResignedCallback ( DtFedExec *  exec,
DtFederate *  federate 
)

References myObservers.

void DtRtiexecObserverMgr::federationCreatedCallback ( DtFedExec *  exec,
void *  usr 
) [static]

Callback for new federations.

Referenced by setExec(), and ~DtRtiexecObserverMgr().

void DtRtiexecObserverMgr::federationCreatedCallback ( DtFedExec *  exec)

References DtFedExec::addFederateDisconnectedCallback(), DtFedExec::addFederateJoinedCallback(), DtFedExec::addFederateReconnectFailedCallback(), DtFedExec::addFederateReconnectSucceededCallback(), DtFedExec::addFederateResignedCallback(), DtFedExec::addFederationSynchronizedCallback(), DtFedExec::addSyncPtAchievedCallback(), DtFedExec::addSyncPtRegisteredCallback(), federateDisconnectedCallback(), federateJoinedCallback(), federateReconnectFailedCallback(), federateReconnectSucceededCallback(), federateResignedCallback(), federationSynchronizedCallback(), myExec, myFedexInfoMap, myObservers, syncPtAchievedCallback(), and syncPtRegisteredCallback().

void DtRtiexecObserverMgr::federationDestroyedCallback ( DtFedExec *  exec,
void *  usr 
) [static]

Callback for destroyed federations.

Referenced by setExec(), and ~DtRtiexecObserverMgr().

void DtRtiexecObserverMgr::federationDestroyedCallback ( DtFedExec *  exec)

References federateDisconnectedCallback(), federateJoinedCallback(), federateReconnectFailedCallback(), federateReconnectSucceededCallback(), federateResignedCallback(), federationSynchronizedCallback(), myExec, myFedexInfoMap, myObservers, DtFedExec::removeFederateDisconnectedCallback(), DtFedExec::removeFederateJoinedCallback(), DtFedExec::removeFederateReconnectFailedCallback(), DtFedExec::removeFederateReconnectSucceededCallback(), DtFedExec::removeFederateResignedCallback(), DtFedExec::removeFederationSynchronizedCallback(), DtFedExec::removeSyncPtAchievedCallback(), DtFedExec::removeSyncPtRegisteredCallback(), syncPtAchievedCallback(), and syncPtRegisteredCallback().

void DtRtiexecObserverMgr::federationSynchronizedCallback ( DtSyncPt *  pt,
void *  usr 
) [static]

Callback for federation synchronized announcements.

References federationSynchronizedCallback(), DtFedExCbInfo::myExec, and DtFedExCbInfo::myObserverMgr.

Referenced by federationCreatedCallback(), federationDestroyedCallback(), and federationSynchronizedCallback().

void DtRtiexecObserverMgr::federationSynchronizedCallback ( DtFedExec *  exec,
DtSyncPt *  pt 
)

References myObservers.

DtRtiexecObserverMgr& DtRtiexecObserverMgr::operator= ( const DtRtiexecObserverMgr &  orig) [protected]

Assignment unimplemented.

void DtRtiexecObserverMgr::removeAllObservers ( ) [virtual]

Remove all rtiexec observers.

References myObservers.

Referenced by ~DtRtiexecObserverMgr().

void DtRtiexecObserverMgr::removeObserver ( DtBoost::shared_ptr< DtRtiexecObserver >  observer) [virtual]

Remove rtiexec observer.

References myObservers.

void DtRtiexecObserverMgr::removeRtiMsgCallback ( DtRtiMsgKind  msgKind,
DtRtiMsgCbMgr::DtCallbackFcn  fcn,
DtRtiexecObserver *  observer,
bool  isMomCallback 
) [virtual]

Remove callback for incoming RTI message.

References myExec, and myMsgCbSet.

Referenced by DtRtiexecObserver::removeRtiMsgCallback().

void DtRtiexecObserverMgr::removeTickCallback ( DtTickCbFn  fcn,
DtRtiexecObserver *  observer 
) [virtual]

Remove tick callback.

References myExec, and myTickCbSet.

Referenced by DtRtiexecObserver::removeTickCallback().

void DtRtiexecObserverMgr::removeTickCallback ( DtTickWithExecCbFn  fcn,
DtRtiexecObserver *  observer 
) [virtual]

Remove tick callback that takes a reference to a DtRtiExec.

References myExec, and myTickWithExecCbSet.

void DtRtiexecObserverMgr::setExec ( DtBoost::shared_ptr< DtRtiExec >  exec) [virtual]

Sets the exec to be observed.

References federationCreatedCallback(), federationDestroyedCallback(), myExec, myMsgCbSet, myObservers, myTickCbSet, myTickWithExecCbSet, updateLogFileNameCallback(), and updateWebServerCallback().

void DtRtiexecObserverMgr::syncPtAchievedCallback ( DtFederate *  fed,
DtSyncPt *  pt,
void *  usr 
) [static]

Callback for achieved sync. points.

References DtFedExCbInfo::myExec, DtFedExCbInfo::myObserverMgr, and syncPtAchievedCallback().

Referenced by federationCreatedCallback(), federationDestroyedCallback(), and syncPtAchievedCallback().

void DtRtiexecObserverMgr::syncPtAchievedCallback ( DtFedExec *  exec,
DtFederate *  fed,
DtSyncPt *  pt 
)

References myObservers.

void DtRtiexecObserverMgr::syncPtRegisteredCallback ( DtSyncPt *  pt,
void *  usr 
) [static]

Callback for registered sync. points.

References DtFedExCbInfo::myExec, DtFedExCbInfo::myObserverMgr, and syncPtRegisteredCallback().

Referenced by federationCreatedCallback(), federationDestroyedCallback(), and syncPtRegisteredCallback().

void DtRtiexecObserverMgr::syncPtRegisteredCallback ( DtFedExec *  exec,
DtSyncPt *  pt 
)

References myObservers.

static void DtRtiexecObserverMgr::updateLogFileNameCallback ( const DtFilename &  logFile,
void *  usr 
) [static]

Callback for updated log file name.

Referenced by setExec(), and ~DtRtiexecObserverMgr().

void DtRtiexecObserverMgr::updateLogFileNameCallback ( const DtFilename &  logFile)
static void DtRtiexecObserverMgr::updateWebServerCallback ( const DtInetAddr &  webSpyIpAddr,
int  webSpyPort,
void *  usr 
) [static]

Callback for updated web server.

Referenced by setExec(), and ~DtRtiexecObserverMgr().

void DtRtiexecObserverMgr::updateWebServerCallback ( const DtInetAddr &  webSpyIpAddr,
int  webSpyPort 
)

Member Data Documentation

DtBoost::shared_ptr<DtRtiExec> DtRtiexecObserverMgr::myExec [protected]

The rtiexec which is being observed.

Referenced by addRtiMsgCallback(), addTickCallback(), connectionId(), federationCreatedCallback(), federationDestroyedCallback(), removeRtiMsgCallback(), removeTickCallback(), setExec(), and ~DtRtiexecObserverMgr().

DtFedexToCbInfoMap DtRtiexecObserverMgr::myFedexInfoMap [protected]

Map from fedex to fedex callback info.

Referenced by federationCreatedCallback(), and federationDestroyedCallback().

DtMsgCbSet DtRtiexecObserverMgr::myMsgCbSet [protected]

Set of all registered message callbacks.

Referenced by addRtiMsgCallback(), removeRtiMsgCallback(), and setExec().

DtExecObsList DtRtiexecObserverMgr::myObservers [protected]

List of rtiexec observers.

Referenced by addObserver(), federateDisconnectedCallback(), federateJoinedCallback(), federateReconnectFailedCallback(), federateReconnectSucceededCallback(), federateResignedCallback(), federationCreatedCallback(), federationDestroyedCallback(), federationSynchronizedCallback(), removeAllObservers(), removeObserver(), setExec(), syncPtAchievedCallback(), and syncPtRegisteredCallback().

DtTickCbSet DtRtiexecObserverMgr::myTickCbSet [protected]

Set of all registered tick callbacks.

Referenced by addTickCallback(), removeTickCallback(), and setExec().

DtTickWithExecCbSet DtRtiexecObserverMgr::myTickWithExecCbSet [protected]

Set of all registered tick callbacks that take a DtRtiExec reference.

Referenced by addTickCallback(), removeTickCallback(), and setExec().

The documentation for this class was generated from the following files:
Document ID: Generated on Thu Jun 14 14:15:04 EDT 2012 from SVN revision 116116
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)