DtScenarioEventManager Class Reference

The scenario event manager will keep track of all scenario event objects and their state. More...

Classes
struct	ScenarioEventInformation
	Information that is really only needed to keep track of status of scenario events. More...

Public Member Functions
	DtScenarioEventManager (DtSimManager *)
	CTOR.
virtual	~DtScenarioEventManager ()
	DTOR.
virtual DtSimManager *	simManager () const
virtual void	processScenarioEventMessageCallback (DtSimMessage *)
virtual void	startScenarioEvent (const DtString &, bool sendMessageIfNotLocal=true)
	Start the scenario event.
virtual DtString	eventIdFromEventName (const DtString &) const
	Returns the event id given the event name.
virtual void	stopScenarioEvent (const DtString &, bool sendMessageIfNotLocal=true)
	Stops the scenario event.
virtual bool	scenarioEventInProgress (const DtString &) const
	Returns true if scenario event is currently running.
virtual bool	scenarioEventConcluded (const DtString &) const
	Returns true if the scenario event has been concluded.
virtual DtRwScenarioEvent	scenarioEvent (const DtString &)
	Returns the scenario event for the current unique id.
virtual DtRwScenarioEvent	scenarioEvent (const DtVrfObject *)
	Returns the scenario event for the supplied object (if exists)
virtual double	simulationStartTime (const DtString &) const
	Returns the scenario time that the event started.
virtual double	simulationEndTime (const DtString &) const
	Returns the scenario time that the event ended.
virtual void	processScenarioEventAdded (DtVrfObject *)
virtual void	processScenarioEventRemoved (DtVrfObject *)
virtual void	setOrdinalOrder (const DtString &uniqueId, int ordinal)
	Sets the ordinal order for the given event if local. Does not change any other event ordinals.
virtual void	resetScenarioEvent (const DtString &uniqueId, bool sendMessageIfNotLocal=true)
	If local, resets the scenario event to be ready to start again.
virtual void	setTriggerStatus (const DtString &uniqueId, int)
	Sets the trigger status of the event if not already at that trigger status.
virtual void	addScenarioEventStartedCallback (DtScenarioEventManagerCallbackFcn fcn, void *usr)
	Callback that is invoked whenever a scenario event is started.
virtual void	removeScenarioEventStartedCallback (DtScenarioEventManagerCallbackFcn fcn, void *usr)
	Callback that is invoked whenever a scenario event is started.
virtual void	addScenarioEventStoppedCallback (DtScenarioEventManagerCallbackFcn fcn, void *usr)
	Callback that is invoked whenever a scenario event is stopped.
virtual void	removeScenarioEventStoppedCallback (DtScenarioEventManagerCallbackFcn fcn, void *usr)
	Callback that is invoked whenever a scenario event is stopped.

Static Public Member Functions
static void	scenarioEventMessageCallback (DtSimMessage *, void *usr)
	Processes scenario event operations.
static void	scenarioEventAdded (DtVrfObject *, void *)
	Called when a scenario event is added via the object manager.
static void	scenarioEventRemoved (DtVrfObject *, void *)
	Called when a scenario event is removed from the object manager.

Protected Types
typedef DtCallbackList< const DtString & >	ScenarioEventCallbacks
typedef std::map< DtString, ScenarioEventInformation >	ScenarioEvents
typedef std::map< DtString, DtString >	EntityIdentifierMap

Protected Member Functions
virtual void	startUpEvent (const DtString &uniqueId)
	Internally starts up the event and sends out started message as well as invoking started callbacks.
virtual void	stopEvent (const DtString &uniqueId)
	Internally stops event and sends out stopped message as well as invoking stopped callbacks.

Protected Attributes
DtSimManager *	mySimManager
ScenarioEventCallbacks	myScenarioEventStartedCallbacks
ScenarioEventCallbacks	myScenarioEventStoppedCallbacks
ScenarioEvents	myScenarioEvents
EntityIdentifierMap	myEntityIdentifierMap

Private Member Functions
	DtScenarioEventManager (const DtScenarioEventManager &orig)
	copy constructor
DtScenarioEventManager &	operator= (const DtScenarioEventManager &orig)
	assignment operator

Detailed Description

The scenario event manager will keep track of all scenario event objects and their state.

All calls to start/stop events must be done through this class. If not done through this class then event triggers will not fire

Member Typedef Documentation

typedef DtCallbackList<const DtString&> DtScenarioEventManager::ScenarioEventCallbacks

protected

typedef std::map<DtString, ScenarioEventInformation> DtScenarioEventManager::ScenarioEvents

protected

typedef std::map<DtString, DtString> DtScenarioEventManager::EntityIdentifierMap

protected

Constructor & Destructor Documentation

DtScenarioEventManager::DtScenarioEventManager

(

DtSimManager *

)

CTOR.

virtual DtScenarioEventManager::~DtScenarioEventManager ( )

virtual

DTOR.

