makVrf::DtScenarioEventManager Class Reference

Inheritance diagram for makVrf::DtScenarioEventManager:

Public Types
typedef std::pair < makVrv::DtStateView < DtVrlinkSimulatedEnvironmentProcess > *, std::string >	ScenarioEventInformation
typedef std::map < makVrv::DtElementID, ScenarioEventInformation >	ScenarioEventItems

Public Member Functions
	DtScenarioEventManager (makVrv::DtDe &)
	CTOR.
virtual	~DtScenarioEventManager ()
	DTOR.
const ScenarioEventItems &	scenarioEventItems () const
virtual bool	hasScenarioEventData (makVrv::DtElementID) const
	Returns true if there is scenario event data for the specified item.
virtual DtRwScenarioEvent	scenarioEvent (makVrv::DtElementID) const
	Returns the scenario event for the particular element id.
virtual makVrv::DtElementID	nextScheduledEvent ()
	Returns the id of the next scheduled event given the current simulation time and/or time of day.
virtual bool	eventSupportsForce (int force, const std::string &eventId) const
	Returns true if the event supports the given force.
virtual int	size () const
	Returns the number of scenario events.
virtual void	addOrdinal (int)
	Adds a new ordinal at the given position, changing all other ordinals as needed.
virtual void	changeOrdinal (int from, int to)
	Changes the current ordinal to the new ordinal, changing other ordinals appropriately.
virtual DtRwScenarioEvent	scenarioEvent (const std::string &) const
	Returns the scenario event for the particular unique id.
virtual std::vector < DtRwScenarioEvent >	scenarioEvents () const
	Returns a list of all current scenario events.
virtual makVrv::DtElementID	elementIdFromUniqueId (const std::string &) const
	Returns the scenario event element id for the particular unique id.
virtual void	createModelDefinitionFor (const std::string &)
	Creates a model definition (ScenarioEventImage_<filename>) for the given image if one does not exist.
virtual bool	eventIsActive (makVrv::DtElementID) const
	Returns true if the event is currently active.
void	exportSettings (const std::string &fileName)
	Returns whether or not event information can be shown. Default is whether or not event is active.
void	importSettings (const std::string &fileName)
	Import the current cache settings from a file.
virtual bool	canShowEventInformation (makVrv::DtElementID) const
virtual std::string	eventNameFromUniqueId (const std::string &) const
virtual std::string	uniqueIdFromEventName (const std::string &) const
makVrv::DtRecordSettingsBackupInterface *	scenarioEventSettingsBackup ()
virtual int	nextOrdinal () const
	Returns the next ordinal available.
virtual void	setShowAllEvents (bool)
virtual bool	showAllEvents () const
virtual void	setShowAllEventsByVisibleForce (bool)
virtual bool	showAllEventsByVisibleForce () const
virtual void	setShowAllActiveEvents (bool)
virtual bool	showAllActiveEvents () const
virtual void	setShowAllActiveEventsByVisibleForce (bool)
virtual bool	showAllActiveEventsByVisibleForce () const
virtual void	setShowDialogsForStartedEvents (bool)
virtual bool	showDialogsForStartedEvents () const
virtual void	addDefaultSensorSignature (const makVrv::DtUnicode &type, const DtScenarioEventSettingsRecord::SensorSignatures &sigs)
virtual void	removeDefaultSensorSignature (const makVrv::DtUnicode &type)
virtual DtScenarioEventSettingsRecord::DefaultSensorSignatures	defaultSensorSignatures () const
virtual void	setDefaultSensorSignatures (const DtScenarioEventSettingsRecord::DefaultSensorSignatures &signatures)
virtual makVrv::DtUnicode	typeFromSignature (const DtScenarioEventSettingsRecord::SensorSignatures &sigs) const
virtual DtScenarioEventSettingsRecord::SensorSignatures	signaturesFromType (const makVrv::DtUnicode &type) const
virtual void	setFromRecord (const DtScenarioEventSettingsRecord &rec, bool updateFilter=true)
virtual void	loadDefaultScenarioEventSettings (bool loadOnlyFactorySettings=false)
virtual void	saveScenarioEventSettingsAsDefaults ()
virtual void	getRecord (DtScenarioEventSettingsRecord &rec) const
virtual void	setAutoSave (bool b)
virtual bool	autoSave () const
virtual void	setupFilter ()
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static DtScenarioEventManager &	instance (makVrv::DtDe &de)
	Returns DtScenarioEventManager of the manager.
static void	registerInstance (makVrv::DtDe &, DtScenarioEventManager *)
	Register a new manager instance.
