makVrf::DtVrfSimulationSettingsManager Class Reference

The class that will contain information about various scenario settings. More...

Inheritance diagram for makVrf::DtVrfSimulationSettingsManager:

Public Member Functions
	DtVrfSimulationSettingsManager (makVrv::DtDe &)
virtual	~DtVrfSimulationSettingsManager ()
virtual void	setDefaultScenarioFile (const std::string &f, bool save=false)
	Sets the scenario file used as the default when creating a new scenario.
virtual std::string	defaultScenarioFile () const
virtual void	setSimulationObjectGroupTerrain (const std::string &f, bool save=false)
	Simulation object group terrain to use when editing simulation object groups.
virtual std::string	simulationObjectGroupTerrain () const
virtual void	setDefaultSimulationModelSetFile (const std::string &f, bool save=false, bool signalChange=true)
	Sets the default .sms file to use when loading a scenario if none is found in the scenario to be loaded.
virtual std::string	defaultSimulationModelSetFile () const
virtual void	setFromRecord (const DtVrfSimulationSettingsRecord &rec)
virtual void	loadDefaultSimulationSettings (bool loadOnlyFactorySettings=false)
virtual void	getRecord (DtVrfSimulationSettingsRecord &rec) const
virtual void	getSplitRecord (std::vector< DtVrfSimulationSettingsRecord > &rec, std::vector< std::string > &fileNames)
	To support writing element definitions in folders as multiple files not implemented.
virtual void	addRecords (DtVrfSimulationSettingsRecord &recs, DtVrfSimulationSettingsRecord &combinedRec)
	To support writing element definitions in folders as multiple files not implemented.
virtual void	setAutoSave (bool)
	Set to false to not save on settings change. Default is true.
virtual bool	autoSave () const
virtual void	setCheckForUnusedTriggersOnPlanSave (bool)
	Sets whether or not to always check for unused triggers when saving plan.
virtual bool	checkForUnusedTriggersOnPlanSave () const
virtual void	setDefaultScenarioStartTime (time_t)
	The default scenario start time.
virtual time_t	defaultScenarioStartTime () const
virtual void	setDefaultEnvironmentCondition (const std::string &defaultCondition, bool save=true)
	The default scenario environment condition.
virtual std::string	defaultEnvironmentCondition () const
virtual void	setEnablePeriodicCheckpointing (bool)
	Sets whether or not snapshots are periodically saved to disk (checkpointed)
virtual bool	enablePeriodicCheckpointing () const
virtual void	setPeriodicCheckpointingFrequency (int)
	Checkpoint every nth snapshot.
virtual int	periodicCheckpointingFrequency () const
virtual void	setPeriodicCheckpointingDirectory (const std::string &)
	Sets the directory to save checkpoints to. If blank saves to scenario directory.
virtual const std::string &	periodicCheckpointingDirectory () const
const DtFilename &	periodicCheckpointingDirectoryResolved () const
makVrv::DtRecordSettingsBackupInterface *	simulationSettingsBackup ()
void	exportSimulationSettings (const std::string &fileName)
	Exports the current cache settings to a file.
void	importSimulationSettings (const std::string &fileName)
	Import the current cache settings from a file.
virtual void	setStartupTerrain (const std::string &)
	Preference on which terrain to use when creating a new scenario.
virtual const std::string &	startupTerrain () const
virtual void	setStartupScenario (const std::string &)
	Preference on which scenario to use when loading a new scenario. Blank means choose.
virtual const std::string &	startupScenario () const
virtual void	setStartupSimulationModelSet (const std::string &)
	Preference on which simulation model set to use when loading a new scenario.
virtual const std::string &	startupSimulationModelSet () const
virtual void	setAllowOrbatDeletionChoice (bool)
virtual bool	allowOrbatDeletionChoice () const
virtual void	setAggregateOnCreate (bool)
	Sets to whether or not create aggregates as true aggregates (true) or psuedo aggregates (false) when initially created.
bool	aggregateOnCreate () const
virtual void	saveSettingsAsDefault ()
	Saves if auto-save is turned on.
virtual void	setSimulationModelSetConfigurations (const std::vector< DtVrfSimulationSettingsRecord::SimulationModelSetConfiguration > &)
	Sets the simulation model set configurations. See DtVrfSimulationSettingsRecord for format.
virtual const std::vector < DtVrfSimulationSettingsRecord::SimulationModelSetConfiguration > &	simulationModelSetConfigurations () const
virtual void	addSimulationModelSetConfiguration (const DtVrfSimulationSettingsRecord::SimulationModelSetConfiguration &, bool autoSaveIfEnabled=true)
	If a model set configuration with the exact name exists then it will be replaced with this configuration.
virtual void	removeSimulationModelSetConfiguration (const std::string &)
	Removed named configuration.
virtual void	setAutomaticallyStartMissingBackends (bool)
	Whether or not to automatically try and start any missing back-ends when loading a scenario locally. Default is false.
virtual bool	automaticallyStartMissingBackends () const
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static DtVrfSimulationSettingsManager &	instance (makVrv::DtDe &de)
	Returns instance of the messager.
static void	registerInstance (makVrv::DtDe &de, DtVrfSimulationSettingsManager *)

Public Attributes
boost::signal< void(const DtVrfSimulationSettingsRecord &)>	signal_simulationSettingsChanged
	Sent when session settings have changed.

Protected Attributes
makVrv::DtDe &	myDe
DtVrfSimulationSettingsRecord	mySimulationSettings
makVrv::DtRecordSettingsBackupInterface *	mySimulationSettingsBackup
DtFilename	myPeriodicCheckpointDirectory

Detailed Description

The class that will contain information about various scenario settings.

Constructor & Destructor Documentation

makVrf::DtVrfSimulationSettingsManager::DtVrfSimulationSettingsManager

(

makVrv::DtDe &

)

virtual makVrf::DtVrfSimulationSettingsManager::~DtVrfSimulationSettingsManager ( )

virtual

Member Function Documentation

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

static

Returns instance of the messager.

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

static

virtual void makVrf::DtVrfSimulationSettingsManager::setDefaultScenarioFile ( const std::string &  f, bool  save = false  )

virtual

Sets the scenario file used as the default when creating a new scenario.

If save is true will make this change permanent

virtual std::string makVrf::DtVrfSimulationSettingsManager::defaultScenarioFile ( ) const

virtual

virtual void makVrf::DtVrfSimulationSettingsManager::setSimulationObjectGroupTerrain ( const std::string &  f, bool  save = false  )

virtual

Simulation object group terrain to use when editing simulation object groups.

virtual std::string makVrf::DtVrfSimulationSettingsManager::simulationObjectGroupTerrain ( ) const

virtual

virtual void makVrf::DtVrfSimulationSettingsManager::setDefaultSimulationModelSetFile ( const std::string &  f, bool  save = false, bool  signalChange = true  )

virtual

Sets the default .sms file to use when loading a scenario if none is found in the scenario to be loaded.

If save is true will make change permanent

virtual std::string makVrf::DtVrfSimulationSettingsManager::defaultSimulationModelSetFile ( ) const

virtual

virtual void makVrf::DtVrfSimulationSettingsManager::setFromRecord ( const DtVrfSimulationSettingsRecord &  rec )

virtual

virtual void makVrf::DtVrfSimulationSettingsManager::loadDefaultSimulationSettings ( bool  loadOnlyFactorySettings = false )

virtual

virtual void makVrf::DtVrfSimulationSettingsManager::getRecord ( DtVrfSimulationSettingsRecord &  rec ) const

virtual

virtual void makVrf::DtVrfSimulationSettingsManager::getSplitRecord ( std::vector< DtVrfSimulationSettingsRecord > &  rec, std::vector< std::string > &  fileNames  )

inlinevirtual

To support writing element definitions in folders as multiple files not implemented.

virtual void makVrf::DtVrfSimulationSettingsManager::addRecords ( DtVrfSimulationSettingsRecord &  recs, DtVrfSimulationSettingsRecord &  combinedRec  )

inlinevirtual

To support writing element definitions in folders as multiple files not implemented.

virtual void makVrf::DtVrfSimulationSettingsManager::setAutoSave ( bool  )

virtual

Set to false to not save on settings change. Default is true.

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

virtual

virtual void makVrf::DtVrfSimulationSettingsManager::setCheckForUnusedTriggersOnPlanSave ( bool  )

virtual

Sets whether or not to always check for unused triggers when saving plan.

virtual bool makVrf::DtVrfSimulationSettingsManager::checkForUnusedTriggersOnPlanSave ( ) const

virtual

virtual void makVrf::DtVrfSimulationSettingsManager::setDefaultScenarioStartTime ( time_t  )

virtual

The default scenario start time.

virtual time_t makVrf::DtVrfSimulationSettingsManager::defaultScenarioStartTime ( ) const

virtual

virtual void makVrf::DtVrfSimulationSettingsManager::setDefaultEnvironmentCondition ( const std::string &  defaultCondition, bool  save = true  )

virtual

The default scenario environment condition.

virtual std::string makVrf::DtVrfSimulationSettingsManager::defaultEnvironmentCondition ( ) const

virtual

virtual void makVrf::DtVrfSimulationSettingsManager::setEnablePeriodicCheckpointing ( bool  )

virtual

Sets whether or not snapshots are periodically saved to disk (checkpointed)

virtual bool makVrf::DtVrfSimulationSettingsManager::enablePeriodicCheckpointing ( ) const

virtual

virtual void makVrf::DtVrfSimulationSettingsManager::setPeriodicCheckpointingFrequency ( int  )

