DtScenarioServiceInterface Class Reference

Service interface for checking and altering scenario wide properties.

Inheritance diagram for DtScenarioServiceInterface:

Public Member Functions
	DtScenarioServiceInterface ()
virtual void	setActivities (const DtRwActivities &r)=0
virtual const DtRwActivities &	activities () const =0
virtual const DtFilename &	scenarioFilename () const =0
virtual void	setScenarioFilename (const DtFilename &)=0
virtual void	setRollUpRules (const DtAssembliesReaderWriter::RwRootNode &)=0
virtual const DtAssembliesReaderWriter::RwRootNode &	rollUpRules () const =0
virtual void	enableAutoReorganization ()=0
virtual void	disableAutoReorganization ()=0
virtual bool	autoReorganizeEnabled () const =0
virtual void	setLoadingScenario (bool b)=0
virtual bool	loadingScenario () const =0
virtual void	setSearchPaths (const std::vector< DtFilename > &)=0
virtual const std::vector < DtFilename > &	searchPaths () const =0
virtual DtSubordinateFunctionTable &	subordinateFunctionTable ()=0
virtual const DtSubordinateFunctionTable &	subordinateFunctionTable () const =0
virtual void	advanceFrame ()=0
virtual bool	setNextFrameEmbarkedOn (const DtUUID &object, const DtUUID &embarkingOn)=0
Task visualization support
If and when task visualizations should be published to the network.
virtual void	setTaskVisualizationPublicationMode (DtTaskVisualizationPublicationMode mode)=0
virtual DtTaskVisualizationPublicationMode	taskVisualizationPublicationMode () const =0
virtual bool	hasPermissionToDisplayTaskVisualizations (const DtUUID &uuid)=0
virtual void	stopCurrentTaskVisualizations (const DtUUID &uuid)=0
virtual void	setMaxObjectsWithTaskVisualizations (unsigned max)=0
virtual unsigned	maxObjectsWithTaskVisualizations () const =0
virtual void	setUseDrawControlForTaskVisualizations (bool)=0
virtual bool	useDrawControlForTaskVisualizations () const =0
Scenario Import Data functions
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
virtual void	setScenarioImportData (const DtImportScenarioData &d)=0
virtual void	clearScenarioImportData ()=0
virtual bool	importingScenario () const =0
virtual const DtImportScenarioData &	scenarioImportData ()=0

Public Attributes
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

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

Constructor & Destructor Documentation

DtScenarioServiceInterface::DtScenarioServiceInterface ( const DtScenarioServiceInterface &  )

private

Not implemented.

DtScenarioServiceInterface::DtScenarioServiceInterface

(

)

Member Function Documentation

DtScenarioServiceInterface& DtScenarioServiceInterface::operator= ( const DtScenarioServiceInterface &  )

private

Not implemented.

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

pure virtual

Implemented in DtScenarioService.

virtual const DtRwActivities& DtScenarioServiceInterface::activities ( ) const

pure virtual

Implemented in DtScenarioService.

virtual const DtFilename& DtScenarioServiceInterface::scenarioFilename ( ) const

pure virtual

Implemented in DtScenarioService.

virtual void DtScenarioServiceInterface::setScenarioFilename ( const DtFilename &  )

pure virtual

Implemented in DtScenarioService.

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

pure virtual

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

Implemented in DtScenarioService.

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

pure virtual

Roll up rules.

Implemented in DtScenarioService.

virtual void DtScenarioServiceInterface::setTaskVisualizationPublicationMode ( DtTaskVisualizationPublicationMode  mode )

pure 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.

Implemented in DtScenarioService.

virtual DtTaskVisualizationPublicationMode DtScenarioServiceInterface::taskVisualizationPublicationMode ( ) const

pure 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.

Implemented in DtScenarioService.

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

pure 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.

Implemented in DtScenarioService.

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

pure 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.

Implemented in DtScenarioService.

virtual void DtScenarioServiceInterface::setMaxObjectsWithTaskVisualizations ( unsigned  max )

pure virtual

Maximum number of objects with enabled task visualizations.

Implemented in DtScenarioService.

virtual unsigned DtScenarioServiceInterface::maxObjectsWithTaskVisualizations ( ) const

pure 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.

Implemented in DtScenarioService.

virtual void DtScenarioServiceInterface::setUseDrawControlForTaskVisualizations ( bool  )

pure virtual

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

Implemented in DtScenarioService.

virtual bool DtScenarioServiceInterface::useDrawControlForTaskVisualizations ( ) const

pure 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.

Implemented in DtScenarioService.

virtual void DtScenarioServiceInterface::enableAutoReorganization ( )

pure virtual

Enables/disables auto reorganization of pseudo-aggregates.

Implemented in DtScenarioService.

virtual void DtScenarioServiceInterface::disableAutoReorganization ( )

pure virtual

Implemented in DtScenarioService.

virtual bool DtScenarioServiceInterface::autoReorganizeEnabled ( ) const

pure virtual

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

Implemented in DtScenarioService.

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

pure virtual

Implemented in DtScenarioService.

virtual void DtScenarioServiceInterface::clearScenarioImportData ( )

pure virtual

Implemented in DtScenarioService.

virtual bool DtScenarioServiceInterface::importingScenario ( ) const

pure virtual

Implemented in DtScenarioService.

virtual const DtImportScenarioData& DtScenarioServiceInterface::scenarioImportData ( )

pure virtual

Implemented in DtScenarioService.

virtual void DtScenarioServiceInterface::setLoadingScenario ( bool  b )

pure virtual

Implemented in DtScenarioService.

virtual bool DtScenarioServiceInterface::loadingScenario ( ) const

pure virtual

Implemented in DtScenarioService.

virtual void DtScenarioServiceInterface::setSearchPaths ( const std::vector< DtFilename > &  )

pure virtual

Search paths used to load information in this scenario.

Implemented in DtScenarioService.

virtual const std::vector<DtFilename>& DtScenarioServiceInterface::searchPaths ( ) const

pure virtual

Implemented in DtScenarioService.

virtual DtSubordinateFunctionTable& DtScenarioServiceInterface::subordinateFunctionTable ( )

pure virtual

returns a map of string key-value pairs representing subordinateFunction handles and role name text

Implemented in DtScenarioService.

virtual const DtSubordinateFunctionTable& DtScenarioServiceInterface::subordinateFunctionTable ( ) const

pure virtual

Implemented in DtScenarioService.

virtual void DtScenarioServiceInterface::advanceFrame ( )

pure virtual

Code for making sure that embarkation would not be recursive this frame.

Implemented in DtScenarioService.

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

pure virtual

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

Implemented in DtScenarioService.

Member Data Documentation

boost::signals2::signal<void (DtSimObjectStateRepository*, DtLegacySimObjectStateRepositoryRWData*)> DtScenarioServiceInterface::signal_prePutLegacyData

Signal sent by the VRF State Repository when archiving/resotring data. These are the signals to hook up to to archive/dearchive your own data as this will be written to the order of battle file.

boost::signals2::signal<void (DtSimObjectStateRepository*, DtLegacySimObjectStateRepositoryRWData*)> DtScenarioServiceInterface::signal_postPutLegacyData

boost::signals2::signal<void (DtSimObjectStateRepository*, DtLegacySimObjectStateRepositoryRWData*)> DtScenarioServiceInterface::signal_preGetLegacyData

boost::signals2::signal<void (DtSimObjectStateRepository*, DtLegacySimObjectStateRepositoryRWData*)> DtScenarioServiceInterface::signal_postGetLegacyData

---

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

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