VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Member Functions
DtScenarioService Class Reference

This class handles all operations involving scenarios.

Inheritance diagram for DtScenarioService:
Inheritance graph
[legend]

Public Member Functions

 DtScenarioService (DtSimulationServices *)
 
virtual ~DtScenarioService ()
 
virtual double dateAndTimeOfDay () const override
 
virtual void setActivities (const DtRwActivities &r) override
 
virtual const DtRwActivities & activities () const override
 
virtual void setScenarioFilename (const DtFilename &) override
 
virtual const DtFilename & scenarioFilename () const override
 
virtual DtFrameMode scenarioFrameMode () const override
 
virtual void setScenarioFrameMode (DtFrameMode frameMode) override
 
virtual void setRollUpRules (const DtAssembliesReaderWriter::RwRootNode &) override
 
virtual const
DtAssembliesReaderWriter::RwRootNode & 		rollUpRules () const override
 
virtual void enableAutoReorganization () override
 
virtual void disableAutoReorganization () override
 
virtual bool autoReorganizeEnabled () const override
 
virtual void setLoadingScenario (bool b) override
 
virtual bool loadingScenario () const override
 
virtual
DtSubordinateFunctionTable & 		subordinateFunctionTable () override
 
virtual const
DtSubordinateFunctionTable & 		subordinateFunctionTable () const override
 
virtual void advanceFrame () override
 
virtual bool setNextFrameEmbarkedOn (const DtUUID &object, const DtUUID &embarkingOn) override
 
virtual void setTaskVisualizationPublicationMode (DtTaskVisualizationPublicationMode mode) override
 
virtual
DtTaskVisualizationPublicationMode 		taskVisualizationPublicationMode () const override
 
virtual bool hasPermissionToDisplayTaskVisualizations (const DtUUID &uuid) override
 
virtual void stopCurrentTaskVisualizations (const DtUUID &uuid) override
 
virtual void setMaxObjectsWithTaskVisualizations (unsigned max) override
 
virtual unsigned maxObjectsWithTaskVisualizations () const override
 
virtual void setUseDrawControlForTaskVisualizations (bool) override
 
virtual bool useDrawControlForTaskVisualizations () const override
 
virtual void setScenarioImportData (const DtImportScenarioData &d) override
 
virtual void clearScenarioImportData () override
 
virtual bool importingScenario () const override
 
virtual const
DtImportScenarioData & 		scenarioImportData () override
 
virtual void setSearchPaths (const DtReaderWriter::SearchPaths &) override
 
virtual const
DtReaderWriter::SearchPaths & 		searchPaths () const override
 
- 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
 
DtFrameMode myScenarioFrameMode
 
DtRwActivities myActivities
 
DtAssembliesReaderWriter::RwRootNode myRollUpRules
 
DtTaskVisualizationPublicationMode myTaskVisualizationPublicationMode
 
bool myUseDrawControlForTaskVisualizations
 
std::set< DtUUID > myObjectsWithTaskVisualizations
 
tbb::spin_rw_mutex myObjectsWithTaskVisualizationsMutex
 
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 double DtScenarioService::dateAndTimeOfDay ( ) const
overridevirtual

Date and time of day of currently running scenario (UTC)

Implements DtScenarioServiceInterface.

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

Implements DtScenarioServiceInterface.

virtual const DtRwActivities& DtScenarioService::activities ( ) const
overridevirtual

Implements DtScenarioServiceInterface.

virtual void DtScenarioService::setScenarioFilename ( const DtFilename &  )
overridevirtual

Implements DtScenarioServiceInterface.

virtual const DtFilename& DtScenarioService::scenarioFilename ( ) const
overridevirtual

Implements DtScenarioServiceInterface.

virtual DtFrameMode DtScenarioService::scenarioFrameMode ( ) const
overridevirtual

Implements DtScenarioServiceInterface.

virtual void DtScenarioService::setScenarioFrameMode ( DtFrameMode  frameMode)
overridevirtual

Implements DtScenarioServiceInterface.

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

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

Implements DtScenarioServiceInterface.

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

Roll up rules.

Implements DtScenarioServiceInterface.

virtual void DtScenarioService::setTaskVisualizationPublicationMode ( DtTaskVisualizationPublicationMode  mode)
overridevirtual

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

Implements DtScenarioServiceInterface.

virtual DtTaskVisualizationPublicationMode DtScenarioService::taskVisualizationPublicationMode ( ) const
overridevirtual

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

Implements DtScenarioServiceInterface.

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

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)
overridevirtual

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

Implements DtScenarioServiceInterface.

virtual void DtScenarioService::setMaxObjectsWithTaskVisualizations ( unsigned  max)
overridevirtual

Maximum number of objects with enabled task visualizations.

Implements DtScenarioServiceInterface.

virtual unsigned DtScenarioService::maxObjectsWithTaskVisualizations ( ) const
overridevirtual

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

Implements DtScenarioServiceInterface.

virtual void DtScenarioService::setUseDrawControlForTaskVisualizations ( bool  )
overridevirtual

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

Implements DtScenarioServiceInterface.

virtual bool DtScenarioService::useDrawControlForTaskVisualizations ( ) const
overridevirtual

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

Implements DtScenarioServiceInterface.

virtual void DtScenarioService::enableAutoReorganization ( )
overridevirtual

Enables/disables auto reorganization of pseudo-aggregates.

Implements DtScenarioServiceInterface.

virtual void DtScenarioService::disableAutoReorganization ( )
overridevirtual

Implements DtScenarioServiceInterface.

virtual bool DtScenarioService::autoReorganizeEnabled ( ) const
overridevirtual

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

Implements DtScenarioServiceInterface.

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

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 ( )
overridevirtual

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
overridevirtual

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 ( )
overridevirtual

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)
overridevirtual

Implements DtScenarioServiceInterface.

virtual bool DtScenarioService::loadingScenario ( ) const
overridevirtual

Implements DtScenarioServiceInterface.

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

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
overridevirtual

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 ( )
overridevirtual

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
overridevirtual

Implements DtScenarioServiceInterface.

virtual void DtScenarioService::advanceFrame ( )
overridevirtual

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 
)
overridevirtual

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
DtFrameMode DtScenarioService::myScenarioFrameMode
protected
DtRwActivities DtScenarioService::myActivities
protected
DtAssembliesReaderWriter::RwRootNode DtScenarioService::myRollUpRules
protected
DtTaskVisualizationPublicationMode DtScenarioService::myTaskVisualizationPublicationMode
protected
bool DtScenarioService::myUseDrawControlForTaskVisualizations
protected
std::set<DtUUID> DtScenarioService::myObjectsWithTaskVisualizations
protected
tbb::spin_rw_mutex DtScenarioService::myObjectsWithTaskVisualizationsMutex
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:
Document ID: Generated on Thu Oct 23 22:29:17 EDT 2025 from SVN revision 280951
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)