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

Inheritance diagram for makVrf::DtVrfGuiSettingsManager:

Public Member Functions
	DtVrfGuiSettingsManager (makVrv::DtDe &)
virtual	~DtVrfGuiSettingsManager ()
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	setFromRecord (const DtVrfGuiSettingsRecord &rec)
virtual void	loadDefaultGuiSettings (bool loadOnlyFactorySettings=false)
virtual void	getRecord (DtVrfGuiSettingsRecord &rec) const
virtual void	getSplitRecord (std::vector< DtVrfGuiSettingsRecord > &rec, std::vector< std::string > &fileNames)
	To support writing element definitions in folders as multiple files not implemented.
virtual void	addRecords (DtVrfGuiSettingsRecord &recs, DtVrfGuiSettingsRecord &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 bool	zoomToScenarioExtentsOnLoad () const
	Access to gui record information.
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	setUseStartFreezePdus (bool)
	Sets whether or not to use DIS start/freeze PDUs or VRF start/stop PDUs.
virtual bool	useStartFreezePdus () const
virtual void	setSortTaskSetMenus (bool)
	Sets whether or not to sort the task/set menus.
virtual bool	sortTaskSetMenus () const
makVrv::DtRecordSettingsBackupInterface *	guiSettingsBackup ()
void	exportGuiSettings (const std::string &fileName)
	Exports the current cache settings to a file.
void	importGuiSettings (const std::string &fileName)
	Import the current cache settings from a file.
virtual void	setDisplayCorrelationWarningMessages (bool)
	Shows/does not show correlation warnings dialog.
virtual bool	displayCorrelationWarningMessages () const
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	setStartupPreference (int)
	Preference on startup (new scenario or load scenario)
int	startupPreference () 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	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.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

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

Public Attributes
boost::signal< void(const DtVrfGuiSettingsRecord &)>	signal_guiSettingsChanged
	Sent when gui settings have changed.
boost::signal< void(bool)>	signal_taskSetMenuSortChanged
	Sent when the sorting of task/set menus has changed.

Protected Attributes
makVrv::DtDe &	myDe
DtVrfGuiSettingsRecord	myGuiSettings
makVrv::DtRecordSettingsBackupInterface *	myGuiSettingsBackup

Detailed Description

The class that will contain information about various scenario settings.

Constructor & Destructor Documentation

makVrf::DtVrfGuiSettingsManager::DtVrfGuiSettingsManager ( makVrv::DtDe & )

virtual makVrf::DtVrfGuiSettingsManager::~DtVrfGuiSettingsManager ( )

virtual

Member Function Documentation

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

static

Returns instance of the messager.

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

static

virtual void makVrf::DtVrfGuiSettingsManager::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::DtVrfGuiSettingsManager::helpFile ( ) const

virtual

virtual void makVrf::DtVrfGuiSettingsManager::setFromRecord ( const DtVrfGuiSettingsRecord & rec )

virtual

virtual void makVrf::DtVrfGuiSettingsManager::loadDefaultGuiSettings ( bool loadOnlyFactorySettings = false )

virtual

virtual void makVrf::DtVrfGuiSettingsManager::getRecord ( DtVrfGuiSettingsRecord & rec ) const

virtual

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

inlinevirtual

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

virtual void makVrf::DtVrfGuiSettingsManager::addRecords	(	DtVrfGuiSettingsRecord &	recs,
		DtVrfGuiSettingsRecord &	combinedRec
	)

inlinevirtual

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

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

virtual

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

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

virtual

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

virtual

Access to gui record information.

To set, get record and then reset vis setFromRecord

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

virtual

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

virtual

virtual void makVrf::DtVrfGuiSettingsManager::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::DtVrfGuiSettingsManager::useAdditionalWindowTitle ( ) const

virtual

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

virtual

Returns the additional window title.

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

virtual

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

virtual

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

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

virtual

virtual void makVrf::DtVrfGuiSettingsManager::setSortTaskSetMenus ( bool )

virtual

Sets whether or not to sort the task/set menus.

virtual bool makVrf::DtVrfGuiSettingsManager::sortTaskSetMenus ( ) const

virtual

makVrv::DtRecordSettingsBackupInterface* makVrf::DtVrfGuiSettingsManager::guiSettingsBackup ( )

inline

void makVrf::DtVrfGuiSettingsManager::exportGuiSettings ( const std::string & fileName )

Exports the current cache settings to a file.

void makVrf::DtVrfGuiSettingsManager::importGuiSettings ( const std::string & fileName )

Import the current cache settings from a file.

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

virtual

Shows/does not show correlation warnings dialog.

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

virtual

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

virtual

Sets whether or not to show the startup session dialog.

bool makVrf::DtVrfGuiSettingsManager::showSessionStartupDialog ( ) const

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

virtual

Preference on startup (new scenario or load scenario)

int makVrf::DtVrfGuiSettingsManager::startupPreference ( ) const

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

virtual

Sets the low/hight range of timescale timer.

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

virtual

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

virtual

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

bool makVrf::DtVrfGuiSettingsManager::userDefinedSmoothing ( ) const

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

virtual

Sets whether or not to show scenario description message box.

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

virtual

virtual void makVrf::DtVrfGuiSettingsManager::saveSettingsAsDefault ( )

virtual

Saves if auto-save is turned on.

Member Data Documentation

boost::signal<void (const DtVrfGuiSettingsRecord&)> makVrf::DtVrfGuiSettingsManager::signal_guiSettingsChanged

Sent when gui settings have changed.

boost::signal<void (bool)> makVrf::DtVrfGuiSettingsManager::signal_taskSetMenuSortChanged

Sent when the sorting of task/set menus has changed.

makVrv::DtDe& makVrf::DtVrfGuiSettingsManager::myDe

protected

DtVrfGuiSettingsRecord makVrf::DtVrfGuiSettingsManager::myGuiSettings

protected

makVrv::DtRecordSettingsBackupInterface* makVrf::DtVrfGuiSettingsManager::myGuiSettingsBackup

protected

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

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

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation