makVrf::DtVrfSessionSettingsManager Class Reference

The class that will contain information about various scenario settings.

Inheritance diagram for makVrf::DtVrfSessionSettingsManager:

Public Member Functions
	DtVrfSessionSettingsManager (makVrv::DtDe &)
virtual	~DtVrfSessionSettingsManager ()
virtual void	setFromRecord (const DtVrfSessionSettingsRecord &rec)
virtual void	loadDefaultSessionSettings (bool loadOnlyFactorySettings=false)
virtual void	getRecord (DtVrfSessionSettingsRecord &rec) const
virtual void	getSplitRecord (std::vector< DtVrfSessionSettingsRecord > &rec, std::vector< std::string > &fileNames)
virtual void	addRecords (DtVrfSessionSettingsRecord &recs, DtVrfSessionSettingsRecord &combinedRec)
virtual void	setAutoSave (bool)
virtual bool	autoSave () const
virtual bool	autoJoinSession () const
virtual bool	automaticallyOpenSessionDatabaseWithoutJoiningSession () const
virtual bool	askToJoin () const
virtual bool	alwaysJoinWithSessionDatabase () const
virtual bool	alwaysJoinWithOpenDatabase () const
virtual void	setDisplaySessionDialogs (bool)
virtual bool	displaySessionDialogs () const
makVrv::DtRecordSettingsBackupInterface *	sessionSettingsBackup ()
void	exportSessionSettings (const std::string &fileName)
void	importSessionSettings (const std::string &fileName)
virtual void	saveSettingsAsDefault ()
virtual void	setAllowScenarioChanges (bool)
virtual bool	allowScenarioChanges () const
virtual void	addValueFor (const DtUUID &, const std::string &key, const std::string &value)
virtual void	removeValueFor (const DtUUID &, const std::string &key)
virtual void	removeValuesFor (const DtUUID &)
virtual std::string	valueFor (const DtUUID &, const std::string &key) const
virtual void	setBackendTimeoutInterval (int)
virtual int	backendTimeoutInterval () const
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
virtual	~DtVirtualBaseClass ()

Static Public Member Functions
static DtVrfSessionSettingsManager &	instance (makVrv::DtDe &de)
static void	registerInstance (makVrv::DtDe &de, DtVrfSessionSettingsManager *)

Public Attributes
boost::signals2::signal< void(const DtVrfSessionSettingsRecord &)>	signal_sessionSettingsChanged

Protected Types
typedef boost::unordered_map < std::string, std::string >	KeyValuePairs
typedef boost::unordered_map < DtUUID, KeyValuePairs >	KeyValuePairsByUUID
typedef boost::unordered_map < DtString, DtUUID >	UUIDByMarkingText

Protected Attributes
makVrv::DtDe &	myDe
DtVrfSessionSettingsRecord	mySessionSettings
makVrv::DtRecordSettingsBackupInterface *	mySessionSettingsBackup
KeyValuePairsByUUID	myKeyValuePairsByUUID
UUIDByMarkingText	myUUIDByMarkingText

Member Typedef Documentation

typedef boost::unordered_map<std::string, std::string> makVrf::DtVrfSessionSettingsManager::KeyValuePairs

protected

typedef boost::unordered_map<DtUUID, KeyValuePairs> makVrf::DtVrfSessionSettingsManager::KeyValuePairsByUUID

protected

typedef boost::unordered_map<DtString, DtUUID> makVrf::DtVrfSessionSettingsManager::UUIDByMarkingText

protected

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::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::getSplitRecord ( std::vector< DtVrfSessionSettingsRecord > &  rec, std::vector< std::string > &  fileNames  )

inlinevirtual

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

virtual void makVrf::DtVrfSessionSettingsManager::addRecords ( DtVrfSessionSettingsRecord &  recs, DtVrfSessionSettingsRecord &  combinedRec  )

inlinevirtual

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

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::alwaysJoinWithOpenDatabase ( ) const

virtual

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

virtual

Shows/does not show session settings dialog.

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

virtual

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::saveSettingsAsDefault ( )

virtual

Saves if auto-save is turned on.

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

virtual

When loading a scenario or looking at scenario information, allow aspects of the scenario to be changed.

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

virtual

virtual void makVrf::DtVrfSessionSettingsManager::addValueFor ( const DtUUID &  , const std::string &  key, const std::string &  value  )

virtual

Adds some strings by unique id that can be used for whatever purpose the adder wants. This does not get saved to any file.

virtual void makVrf::DtVrfSessionSettingsManager::removeValueFor ( const DtUUID &  , const std::string &  key  )

virtual

virtual void makVrf::DtVrfSessionSettingsManager::removeValuesFor ( const DtUUID &  )

virtual

virtual std::string makVrf::DtVrfSessionSettingsManager::valueFor ( const DtUUID &  , const std::string &  key  ) const

virtual

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

virtual

Length of time (in seconds) to wait before timing out back-end. Default is 10 minutes (600 seconds)

virtual int makVrf::DtVrfSessionSettingsManager::backendTimeoutInterval ( ) const

virtual

Member Data Documentation

boost::signals2::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

KeyValuePairsByUUID makVrf::DtVrfSessionSettingsManager::myKeyValuePairsByUUID

protected

UUIDByMarkingText makVrf::DtVrfSessionSettingsManager::myUUIDByMarkingText

protected

---

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

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