makVrf::DtVrfSessionSettingsManager Class Reference

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

Inheritance diagram for makVrf::DtVrfSessionSettingsManager:

Public Member Functions
	DtVrfSessionSettingsManager (makVrv::DtDe &)
virtual	~DtVrfSessionSettingsManager ()
virtual void	setHelpFile (const std::string &, bool save=false)
	Sets the help file to use when pressing the F1 key.
virtual std::string	helpFile () const
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 DtVrfSessionSettingsRecord &rec)
virtual void	loadDefaultSessionSettings (bool loadOnlyFactorySettings=false)
virtual void	getRecord (DtVrfSessionSettingsRecord &rec) const
virtual void	setAutoSave (bool)
	Set to false to not save on settings change. Default is true.
virtual bool	autoSave () const
virtual bool	autoJoinSession () const
	Access to session record information.
virtual bool	automaticallyOpenSessionDatabaseWithoutJoiningSession () const
virtual bool	askToJoin () const
virtual bool	alwaysJoinWithSessionDatabase () const
virtual bool	zoomToScenarioExtentsOnLoad () const
virtual bool	alwaysJoinWithOpenDatabase () const
virtual bool	useSimulationTimeForAdvancement () const
virtual bool	showOverlayBar () const
virtual void	setUseAdditionalWindowTitle (bool)
	Sets whether or not to use extended window title.
virtual bool	useAdditionalWindowTitle () const
virtual void	setAdditionalWindowTitle (const makVrv::DtUnicode &)
	Returns the additional window title.
virtual makVrv::DtUnicode	additionalWindowTitle () const
virtual void	setScenarioStartTimeAtDefault (bool)
	Sets whether or not to use scenario start time as default. If false will use first object placement.
virtual bool	scenarioStartTimeAtDefault () const
virtual void	setUseStartFreezePdus (bool)
	Sets whether or not to use DIS start/freeze PDUs or VRF start/stop PDUs.
virtual bool	useStartFreezePdus () const
virtual void	setDefaultScenarioStartTime (time_t)
	The default scenario start time.
virtual time_t	defaultScenarioStartTime () 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 *	sessionSettingsBackup ()
void	exportSessionSettings (const std::string &fileName)
	Exports the current cache settings to a file.
void	importSessionSettings (const std::string &fileName)
	Import the current cache settings from a file.
virtual void	setDoNotShowSessionStartupDialog (bool, bool save=true, bool signal=true)
	Sets whether or not to show the startup session dialog.
bool	showSessionStartupDialog () const
virtual void	setDisplaySessionDialogs (bool)
	Shows/does not show session settings dialog.
virtual bool	displaySessionDialogs () const
virtual void	setDisplayCorrelationWarningMessages (bool)
	Shows/does not show correlation warnings dialog.
virtual bool	displayCorrelationWarningMessages () const
virtual void	setStartupPreference (int)
	Preference on startup (new scenario or load scenario)
int	startupPreference () const
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	setTimeScaleRange (double low, double high, bool save=true)
	Sets the low/hight range of timescale timer.
virtual void	getTimeScaleRange (double &low, double &high) 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	setUserDefinedSmoothing (bool)
	Sets whether or not the user or system is defining smoothing in performance options.
bool	userDefinedSmoothing () const
virtual void	setShowScenarioDescriptionDialog (bool b)
	Sets whether or not to show scenario description message box.
virtual bool	showScenarioDescriptionDialog () const
virtual void	saveSettingsAsDefault ()
	Saves if auto-save is turned on.
virtual void	setSimulationModelSetConfigurations (const std::vector< DtVrfSessionSettingsRecord::SimulationModelSetConfiguration > &)
	Sets the simulation model set configurations. See DtVrfSessionSettingsRecord for format.
virtual const std::vector < DtVrfSessionSettingsRecord::SimulationModelSetConfiguration > &	simulationModelSetConfigurations () const
virtual void	addSimulationModelSetConfiguration (const DtVrfSessionSettingsRecord::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.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

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

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

Protected Attributes
makVrv::DtDe &	myDe
DtVrfSessionSettingsRecord	mySessionSettings
makVrv::DtRecordSettingsBackupInterface *	mySessionSettingsBackup
DtFilename	myPeriodicCheckpointDirectory

Detailed Description

The class that will contain information about various scenario settings.

Constructor & Destructor Documentation

makVrf::DtVrfSessionSettingsManager::DtVrfSessionSettingsManager

(

makVrv::DtDe &

)

virtual makVrf::DtVrfSessionSettingsManager::~DtVrfSessionSettingsManager ( )

virtual

Member Function Documentation

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

static

Returns instance of the messager.

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

static

virtual void makVrf::DtVrfSessionSettingsManager::setHelpFile ( const std::string &  , bool  save = false  )

virtual

Sets the help file to use when pressing the F1 key.

Note this will be a permanent change and will be using that file the next time the application is started if the save flag is true. By default is false

virtual std::string makVrf::DtVrfSessionSettingsManager::helpFile ( ) const

virtual

virtual void makVrf::DtVrfSessionSettingsManager::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::DtVrfSessionSettingsManager::defaultScenarioFile ( ) const

virtual

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

virtual

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

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

virtual

virtual void makVrf::DtVrfSessionSettingsManager::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::DtVrfSessionSettingsManager::defaultSimulationModelSetFile ( ) const

virtual

virtual void makVrf::DtVrfSessionSettingsManager::setFromRecord ( const DtVrfSessionSettingsRecord &  rec )

virtual

virtual void makVrf::DtVrfSessionSettingsManager::loadDefaultSessionSettings ( bool  loadOnlyFactorySettings = false )

virtual

virtual void makVrf::DtVrfSessionSettingsManager::getRecord ( DtVrfSessionSettingsRecord &  rec ) const

virtual

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

virtual

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

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

virtual

virtual bool makVrf::DtVrfSessionSettingsManager::autoJoinSession ( ) const

virtual

Access to session record information.

To set, get record and then reset vis setFromRecord

virtual bool makVrf::DtVrfSessionSettingsManager::automaticallyOpenSessionDatabaseWithoutJoiningSession ( ) const

virtual

virtual bool makVrf::DtVrfSessionSettingsManager::askToJoin ( ) const

virtual

virtual bool makVrf::DtVrfSessionSettingsManager::alwaysJoinWithSessionDatabase ( ) const

virtual

virtual bool makVrf::DtVrfSessionSettingsManager::zoomToScenarioExtentsOnLoad ( ) const

virtual

virtual bool makVrf::DtVrfSessionSettingsManager::alwaysJoinWithOpenDatabase ( ) const

virtual

virtual bool makVrf::DtVrfSessionSettingsManager::useSimulationTimeForAdvancement ( ) const

virtual

virtual bool makVrf::DtVrfSessionSettingsManager::showOverlayBar ( ) const

virtual

virtual void makVrf::DtVrfSessionSettingsManager::setUseAdditionalWindowTitle ( bool  )

virtual

Sets whether or not to use extended window title.

The extended window title will be added to the end of the existing window title in parenthesis

virtual bool makVrf::DtVrfSessionSettingsManager::useAdditionalWindowTitle ( ) const

virtual

virtual void makVrf::DtVrfSessionSettingsManager::setAdditionalWindowTitle ( const makVrv::DtUnicode &  )

virtual

Returns the additional window title.

virtual makVrv::DtUnicode makVrf::DtVrfSessionSettingsManager::additionalWindowTitle ( ) const

virtual

virtual void makVrf::DtVrfSessionSettingsManager::setScenarioStartTimeAtDefault ( bool  )

virtual

Sets whether or not to use scenario start time as default. If false will use first object placement.

virtual bool makVrf::DtVrfSessionSettingsManager::scenarioStartTimeAtDefault ( ) const

virtual

virtual void makVrf::DtVrfSessionSettingsManager::setUseStartFreezePdus ( bool  )

virtual

Sets whether or not to use DIS start/freeze PDUs or VRF start/stop PDUs.

virtual bool makVrf::DtVrfSessionSettingsManager::useStartFreezePdus ( ) const

virtual

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

virtual

The default scenario start time.

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

virtual

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

virtual

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

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

virtual

virtual void makVrf::DtVrfSessionSettingsManager::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::DtVrfSessionSettingsManager::periodicCheckpointingFrequency ( ) const

virtual

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

virtual

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

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

virtual

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

inline

makVrv::DtRecordSettingsBackupInterface* makVrf::DtVrfSessionSettingsManager::sessionSettingsBackup ( )

inline

void makVrf::DtVrfSessionSettingsManager::exportSessionSettings

(

const std::string &

fileName

)

Exports the current cache settings to a file.

void makVrf::DtVrfSessionSettingsManager::importSessionSettings

(

const std::string &

fileName

)

Import the current cache settings from a file.

virtual void makVrf::DtVrfSessionSettingsManager::setDoNotShowSessionStartupDialog ( bool  , bool  save = true, bool  signal = true  )

virtual

Sets whether or not to show the startup session dialog.

bool makVrf::DtVrfSessionSettingsManager::showSessionStartupDialog

(

)

const

virtual void makVrf::DtVrfSessionSettingsManager::setDisplaySessionDialogs ( bool  )

virtual

Shows/does not show session settings dialog.

virtual bool makVrf::DtVrfSessionSettingsManager::displaySessionDialogs ( ) const

virtual

virtual void makVrf::DtVrfSessionSettingsManager::setDisplayCorrelationWarningMessages ( bool  )

virtual

Shows/does not show correlation warnings dialog.

virtual bool makVrf::DtVrfSessionSettingsManager::displayCorrelationWarningMessages ( ) const

virtual

virtual void makVrf::DtVrfSessionSettingsManager::setStartupPreference ( int  )

virtual

Preference on startup (new scenario or load scenario)

int makVrf::DtVrfSessionSettingsManager::startupPreference

(

)

const

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

virtual

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

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

virtual

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

virtual

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

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

virtual

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

virtual

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

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

virtual

virtual void makVrf::DtVrfSessionSettingsManager::setTimeScaleRange ( double  low, double  high, bool  save = true  )

virtual

Sets the low/hight range of timescale timer.

virtual void makVrf::DtVrfSessionSettingsManager::getTimeScaleRange ( double &  low, double &  high  ) const

virtual

virtual void makVrf::DtVrfSessionSettingsManager::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::DtVrfSessionSettingsManager::aggregateOnCreate

(

)

const

virtual void makVrf::DtVrfSessionSettingsManager::setUserDefinedSmoothing ( bool  )

virtual

Sets whether or not the user or system is defining smoothing in performance options.

bool makVrf::DtVrfSessionSettingsManager::userDefinedSmoothing

(

)

const

virtual void makVrf::DtVrfSessionSettingsManager::setShowScenarioDescriptionDialog ( bool  b )

virtual

Sets whether or not to show scenario description message box.

virtual bool makVrf::DtVrfSessionSettingsManager::showScenarioDescriptionDialog ( ) const

virtual

virtual void makVrf::DtVrfSessionSettingsManager::saveSettingsAsDefault ( )

virtual

Saves if auto-save is turned on.

virtual void makVrf::DtVrfSessionSettingsManager::setSimulationModelSetConfigurations ( const std::vector< DtVrfSessionSettingsRecord::SimulationModelSetConfiguration > &  )

virtual

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

virtual const std::vector<DtVrfSessionSettingsRecord::SimulationModelSetConfiguration>& makVrf::DtVrfSessionSettingsManager::simulationModelSetConfigurations ( ) const

virtual

virtual void makVrf::DtVrfSessionSettingsManager::addSimulationModelSetConfiguration ( const DtVrfSessionSettingsRecord::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::DtVrfSessionSettingsManager::removeSimulationModelSetConfiguration ( const std::string &  )

virtual

Removed named configuration.

Member Data Documentation

boost::signal<void (const DtVrfSessionSettingsRecord&)> makVrf::DtVrfSessionSettingsManager::signal_sessionSettingsChanged

Sent when session settings have changed.

makVrv::DtDe& makVrf::DtVrfSessionSettingsManager::myDe

protected

DtVrfSessionSettingsRecord makVrf::DtVrfSessionSettingsManager::mySessionSettings

protected

makVrv::DtRecordSettingsBackupInterface* makVrf::DtVrfSessionSettingsManager::mySessionSettingsBackup

protected

DtFilename makVrf::DtVrfSessionSettingsManager::myPeriodicCheckpointDirectory

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-4-branch/include/vrfGuiCore/vrfSessionSettingsManager.h