makVrv::DtBaseSharedSettingsManager< RecordType, SettingsType > Class Template Reference

template<typename RecordType, typename SettingsType>
class makVrv::DtBaseSharedSettingsManager< RecordType, SettingsType >

Base class for shared settings managers. Extends the functionality provided by the DtCommonBaseSettingsManager, by implementing the initializeBackup, setFromRecord, and getRecord methods. Since creating backups and setting/getting the settings' state with a record works the same for all shared settings managers, new shared settings managers should use DtBaseSharedSettingsManager as its base class to make use of the common code. The SettingsType template parameter must be a DtSharedSettings object with methods settingsBackup() (both const and non-const versions) and backup(), returning DtSettingsBackup* and void respectively. The settings object must also implement a void setFromRecord( const RecType& ) and a void getRecord( RecType& ) const method as well.

Inheritance diagram for makVrv::DtBaseSharedSettingsManager< RecordType, SettingsType >:

Public Member Functions
	DtBaseSharedSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)
virtual	~DtBaseSharedSettingsManager ()
Setting Persistence Methods
virtual void	initializeBackup ()
virtual void	setFromRecord (const RecordType &record)
virtual void	getRecord (RecordType &record) const
virtual bool	getOverriddenFactoryRecord (RecordType &record) const
Public Member Functions inherited from makVrv::DtCommonBaseSettingsManager< RecordType >
	DtCommonBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)
virtual	~DtCommonBaseSettingsManager ()
virtual void	autoSaveIfNecessary ()
virtual void	setAutoSave (bool doit)
virtual bool	autoSave () const
virtual void	setUseDefaultSettingsRecord (bool useit)
virtual bool	useDefaultSettingsRecord () const
virtual DtDeSettings *	settings ()
virtual const DtDeSettings *	settings () const
virtual DtSettingsBackup *	settingsBackup ()
virtual const DtSettingsBackup *	settingsBackup () const
virtual void	loadDefaults ()
virtual void	saveDefaultSettings ()
virtual void	loadDefaultSettings (bool loadOnlyFactorySettings)
virtual void	importSettings (const std::string &filePath)
virtual void	exportSettings (const std::string &filePath) const
virtual void	getSplitRecord (std::vector< RecordType > &rec, std::vector< std::string > &fileNames)
virtual void	addRecords (RecordType &rec, RecordType &combinedRec)
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
virtual	~DtVirtualBaseClass ()

Protected Types
typedef DtSharedRecordSettingsBackup < SettingsType, RecordType >	SharedRecordBackupType

Additional Inherited Members
Protected Attributes inherited from makVrv::DtCommonBaseSettingsManager< RecordType >
DtSignalConnectionManager	myConnections
std::string	myName
std::string	myExtension
std::string	myDisplayName
bool	myUseDefaultSettingsRecordFlag
bool	myAutoSaveFlag
DtSettingsBackup *	mySettingsBackup
DtDe &	myDe

Member Typedef Documentation

template<typename RecordType, typename SettingsType>

typedef DtSharedRecordSettingsBackup<SettingsType,RecordType> makVrv::DtBaseSharedSettingsManager< RecordType, SettingsType >::SharedRecordBackupType

protected

Constructor & Destructor Documentation

template<typename RecordType, typename SettingsType>

makVrv::DtBaseSharedSettingsManager< RecordType, SettingsType >::DtBaseSharedSettingsManager ( DtDe &  de, const std::string &  name, const std::string &  displayName, const std::string &  ext  )

inline

CTOR.

See Also

DtCommonBaseSettingsManager::DtCommonBaseSettingsManager

template<typename RecordType, typename SettingsType>

virtual makVrv::DtBaseSharedSettingsManager< RecordType, SettingsType >::~DtBaseSharedSettingsManager ( )

inlinevirtual

Virtual DTOR.

Member Function Documentation

template<typename RecordType, typename SettingsType>

virtual void makVrv::DtBaseSharedSettingsManager< RecordType, SettingsType >::initializeBackup ( )

inlinevirtual

Creates a backup of the settings' current state.

Implements makVrv::DtCommonBaseSettingsManager< RecordType >.

template<typename RecordType, typename SettingsType>

virtual void makVrv::DtBaseSharedSettingsManager< RecordType, SettingsType >::setFromRecord ( const RecordType &  record )

inlinevirtual

Set the current settings' state from the given record.

Implements makVrv::DtCommonBaseSettingsManager< RecordType >.

Reimplemented in makVrv::DtDisplayUnitsSettingsManager.

template<typename RecordType, typename SettingsType>

virtual void makVrv::DtBaseSharedSettingsManager< RecordType, SettingsType >::getRecord ( RecordType &  record ) const

inlinevirtual

Store the current settings' state in the given record.

Implements makVrv::DtCommonBaseSettingsManager< RecordType >.

template<typename RecordType, typename SettingsType>

virtual bool makVrv::DtBaseSharedSettingsManager< RecordType, SettingsType >::getOverriddenFactoryRecord ( RecordType &  record ) const

inlinevirtual

Get overrides to the factory record, if any. If there are overrides, this function returns true. This is an internal utility function used by VR-Vantage engineers to update factory defaults. As a result, this function returns false in releases but can be overriden by toolkit users if desired; however, generally toolkit users can and should use DtDeInitializer::addDefaultSettingsRecord(...) instead.

Implements makVrv::DtCommonBaseSettingsManager< RecordType >.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrvUtil/DtBaseSettingsManager.h