DtScenarioService Class Reference

This class handles all operations involving scenarios.

Inheritance diagram for DtScenarioService:

Public Member Functions
	DtScenarioService (DtSimulationServices *)
virtual	~DtScenarioService ()
virtual void	setActivities (const DtRwActivities &r)
virtual const DtRwActivities &	activities () const
virtual void	setScenarioFilename (const DtFilename &)
virtual const DtFilename &	scenarioFilename () const
virtual void	setRollUpRules (const DtAssembliesReaderWriter::RwRootNode &)
virtual const DtAssembliesReaderWriter::RwRootNode &	rollUpRules () const
virtual void	enableAutoReorganization ()
virtual void	disableAutoReorganization ()
virtual bool	autoReorganizeEnabled () const
virtual void	setLoadingScenario (bool b)
virtual bool	loadingScenario () const
virtual DtSubordinateFunctionTable &	subordinateFunctionTable ()
virtual const DtSubordinateFunctionTable &	subordinateFunctionTable () const
virtual void	advanceFrame ()
virtual bool	setNextFrameEmbarkedOn (const DtUUID &object, const DtUUID &embarkingOn)
virtual void	setTaskVisualizationPublicationMode (DtTaskVisualizationPublicationMode mode)
virtual DtTaskVisualizationPublicationMode	taskVisualizationPublicationMode () const
virtual bool	hasPermissionToDisplayTaskVisualizations (const DtUUID &uuid)
virtual void	stopCurrentTaskVisualizations (const DtUUID &uuid)
virtual void	setMaxObjectsWithTaskVisualizations (unsigned max)
virtual unsigned	maxObjectsWithTaskVisualizations () const
virtual void	setUseDrawControlForTaskVisualizations (bool)
virtual bool	useDrawControlForTaskVisualizations () const
virtual void	setScenarioImportData (const DtImportScenarioData &d)
virtual void	clearScenarioImportData ()
virtual bool	importingScenario () const
virtual const DtImportScenarioData &	scenarioImportData ()
virtual void	setSearchPaths (const DtReaderWriter::SearchPaths &)
virtual const DtReaderWriter::SearchPaths &	searchPaths () const
Public Member Functions inherited from DtScenarioServiceInterface
	DtScenarioServiceInterface ()

Protected Types
typedef std::map< DtUUID, DtUUID >	NextFrameEmbarkedOn

Protected Member Functions
virtual void	processAutoReorganize (DtSimMessage *msg)
virtual bool	wouldBeRecursiveAttach (const DtUUID &object, const DtUUID &embarkingOn) const
virtual DtUUID	nextFrameEmbarkedOn (const DtUUID &object) const

Static Protected Member Functions
static void	autoReorganizeCallback (DtSimMessage *msg, void *usr)

Protected Attributes
DtSimulationServices *	mySimulationServices
DtFilename	myScenarioFilename
DtRwActivities	myActivities
DtAssembliesReaderWriter::RwRootNode	myRollUpRules
DtTaskVisualizationPublicationMode	myTaskVisualizationPublicationMode
bool	myUseDrawControlForTaskVisualizations
std::set< DtUUID >	myObjectsWithTaskVisualizations
unsigned	myMaxObjectsWithTaskVisualizations
bool	myWarnedAboutTaskVisLimit
bool	myAutoReorganizeFlag
DtImportScenarioData	myScenarioImportData
bool	myLoadingScenario
bool	myImportingScenario
DtReaderWriter::SearchPaths	mySearchPaths
DtSubordinateFunctionTable	mySubordinateFunctionTable
tbb::spin_rw_mutex	myEmbarkingMutex
NextFrameEmbarkedOn	myNextFrameEmbarkedOn

Private Member Functions
	DtScenarioService (const DtScenarioService &)
DtScenarioService &	operator= (const DtScenarioService &)

Additional Inherited Members
Public Attributes inherited from DtScenarioServiceInterface
boost::signals2::signal< void(DtSimObjectStateRepository *, DtLegacySimObjectStateRepositoryRWData *)>	signal_prePutLegacyData
boost::signals2::signal< void(DtSimObjectStateRepository *, DtLegacySimObjectStateRepositoryRWData *)>	signal_postPutLegacyData
boost::signals2::signal< void(DtSimObjectStateRepository *, DtLegacySimObjectStateRepositoryRWData *)>	signal_preGetLegacyData
boost::signals2::signal< void(DtSimObjectStateRepository *, DtLegacySimObjectStateRepositoryRWData *)>	signal_postGetLegacyData

Member Typedef Documentation

typedef std::map<DtUUID, DtUUID> DtScenarioService::NextFrameEmbarkedOn

protected

Constructor & Destructor Documentation

DtScenarioService::DtScenarioService ( const DtScenarioService &  )

private

DtScenarioService::DtScenarioService

(

DtSimulationServices *

)

virtual DtScenarioService::~DtScenarioService ( )

virtual

Member Function Documentation

DtScenarioService& DtScenarioService::operator= ( const DtScenarioService &  )

private

virtual void DtScenarioService::setActivities ( const DtRwActivities &  r )

virtual

Implements DtScenarioServiceInterface.

virtual const DtRwActivities& DtScenarioService::activities ( ) const

virtual

Implements DtScenarioServiceInterface.

virtual void DtScenarioService::setScenarioFilename ( const DtFilename &  )

virtual

Implements DtScenarioServiceInterface.

virtual const DtFilename& DtScenarioService::scenarioFilename ( ) const

virtual

Implements DtScenarioServiceInterface.

virtual void DtScenarioService::setRollUpRules ( const DtAssembliesReaderWriter::RwRootNode &  )

virtual

Sets the roll up rules to be used when organizing state and parameter data.

Implements DtScenarioServiceInterface.

virtual const DtAssembliesReaderWriter::RwRootNode& DtScenarioService::rollUpRules ( ) const

virtual

Roll up rules.

Implements DtScenarioServiceInterface.

virtual void DtScenarioService::setTaskVisualizationPublicationMode ( DtTaskVisualizationPublicationMode  mode )

virtual

Task visualization support If and when task visualizations should be published to the network.

Implements DtScenarioServiceInterface.

virtual DtTaskVisualizationPublicationMode DtScenarioService::taskVisualizationPublicationMode ( ) const

virtual

Task visualization support If and when task visualizations should be published to the network.

Implements DtScenarioServiceInterface.

virtual bool DtScenarioService::hasPermissionToDisplayTaskVisualizations ( const DtUUID &  uuid )

virtual

Called by an entity's task manager to determine if it has permission to display task visualizations. Will return false if we have already reached the limit of the number of objects with displayed visualizations.

Implements DtScenarioServiceInterface.

virtual void DtScenarioService::stopCurrentTaskVisualizations ( const DtUUID &  uuid )

virtual

Task visualization support If and when task visualizations should be published to the network.

Implements DtScenarioServiceInterface.

virtual void DtScenarioService::setMaxObjectsWithTaskVisualizations ( unsigned  max )

virtual

Maximum number of objects with enabled task visualizations.

Implements DtScenarioServiceInterface.

virtual unsigned DtScenarioService::maxObjectsWithTaskVisualizations ( ) const

virtual

Task visualization support If and when task visualizations should be published to the network.

Implements DtScenarioServiceInterface.

virtual void DtScenarioService::setUseDrawControlForTaskVisualizations ( bool  )

virtual

Publish task visualizations as VRV draw control objects rather than their standard, VR-Forces specific format.

Implements DtScenarioServiceInterface.

virtual bool DtScenarioService::useDrawControlForTaskVisualizations ( ) const

virtual

Task visualization support If and when task visualizations should be published to the network.

Implements DtScenarioServiceInterface.

virtual void DtScenarioService::enableAutoReorganization ( )

virtual

Enables/disables auto reorganization of pseudo-aggregates.

Implements DtScenarioServiceInterface.

virtual void DtScenarioService::disableAutoReorganization ( )

virtual

Implements DtScenarioServiceInterface.

virtual bool DtScenarioService::autoReorganizeEnabled ( ) const

virtual

Returns true if auto-reorganization is enabled, false if not.

Implements DtScenarioServiceInterface.

virtual void DtScenarioService::setScenarioImportData ( const DtImportScenarioData &  d )

virtual

When importing a scenario or creating a simulation object group, this is the data that is used to indicate what is happening with that import or creation.

Implements DtScenarioServiceInterface.

virtual void DtScenarioService::clearScenarioImportData ( )

virtual

When importing a scenario or creating a simulation object group, this is the data that is used to indicate what is happening with that import or creation.

Implements DtScenarioServiceInterface.

virtual bool DtScenarioService::importingScenario ( ) const

virtual

When importing a scenario or creating a simulation object group, this is the data that is used to indicate what is happening with that import or creation.

Implements DtScenarioServiceInterface.

virtual const DtImportScenarioData& DtScenarioService::scenarioImportData ( )

virtual

When importing a scenario or creating a simulation object group, this is the data that is used to indicate what is happening with that import or creation.

Implements DtScenarioServiceInterface.

virtual void DtScenarioService::setLoadingScenario ( bool  b )

virtual

Implements DtScenarioServiceInterface.

virtual bool DtScenarioService::loadingScenario ( ) const

virtual

Implements DtScenarioServiceInterface.

virtual void DtScenarioService::setSearchPaths ( const DtReaderWriter::SearchPaths &  )

virtual

These are the search paths that were used when loading the parameter database. These can be used to pass into search paths for a get self if called outside of parameter database loading.

Implements DtScenarioServiceInterface.

virtual const DtReaderWriter::SearchPaths& DtScenarioService::searchPaths ( ) const

virtual

These are the search paths that were used when loading the parameter database. These can be used to pass into search paths for a get self if called outside of parameter database loading.

Implements DtScenarioServiceInterface.

virtual DtSubordinateFunctionTable& DtScenarioService::subordinateFunctionTable ( )

virtual

returns a map of string key-value pairs representing subordinateFunction handles and role name text. The accessor for write call is not thread safe, so, do not use in a thread for modification

Implements DtScenarioServiceInterface.

virtual const DtSubordinateFunctionTable& DtScenarioService::subordinateFunctionTable ( ) const

virtual

Implements DtScenarioServiceInterface.

virtual void DtScenarioService::advanceFrame ( )

virtual

Code that is used to manager what is embarked this frame and whether or not a new embarkation would be recursive.

Implements DtScenarioServiceInterface.

virtual bool DtScenarioService::setNextFrameEmbarkedOn ( const DtUUID &  object, const DtUUID &  embarkingOn  )

virtual

Return true if this object can be embarked on the other object next frame.

Implements DtScenarioServiceInterface.

static void DtScenarioService::autoReorganizeCallback ( DtSimMessage *  msg, void *  usr  )

staticprotected

Registered with the message executive to handle the AutoReorganize message.

virtual void DtScenarioService::processAutoReorganize ( DtSimMessage *  msg )

protectedvirtual

virtual bool DtScenarioService::wouldBeRecursiveAttach ( const DtUUID &  object, const DtUUID &  embarkingOn  ) const

protectedvirtual

virtual DtUUID DtScenarioService::nextFrameEmbarkedOn ( const DtUUID &  object ) const

protectedvirtual

Member Data Documentation

DtSimulationServices* DtScenarioService::mySimulationServices

protected

DtFilename DtScenarioService::myScenarioFilename

protected

DtRwActivities DtScenarioService::myActivities

protected

DtAssembliesReaderWriter::RwRootNode DtScenarioService::myRollUpRules

protected

DtTaskVisualizationPublicationMode DtScenarioService::myTaskVisualizationPublicationMode

protected

bool DtScenarioService::myUseDrawControlForTaskVisualizations

protected

std::set<DtUUID> DtScenarioService::myObjectsWithTaskVisualizations

protected

unsigned DtScenarioService::myMaxObjectsWithTaskVisualizations

protected

bool DtScenarioService::myWarnedAboutTaskVisLimit

protected

bool DtScenarioService::myAutoReorganizeFlag

protected

DtImportScenarioData DtScenarioService::myScenarioImportData

protected

bool DtScenarioService::myLoadingScenario

protected

bool DtScenarioService::myImportingScenario

protected

DtReaderWriter::SearchPaths DtScenarioService::mySearchPaths

protected

DtSubordinateFunctionTable DtScenarioService::mySubordinateFunctionTable

protected

tbb::spin_rw_mutex DtScenarioService::myEmbarkingMutex

protected

NextFrameEmbarkedOn DtScenarioService::myNextFrameEmbarkedOn

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfobjcore/scenarioService.h