static std::string	modelDefinitionFor (const std::string &)
	Returns a model definition that will match the given image name.

Public Attributes
boost::signal< void(const DtScenarioEventSettingsRecord &)>	signal_scenarioEventOptionsChanged
	Sent after anything about the scenario event options have changed.
boost::signal< void(makVrv::DtElementID)>	signal_removed
boost::signal< void(const makVrv::DtStateView < DtVrlinkSimulatedEnvironmentProcess > *)>	signal_updated
boost::signal< void(makVrv::DtElementID)>	signal_scenarioEventStarted
boost::signal< void(makVrv::DtElementID)>	signal_scenarioEventStopped

Protected Types
typedef std::map < makVrv::DtElementID, int >	EventStatus
typedef std::map< int, std::pair< makVrv::DtElementID, DtString > >	OrdinalOrder

Protected Member Functions
void	setupScenarioEventSettings ()
	Sets up settings for scenario events.
void	initScenarioEvents ()
	Sets up the list widget with all current scenario events.
virtual void	slot_onScenarioEventUpdatedBase (const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *)
	Called when an event state view is updated, if name has changed, then signal an update.
virtual void	slot_onScenarioEventUpdated (const makVrv::DtStateView< DtVrlinkSimulatedEnvironmentProcess > *)
virtual void	addIfScenarioEvent (const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *)
	Adds this item in if it is a scenario event item (by matching object type)
virtual void	scenarioEventAdded (const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *)
virtual void	scenarioEventRemoved (const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *)
virtual void	startScenarioEvent (makVrv::DtElementID)
virtual void	stopScenarioEvent (makVrv::DtElementID)

Protected Attributes
makVrv::DtDe &	myDe
makVrv::DtSignalConnectionManager	myConnectionManager
std::map< makVrv::DtElementID, bool >	myWaiting
ScenarioEventItems	myScenarioEventItems
DtScenarioEventSettingsRecord	myScenarioEventSettings
makVrv::DtRecordSettingsBackupInterface *	myScenarioEventSettingsBackup
EventStatus	myEventStatus
OrdinalOrder	myOrdinalOrder
bool	mySetup

Member Typedef Documentation

typedef std::pair<makVrv::DtStateView<DtVrlinkSimulatedEnvironmentProcess>*, std::string> makVrf::DtScenarioEventManager::ScenarioEventInformation

typedef std::map<makVrv::DtElementID, ScenarioEventInformation> makVrf::DtScenarioEventManager::ScenarioEventItems

typedef std::map<makVrv::DtElementID, int> makVrf::DtScenarioEventManager::EventStatus

protected

typedef std::map<int, std::pair<makVrv::DtElementID, DtString> > makVrf::DtScenarioEventManager::OrdinalOrder

protected

Constructor & Destructor Documentation

makVrf::DtScenarioEventManager::DtScenarioEventManager

(

makVrv::DtDe &

)

CTOR.

virtual makVrf::DtScenarioEventManager::~DtScenarioEventManager ( )

virtual

DTOR.

Member Function Documentation

static DtScenarioEventManager& makVrf::DtScenarioEventManager::instance ( makVrv::DtDe &  de )

static

Returns DtScenarioEventManager of the manager.

static void makVrf::DtScenarioEventManager::registerInstance ( makVrv::DtDe &  , DtScenarioEventManager *    )

static

Register a new manager instance.

const ScenarioEventItems& makVrf::DtScenarioEventManager::scenarioEventItems ( ) const

inline

virtual bool makVrf::DtScenarioEventManager::hasScenarioEventData ( makVrv::DtElementID  ) const

virtual

Returns true if there is scenario event data for the specified item.

virtual DtRwScenarioEvent makVrf::DtScenarioEventManager::scenarioEvent ( makVrv::DtElementID  ) const

virtual

Returns the scenario event for the particular element id.

virtual makVrv::DtElementID makVrf::DtScenarioEventManager::nextScheduledEvent ( )

virtual

Returns the id of the next scheduled event given the current simulation time and/or time of day.

This call will also take into account current fog of war settings as to what events are currently visible to the forces that ground truth is being shown for

virtual bool makVrf::DtScenarioEventManager::eventSupportsForce ( int  force, const std::string &  eventId  ) const

virtual

Returns true if the event supports the given force.

virtual int makVrf::DtScenarioEventManager::size ( ) const

virtual

Returns the number of scenario events.

virtual void makVrf::DtScenarioEventManager::addOrdinal ( int  )

virtual

Adds a new ordinal at the given position, changing all other ordinals as needed.

virtual void makVrf::DtScenarioEventManager::changeOrdinal ( int  from, int  to  )

virtual

Changes the current ordinal to the new ordinal, changing other ordinals appropriately.

virtual DtRwScenarioEvent makVrf::DtScenarioEventManager::scenarioEvent ( const std::string &  ) const

virtual

Returns the scenario event for the particular unique id.

virtual std::vector<DtRwScenarioEvent> makVrf::DtScenarioEventManager::scenarioEvents ( ) const

virtual

Returns a list of all current scenario events.

virtual makVrv::DtElementID makVrf::DtScenarioEventManager::elementIdFromUniqueId ( const std::string &  ) const

virtual

Returns the scenario event element id for the particular unique id.

virtual void makVrf::DtScenarioEventManager::createModelDefinitionFor ( const std::string &  )

virtual

Creates a model definition (ScenarioEventImage_<filename>) for the given image if one does not exist.

Marks it as temporary so it will not be saved if the model definitions change

static std::string makVrf::DtScenarioEventManager::modelDefinitionFor ( const std::string &  )

static

Returns a model definition that will match the given image name.

virtual bool makVrf::DtScenarioEventManager::eventIsActive ( makVrv::DtElementID  ) const

virtual

Returns true if the event is currently active.

void makVrf::DtScenarioEventManager::exportSettings

(

const std::string &

fileName

)

Returns whether or not event information can be shown. Default is whether or not event is active.

Exports the current cache settings to a file

void makVrf::DtScenarioEventManager::importSettings

(

const std::string &

fileName

)

Import the current cache settings from a file.

virtual bool makVrf::DtScenarioEventManager::canShowEventInformation ( makVrv::DtElementID  ) const

virtual

virtual std::string makVrf::DtScenarioEventManager::eventNameFromUniqueId ( const std::string &  ) const

virtual

virtual std::string makVrf::DtScenarioEventManager::uniqueIdFromEventName ( const std::string &  ) const

virtual

makVrv::DtRecordSettingsBackupInterface* makVrf::DtScenarioEventManager::scenarioEventSettingsBackup ( )

inline

virtual int makVrf::DtScenarioEventManager::nextOrdinal ( ) const

virtual

Returns the next ordinal available.

virtual void makVrf::DtScenarioEventManager::setShowAllEvents ( bool  )

virtual

Mutators/accessors for scenario event options

virtual bool makVrf::DtScenarioEventManager::showAllEvents ( ) const

virtual

Mutators/accessors for scenario event options

virtual void makVrf::DtScenarioEventManager::setShowAllEventsByVisibleForce ( bool  )

virtual

Mutators/accessors for scenario event options

virtual bool makVrf::DtScenarioEventManager::showAllEventsByVisibleForce ( ) const

virtual

Mutators/accessors for scenario event options

virtual void makVrf::DtScenarioEventManager::setShowAllActiveEvents ( bool  )

virtual

Mutators/accessors for scenario event options

virtual bool makVrf::DtScenarioEventManager::showAllActiveEvents ( ) const

virtual

Mutators/accessors for scenario event options

virtual void makVrf::DtScenarioEventManager::setShowAllActiveEventsByVisibleForce ( bool  )

virtual

Mutators/accessors for scenario event options

virtual bool makVrf::DtScenarioEventManager::showAllActiveEventsByVisibleForce ( ) const

virtual

Mutators/accessors for scenario event options

virtual void makVrf::DtScenarioEventManager::setShowDialogsForStartedEvents ( bool  )

virtual

Mutators/accessors for scenario event options

virtual bool makVrf::DtScenarioEventManager::showDialogsForStartedEvents ( ) const

virtual

Mutators/accessors for scenario event options

virtual void makVrf::DtScenarioEventManager::addDefaultSensorSignature ( const makVrv::DtUnicode &  type, const DtScenarioEventSettingsRecord::SensorSignatures &  sigs  )

virtual

Mutators/accessors for scenario event options

virtual void makVrf::DtScenarioEventManager::removeDefaultSensorSignature ( const makVrv::DtUnicode &  type )

virtual

Mutators/accessors for scenario event options

virtual DtScenarioEventSettingsRecord::DefaultSensorSignatures makVrf::DtScenarioEventManager::defaultSensorSignatures ( ) const

virtual

Mutators/accessors for scenario event options

virtual void makVrf::DtScenarioEventManager::setDefaultSensorSignatures ( const DtScenarioEventSettingsRecord::DefaultSensorSignatures &  signatures )

virtual

