VR-Forces 4.10 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Types
makVrv::DtBaseSettingsManager< RecordType > Class Template Referenceabstract

Base class for (non-shared) settings managers. More...

Inheritance diagram for makVrv::DtBaseSettingsManager< RecordType >:
Inheritance graph
[legend]

Public Member Functions

 DtBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)
 CTOR. More...
 
virtual ~DtBaseSettingsManager ()
 Virtual DTOR. More...
 
Setting Persistence Methods
virtual void initializeBackup ()
 Creates a backup of the settings' current state. More...
 
virtual void setFromRecord (const RecordType &record)=0
 Set the current settings' state from the given record (abstract). More...
 
virtual void getRecord (RecordType &record) const =0
 Store the current settings' state in the given record (abstract). More...
 
- Public Member Functions inherited from makVrv::DtCommonBaseSettingsManager< RecordType >
 DtCommonBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)
 CTOR The name, displayName, and extension parameters are used for creating the settings object (DtDeSettings) and backup, and for constructing the filename when readin/writing the records to disk. More...
 
virtual ~DtCommonBaseSettingsManager ()
 Virtual DTOR. More...
 
virtual void autoSaveIfNecessary ()
 Saves the current settings as defaults if autosave is enabled. More...
 
virtual void setAutoSave (bool doit)
 Sets whether autosave is enabled for the settings manager. More...
 
virtual bool autoSave () const
 Gets whether autosave is enabled for the settings manager. More...
 
virtual void setUseDefaultSettingsRecord (bool useit)
 Sets whether setting initialization should check for a default record. More...
 
virtual bool useDefaultSettingsRecord () const
 Gets whether setting initialization should check for a default record. More...
 
virtual DtDeSettingssettings ()
 Accessor for the manager's DtDeSettings object. More...
 
virtual const DtDeSettingssettings () const
 Accessor for the manager's DtDeSettings object (const). More...
 
virtual DtSettingsBackupsettingsBackup ()
 Accessor for the manager's settings backup. More...
 
virtual const DtSettingsBackupsettingsBackup () const
 Accessor for the manager's settings backup (const). More...
 
virtual void loadDefaults ()
 Initializes the settings and creates a backup. More...
 
virtual void saveDefaultSettings ()
 Saves the current settings' state as the default (on disk). More...
 
virtual void loadDefaultSettings (bool loadOnlyFactorySettings)
 Loads the default settings from disk. More...
 
virtual void importSettings (const std::string &filePath)
 Load the settings' state from the given file. More...
 
virtual void exportSettings (const std::string &filePath) const
 Save the current settings' state to the given file. More...
 
virtual void getSplitRecord (std::vector< RecordType > &rec, std::vector< std::string > &fileNames)
 For directory support, split the main record into different sub-records and give them each a file name. More...
 
virtual void addRecords (RecordType &rec, RecordType &combinedRec)
 For directory support, when reading in a directory, add the records from each file to the combined record. More...
 
- Public Member Functions inherited from makVrv::DtVirtualBaseClass
 DtVirtualBaseClass ()
 Do nothing constructor. More...
 
virtual ~DtVirtualBaseClass ()
 Virtual do nothing destructor. More...
 

Protected Types

typedef DtRecordSettingsBackup
< DtBaseSettingsManager
< RecordType >, RecordType > 
RecordBackupType
 

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
 
DtSettingsBackupmySettingsBackup
 
DtDemyDe
 

Detailed Description

template<typename RecordType>
class makVrv::DtBaseSettingsManager< RecordType >

Base class for (non-shared) settings managers.

Extends the functionality provided by the DtCommonBaseSettingsManager, by implementing the initializeBackup method. Since the backups for all non-shared settings are handled the same, new non-shared settings managers should use DtBaseSettingsManager as its base class to make use of the common initializeBackup code.

Member Typedef Documentation

template<typename RecordType>
typedef DtRecordSettingsBackup<DtBaseSettingsManager<RecordType>,RecordType> makVrv::DtBaseSettingsManager< RecordType >::RecordBackupType
protected

Constructor & Destructor Documentation

template<typename RecordType>
makVrv::DtBaseSettingsManager< RecordType >::DtBaseSettingsManager ( DtDe de,
const std::string &  name,
const std::string &  displayName,
const std::string &  ext 
)
inline
template<typename RecordType>
virtual makVrv::DtBaseSettingsManager< RecordType >::~DtBaseSettingsManager ( )
inlinevirtual

Virtual DTOR.

Member Function Documentation

template<typename RecordType>
virtual void makVrv::DtBaseSettingsManager< RecordType >::initializeBackup ( )
inlinevirtual

Creates a backup of the settings' current state.

Implements makVrv::DtCommonBaseSettingsManager< RecordType >.

Reimplemented in makVrv::DtShadowSettingsManager, and makVrv::DtObserverModeManager.

template<typename RecordType>
virtual void makVrv::DtBaseSettingsManager< RecordType >::setFromRecord ( const RecordType &  record)
pure virtual
template<typename RecordType>
virtual void makVrv::DtBaseSettingsManager< RecordType >::getRecord ( RecordType &  record) const
pure virtual

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

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)