virtual

Checkpoint every nth snapshot.

For example, if snapshots are taken every 30 seconds a checkpoint frequency of 4 saves a checkpoint every two minutes.

virtual int makVrf::DtVrfSimulationSettingsManager::periodicCheckpointingFrequency ( ) const

virtual

virtual void makVrf::DtVrfSimulationSettingsManager::setPeriodicCheckpointingDirectory ( const std::string &  )

virtual

Sets the directory to save checkpoints to. If blank saves to scenario directory.

virtual const std::string& makVrf::DtVrfSimulationSettingsManager::periodicCheckpointingDirectory ( ) const

virtual

const DtFilename& makVrf::DtVrfSimulationSettingsManager::periodicCheckpointingDirectoryResolved ( ) const

inline

makVrv::DtRecordSettingsBackupInterface* makVrf::DtVrfSimulationSettingsManager::simulationSettingsBackup ( )

inline

void makVrf::DtVrfSimulationSettingsManager::exportSimulationSettings

(

const std::string &

fileName

)

Exports the current cache settings to a file.

void makVrf::DtVrfSimulationSettingsManager::importSimulationSettings

(

const std::string &

fileName

)

Import the current cache settings from a file.

virtual void makVrf::DtVrfSimulationSettingsManager::setStartupTerrain ( const std::string &  )

virtual

Preference on which terrain to use when creating a new scenario.

virtual const std::string& makVrf::DtVrfSimulationSettingsManager::startupTerrain ( ) const

virtual

virtual void makVrf::DtVrfSimulationSettingsManager::setStartupScenario ( const std::string &  )

virtual

Preference on which scenario to use when loading a new scenario. Blank means choose.

virtual const std::string& makVrf::DtVrfSimulationSettingsManager::startupScenario ( ) const

virtual

virtual void makVrf::DtVrfSimulationSettingsManager::setStartupSimulationModelSet ( const std::string &  )

virtual

Preference on which simulation model set to use when loading a new scenario.

virtual const std::string& makVrf::DtVrfSimulationSettingsManager::startupSimulationModelSet ( ) const

virtual

virtual void makVrf::DtVrfSimulationSettingsManager::setAllowOrbatDeletionChoice ( bool  )

virtual

virtual bool makVrf::DtVrfSimulationSettingsManager::allowOrbatDeletionChoice ( ) const

virtual

virtual void makVrf::DtVrfSimulationSettingsManager::setAggregateOnCreate ( bool  )

virtual

Sets to whether or not create aggregates as true aggregates (true) or psuedo aggregates (false) when initially created.

Default is false

bool makVrf::DtVrfSimulationSettingsManager::aggregateOnCreate

(

)

const

virtual void makVrf::DtVrfSimulationSettingsManager::saveSettingsAsDefault ( )

virtual

Saves if auto-save is turned on.

virtual void makVrf::DtVrfSimulationSettingsManager::setSimulationModelSetConfigurations ( const std::vector< DtVrfSimulationSettingsRecord::SimulationModelSetConfiguration > &  )

virtual

Sets the simulation model set configurations. See DtVrfSimulationSettingsRecord for format.

virtual const std::vector<DtVrfSimulationSettingsRecord::SimulationModelSetConfiguration>& makVrf::DtVrfSimulationSettingsManager::simulationModelSetConfigurations ( ) const

virtual

virtual void makVrf::DtVrfSimulationSettingsManager::addSimulationModelSetConfiguration ( const DtVrfSimulationSettingsRecord::SimulationModelSetConfiguration &  , bool  autoSaveIfEnabled = true  )

virtual

If a model set configuration with the exact name exists then it will be replaced with this configuration.

virtual void makVrf::DtVrfSimulationSettingsManager::removeSimulationModelSetConfiguration ( const std::string &  )

virtual

Removed named configuration.

virtual void makVrf::DtVrfSimulationSettingsManager::setAutomaticallyStartMissingBackends ( bool  )

virtual

Whether or not to automatically try and start any missing back-ends when loading a scenario locally. Default is false.

virtual bool makVrf::DtVrfSimulationSettingsManager::automaticallyStartMissingBackends ( ) const

virtual

Member Data Documentation

boost::signal<void (const DtVrfSimulationSettingsRecord&)> makVrf::DtVrfSimulationSettingsManager::signal_simulationSettingsChanged

Sent when session settings have changed.

makVrv::DtDe& makVrf::DtVrfSimulationSettingsManager::myDe

protected

DtVrfSimulationSettingsRecord makVrf::DtVrfSimulationSettingsManager::mySimulationSettings

protected

makVrv::DtRecordSettingsBackupInterface* makVrf::DtVrfSimulationSettingsManager::mySimulationSettingsBackup

protected

DtFilename makVrf::DtVrfSimulationSettingsManager::myPeriodicCheckpointDirectory

protected

---

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

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