Mutators/accessors for scenario event options

virtual makVrv::DtUnicode makVrf::DtScenarioEventManager::typeFromSignature ( const DtScenarioEventSettingsRecord::SensorSignatures &  sigs ) const

virtual

Mutators/accessors for scenario event options

virtual DtScenarioEventSettingsRecord::SensorSignatures makVrf::DtScenarioEventManager::signaturesFromType ( const makVrv::DtUnicode &  type ) const

virtual

Mutators/accessors for scenario event options

virtual void makVrf::DtScenarioEventManager::setFromRecord ( const DtScenarioEventSettingsRecord &  rec, bool  updateFilter = true  )

virtual

Mutators/accessors for scenario event options

virtual void makVrf::DtScenarioEventManager::loadDefaultScenarioEventSettings ( bool  loadOnlyFactorySettings = false )

virtual

Mutators/accessors for scenario event options

virtual void makVrf::DtScenarioEventManager::saveScenarioEventSettingsAsDefaults ( )

virtual

Mutators/accessors for scenario event options

virtual void makVrf::DtScenarioEventManager::getRecord ( DtScenarioEventSettingsRecord &  rec ) const

virtual

Mutators/accessors for scenario event options

virtual void makVrf::DtScenarioEventManager::setAutoSave ( bool  b )

virtual

Mutators/accessors for scenario event options

virtual bool makVrf::DtScenarioEventManager::autoSave ( ) const

virtual

Mutators/accessors for scenario event options

virtual void makVrf::DtScenarioEventManager::setupFilter ( )

virtual

Mutators/accessors for scenario event options

void makVrf::DtScenarioEventManager::setupScenarioEventSettings ( )

protected

Sets up settings for scenario events.

void makVrf::DtScenarioEventManager::initScenarioEvents ( )

protected

Sets up the list widget with all current scenario events.

virtual void makVrf::DtScenarioEventManager::slot_onScenarioEventUpdatedBase ( const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *  )

protectedvirtual

Called when an event state view is updated, if name has changed, then signal an update.

virtual void makVrf::DtScenarioEventManager::slot_onScenarioEventUpdated ( const makVrv::DtStateView< DtVrlinkSimulatedEnvironmentProcess > *  )

protectedvirtual

virtual void makVrf::DtScenarioEventManager::addIfScenarioEvent ( const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *  )

protectedvirtual

Adds this item in if it is a scenario event item (by matching object type)

virtual void makVrf::DtScenarioEventManager::scenarioEventAdded ( const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *  )

protectedvirtual

virtual void makVrf::DtScenarioEventManager::scenarioEventRemoved ( const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *  )

protectedvirtual

virtual void makVrf::DtScenarioEventManager::startScenarioEvent ( makVrv::DtElementID  )

protectedvirtual

virtual void makVrf::DtScenarioEventManager::stopScenarioEvent ( makVrv::DtElementID  )

protectedvirtual

Member Data Documentation

boost::signal<void (const DtScenarioEventSettingsRecord&)> makVrf::DtScenarioEventManager::signal_scenarioEventOptionsChanged

Sent after anything about the scenario event options have changed.

boost::signal<void (makVrv::DtElementID)> makVrf::DtScenarioEventManager::signal_removed

boost::signal<void (const makVrv::DtStateView<DtVrlinkSimulatedEnvironmentProcess>*)> makVrf::DtScenarioEventManager::signal_updated

boost::signal<void (makVrv::DtElementID)> makVrf::DtScenarioEventManager::signal_scenarioEventStarted

boost::signal<void (makVrv::DtElementID)> makVrf::DtScenarioEventManager::signal_scenarioEventStopped

makVrv::DtDe& makVrf::DtScenarioEventManager::myDe

protected

makVrv::DtSignalConnectionManager makVrf::DtScenarioEventManager::myConnectionManager

protected

std::map<makVrv::DtElementID, bool> makVrf::DtScenarioEventManager::myWaiting

protected

ScenarioEventItems makVrf::DtScenarioEventManager::myScenarioEventItems

protected

DtScenarioEventSettingsRecord makVrf::DtScenarioEventManager::myScenarioEventSettings

protected

makVrv::DtRecordSettingsBackupInterface* makVrf::DtScenarioEventManager::myScenarioEventSettingsBackup

protected

EventStatus makVrf::DtScenarioEventManager::myEventStatus

protected

OrdinalOrder makVrf::DtScenarioEventManager::myOrdinalOrder

protected

bool makVrf::DtScenarioEventManager::mySetup

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfGuiCore/scenarioEventManager.h