DtScenarioEventManager::DtScenarioEventManager ( const DtScenarioEventManager &  orig )

private

copy constructor

Member Function Documentation

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

private

assignment operator

virtual DtSimManager* DtScenarioEventManager::simManager ( ) const

virtual

virtual void DtScenarioEventManager::addScenarioEventStartedCallback ( DtScenarioEventManagerCallbackFcn  fcn, void *  usr  )

virtual

Callback that is invoked whenever a scenario event is started.

virtual void DtScenarioEventManager::removeScenarioEventStartedCallback ( DtScenarioEventManagerCallbackFcn  fcn, void *  usr  )

virtual

Callback that is invoked whenever a scenario event is started.

virtual void DtScenarioEventManager::addScenarioEventStoppedCallback ( DtScenarioEventManagerCallbackFcn  fcn, void *  usr  )

virtual

Callback that is invoked whenever a scenario event is stopped.

virtual void DtScenarioEventManager::removeScenarioEventStoppedCallback ( DtScenarioEventManagerCallbackFcn  fcn, void *  usr  )

virtual

Callback that is invoked whenever a scenario event is stopped.

static void DtScenarioEventManager::scenarioEventMessageCallback ( DtSimMessage *  , void *  usr  )

static

Processes scenario event operations.

virtual void DtScenarioEventManager::processScenarioEventMessageCallback ( DtSimMessage *  )

virtual

virtual void DtScenarioEventManager::startScenarioEvent ( const DtString &  , bool  sendMessageIfNotLocal = true  )

virtual

Start the scenario event.

Will send a message to start if the event is not local or start it and send out started message if is. Supply scenario unique id

virtual DtString DtScenarioEventManager::eventIdFromEventName ( const DtString &  ) const

virtual

Returns the event id given the event name.

If there are multiple events with the same name the first event encountered is returned

virtual void DtScenarioEventManager::stopScenarioEvent ( const DtString &  , bool  sendMessageIfNotLocal = true  )

virtual

Stops the scenario event.

Will send a message to stop if the event is not local or stop it and send out stopped message if is. Supply scenario unique id

virtual bool DtScenarioEventManager::scenarioEventInProgress ( const DtString &  ) const

virtual

Returns true if scenario event is currently running.

virtual bool DtScenarioEventManager::scenarioEventConcluded ( const DtString &  ) const

virtual

Returns true if the scenario event has been concluded.

virtual DtRwScenarioEvent DtScenarioEventManager::scenarioEvent ( const DtString &  )

virtual

Returns the scenario event for the current unique id.

virtual DtRwScenarioEvent DtScenarioEventManager::scenarioEvent ( const DtVrfObject *  )

virtual

Returns the scenario event for the supplied object (if exists)

virtual double DtScenarioEventManager::simulationStartTime ( const DtString &  ) const

virtual

Returns the scenario time that the event started.

virtual double DtScenarioEventManager::simulationEndTime ( const DtString &  ) const

virtual

Returns the scenario time that the event ended.

static void DtScenarioEventManager::scenarioEventAdded ( DtVrfObject *  , void *    )

static

Called when a scenario event is added via the object manager.

virtual void DtScenarioEventManager::processScenarioEventAdded ( DtVrfObject *  )

virtual

static void DtScenarioEventManager::scenarioEventRemoved ( DtVrfObject *  , void *    )

static

Called when a scenario event is removed from the object manager.

virtual void DtScenarioEventManager::processScenarioEventRemoved ( DtVrfObject *  )

virtual

virtual void DtScenarioEventManager::setOrdinalOrder ( const DtString &  uniqueId, int  ordinal  )

virtual

Sets the ordinal order for the given event if local. Does not change any other event ordinals.

virtual void DtScenarioEventManager::resetScenarioEvent ( const DtString &  uniqueId, bool  sendMessageIfNotLocal = true  )

virtual

If local, resets the scenario event to be ready to start again.

virtual void DtScenarioEventManager::setTriggerStatus ( const DtString &  uniqueId, int    )

virtual

Sets the trigger status of the event if not already at that trigger status.

virtual void DtScenarioEventManager::startUpEvent ( const DtString &  uniqueId )

protectedvirtual

Internally starts up the event and sends out started message as well as invoking started callbacks.

virtual void DtScenarioEventManager::stopEvent ( const DtString &  uniqueId )

protectedvirtual

Internally stops event and sends out stopped message as well as invoking stopped callbacks.

Member Data Documentation

DtSimManager* DtScenarioEventManager::mySimManager

protected

ScenarioEventCallbacks DtScenarioEventManager::myScenarioEventStartedCallbacks

protected

ScenarioEventCallbacks DtScenarioEventManager::myScenarioEventStoppedCallbacks

protected

ScenarioEvents DtScenarioEventManager::myScenarioEvents

protected

EntityIdentifierMap DtScenarioEventManager::myEntityIdentifierMap

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrfobjcore/scenarioEventManager.h