 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
Common base class for all types of settings managers. More...
Public Member Functions | |
| 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. | |
| virtual | ~DtCommonBaseSettingsManager () |
| Virtual DTOR. | |
| virtual void | autoSaveIfNecessary () |
| Saves the current settings as defaults if autosave is enabled. | |
| virtual void | setAutoSave (bool doit) |
| Sets whether autosave is enabled for the settings manager. | |
| virtual bool | autoSave () const |
| Gets whether autosave is enabled for the settings manager. | |
| virtual void | setUseDefaultSettingsRecord (bool useit) |
| Sets whether setting initialization should check for a default record. | |
| virtual bool | useDefaultSettingsRecord () const |
| Gets whether setting initialization should check for a default record. | |
| virtual DtDeSettings * | settings () |
| Accessor for the manager's DtDeSettings object. | |
| virtual const DtDeSettings * | settings () const |
| Accessor for the manager's DtDeSettings object (const). | |
| virtual DtSettingsBackup * | settingsBackup () |
| Accessor for the manager's settings backup. | |
| virtual const DtSettingsBackup * | settingsBackup () const |
| Accessor for the manager's settings backup (const). | |
Setting Persistence Methods | |
| virtual void | loadDefaults () |
| Initializes the settings and creates a backup. | |
| virtual void | initializeBackup ()=0 |
| Creates a backup of the settings' current state (abstract). | |
| virtual void | saveDefaultSettings () |
| Saves the current settings' state as the default (on disk). | |
| virtual void | loadDefaultSettings (bool loadOnlyFactorySettings) |
| Loads the default settings from disk. | |
| virtual void | importSettings (const std::string &filePath) |
| Load the settings' state from the given file. | |
| virtual void | exportSettings (const std::string &filePath) const |
| Save the current settings's state to the given file. | |
| virtual void | setFromRecord (const RecordType &record)=0 |
| Set the current settings' state from the given record (abstract). | |
| virtual void | getRecord (RecordType &record) const =0 |
| Store the current settings' state in the given record (abstract). | |
Protected Attributes | |
| DtSignalConnectionManager | myConnections |
| std::string | myName |
| std::string | myExtension |
| std::string | myDisplayName |
| bool | myUseDefaultSettingsRecordFlag |
| bool | myAutoSaveFlag |
| DtSettingsBackup * | mySettingsBackup |
| DtDe & | myDe |
Common base class for all types of settings managers.
This class provides the interface for creating settings managers with the large portion of the persistence logic handled by either this base class or specialized base classes for different types of settings managers. This template class takes the settings record class as a template parameter in order to perform default record lookups and the common save/load and import/export functionality.
| makVrv::DtCommonBaseSettingsManager< RecordType >::DtCommonBaseSettingsManager | ( | DtDe & | de, |
| const std::string & | name, | ||
| const std::string & | displayName, | ||
| const std::string & | ext | ||
| ) | [inline] |
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.
| virtual makVrv::DtCommonBaseSettingsManager< RecordType >::~DtCommonBaseSettingsManager | ( | ) | [inline, virtual] |
Virtual DTOR.
| virtual void makVrv::DtCommonBaseSettingsManager< RecordType >::autoSaveIfNecessary | ( | ) | [inline, virtual] |
Saves the current settings as defaults if autosave is enabled.
This method is mainly provided to make creating setters for individual settings easier, by wrapping the if check in this method.
Referenced by makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::importSettings().
| virtual void makVrv::DtCommonBaseSettingsManager< RecordType >::setAutoSave | ( | bool | doit | ) | [inline, virtual] |
Sets whether autosave is enabled for the settings manager.
If autosave is enabled, the settings will be saved as they're changed.
Referenced by makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::loadDefaults().
| virtual bool makVrv::DtCommonBaseSettingsManager< RecordType >::autoSave | ( | ) | const [inline, virtual] |
Gets whether autosave is enabled for the settings manager.
If autosave is enabled, the settings will be saved as they're changed.
Referenced by makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::autoSaveIfNecessary(), and makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::loadDefaults().
| virtual void makVrv::DtCommonBaseSettingsManager< RecordType >::setUseDefaultSettingsRecord | ( | bool | useit | ) | [inline, virtual] |
Sets whether setting initialization should check for a default record.
If set and a default record is present, the settings manager will use that record instead of the default settings file from disk to initialize the settings.
| virtual bool makVrv::DtCommonBaseSettingsManager< RecordType >::useDefaultSettingsRecord | ( | ) | const [inline, virtual] |
Gets whether setting initialization should check for a default record.
If set and a default record is present, the settings manager will use that record instead of the default settings file from disk to initialize the settings.
| virtual DtDeSettings* makVrv::DtCommonBaseSettingsManager< RecordType >::settings | ( | ) | [inline, virtual] |
Accessor for the manager's DtDeSettings object.
| DtCorruptedState | if the settings can't be found. |
Referenced by makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::exportSettings(), makVrv::DtBaseSharedSettingsManager< makArchives::DtEntitySettingsRecord, DtSharedEntityDisplaySettings >::getRecord(), makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::importSettings(), makVrv::DtBaseSettingsManager< makArchives::DtForestSettingsRecord >::initializeBackup(), makVrv::DtBaseSharedSettingsManager< makArchives::DtEntitySettingsRecord, DtSharedEntityDisplaySettings >::initializeBackup(), makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::loadDefaultSettings(), makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::saveDefaultSettings(), and makVrv::DtBaseSharedSettingsManager< makArchives::DtEntitySettingsRecord, DtSharedEntityDisplaySettings >::setFromRecord().
| virtual const DtDeSettings* makVrv::DtCommonBaseSettingsManager< RecordType >::settings | ( | ) | const [inline, virtual] |
Accessor for the manager's DtDeSettings object (const).
| DtCorruptedState | if the settings can't be found. |
| virtual DtSettingsBackup* makVrv::DtCommonBaseSettingsManager< RecordType >::settingsBackup | ( | ) | [inline, virtual] |
Accessor for the manager's settings backup.
| virtual const DtSettingsBackup* makVrv::DtCommonBaseSettingsManager< RecordType >::settingsBackup | ( | ) | const [inline, virtual] |
Accessor for the manager's settings backup (const).
| virtual void makVrv::DtCommonBaseSettingsManager< RecordType >::loadDefaults | ( | ) | [inline, virtual] |
Initializes the settings and creates a backup.
If the useDefaultSettingsRecord is enabled and a default record exists, the record will be used to initialize the settings. Otherwise, settings will be initialized from the default (or factory) record on disk.
| virtual void makVrv::DtCommonBaseSettingsManager< RecordType >::initializeBackup | ( | ) | [pure virtual] |
Creates a backup of the settings' current state (abstract).
Implemented in makVrv::DtBaseSharedSettingsManager< RecordType, SettingsType >, makVrv::DtBaseSharedSettingsManager< makArchives::DtTacticalGraphicsSettingsRecord, DtSharedTacticalGraphicsDisplaySettings >, makVrv::DtBaseSharedSettingsManager< makArchives::DtRadioCommunicationsSettingsRecord, DtSharedRadioCommunicationsSettings >, makVrv::DtBaseSharedSettingsManager< makArchives::DtInterestManagementRecord, DtSharedInterestManagementSettings >, makVrv::DtBaseSharedSettingsManager< makArchives::DtTrackHistorySettingsRecord, DtSharedTrackHistorySettings >, makVrv::DtBaseSharedSettingsManager< makArchives::DtAggregateSettingsRecord, DtSharedAggregateDisplaySettings >, makVrv::DtBaseSharedSettingsManager< makArchives::DtDisplayUnitsSettingsRecord, DtSharedDisplayUnitsSettings >, makVrv::DtBaseSharedSettingsManager< makArchives::DtEntitySettingsRecord, DtSharedEntityDisplaySettings >, makVrv::DtBaseSettingsManager< RecordType >, makVrv::DtBaseSettingsManager< DtExampleSettingsRecord >, makVrv::DtBaseSettingsManager< makArchives::DtIntervisibilitySettingsRecord >, makVrv::DtBaseSettingsManager< makArchives::DtDistributedEnvironmentSettingsRecord >, makVrv::DtBaseSettingsManager< makArchives::DtObserverModesRecord >, makVrv::DtBaseSettingsManager< makArchives::DtGridLinesSettingsRecord >, and makVrv::DtBaseSettingsManager< makArchives::DtForestSettingsRecord >.
Referenced by makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::loadDefaults().
| virtual void makVrv::DtCommonBaseSettingsManager< RecordType >::saveDefaultSettings | ( | ) | [inline, virtual] |
Saves the current settings' state as the default (on disk).
Referenced by makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::autoSaveIfNecessary().
| virtual void makVrv::DtCommonBaseSettingsManager< RecordType >::loadDefaultSettings | ( | bool | loadOnlyFactorySettings | ) | [inline, virtual] |
Loads the default settings from disk.
If loadOnlyFactorySettings is true, only the factory record will be read. Otherwise, if a default record is present, that will be used.
Reimplemented in makVrv::DtObserverModeManager.
Referenced by makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::loadDefaults().
| virtual void makVrv::DtCommonBaseSettingsManager< RecordType >::importSettings | ( | const std::string & | filePath | ) | [inline, virtual] |
Load the settings' state from the given file.
| virtual void makVrv::DtCommonBaseSettingsManager< RecordType >::exportSettings | ( | const std::string & | filePath | ) | const [inline, virtual] |
Save the current settings's state to the given file.
| virtual void makVrv::DtCommonBaseSettingsManager< RecordType >::setFromRecord | ( | const RecordType & | record | ) | [pure virtual] |
Set the current settings' state from the given record (abstract).
Implemented in makVrv::DtDisplayUnitsSettingsManager, makVrv::DtBaseSharedSettingsManager< RecordType, SettingsType >, makVrv::DtBaseSharedSettingsManager< makArchives::DtTacticalGraphicsSettingsRecord, DtSharedTacticalGraphicsDisplaySettings >, makVrv::DtBaseSharedSettingsManager< makArchives::DtRadioCommunicationsSettingsRecord, DtSharedRadioCommunicationsSettings >, makVrv::DtBaseSharedSettingsManager< makArchives::DtInterestManagementRecord, DtSharedInterestManagementSettings >, makVrv::DtBaseSharedSettingsManager< makArchives::DtTrackHistorySettingsRecord, DtSharedTrackHistorySettings >, makVrv::DtBaseSharedSettingsManager< makArchives::DtAggregateSettingsRecord, DtSharedAggregateDisplaySettings >, makVrv::DtBaseSharedSettingsManager< makArchives::DtDisplayUnitsSettingsRecord, DtSharedDisplayUnitsSettings >, makVrv::DtBaseSharedSettingsManager< makArchives::DtEntitySettingsRecord, DtSharedEntityDisplaySettings >, makVrv::DtBaseSettingsManager< RecordType >, makVrv::DtBaseSettingsManager< DtExampleSettingsRecord >, makVrv::DtBaseSettingsManager< makArchives::DtIntervisibilitySettingsRecord >, makVrv::DtBaseSettingsManager< makArchives::DtDistributedEnvironmentSettingsRecord >, makVrv::DtBaseSettingsManager< makArchives::DtObserverModesRecord >, makVrv::DtBaseSettingsManager< makArchives::DtGridLinesSettingsRecord >, makVrv::DtBaseSettingsManager< makArchives::DtForestSettingsRecord >, makVrv::DtObserverModeManager, makVrv::DtIntervisibilitySettingsManager, makVrv::DtGridLinesSettingsManager, makVrv::DtForestSettingsManager, makVrv::DtDistributedEnvironmentSettingsManager, and makVrv::DtExampleSettingsManager.
Referenced by makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::importSettings(), makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::loadDefaults(), and makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::loadDefaultSettings().
| virtual void makVrv::DtCommonBaseSettingsManager< RecordType >::getRecord | ( | RecordType & | record | ) | const [pure virtual] |
Store the current settings' state in the given record (abstract).
Implemented in makVrv::DtBaseSharedSettingsManager< RecordType, SettingsType >, makVrv::DtBaseSharedSettingsManager< makArchives::DtTacticalGraphicsSettingsRecord, DtSharedTacticalGraphicsDisplaySettings >, makVrv::DtBaseSharedSettingsManager< makArchives::DtRadioCommunicationsSettingsRecord, DtSharedRadioCommunicationsSettings >, makVrv::DtBaseSharedSettingsManager< makArchives::DtInterestManagementRecord, DtSharedInterestManagementSettings >, makVrv::DtBaseSharedSettingsManager< makArchives::DtTrackHistorySettingsRecord, DtSharedTrackHistorySettings >, makVrv::DtBaseSharedSettingsManager< makArchives::DtAggregateSettingsRecord, DtSharedAggregateDisplaySettings >, makVrv::DtBaseSharedSettingsManager< makArchives::DtDisplayUnitsSettingsRecord, DtSharedDisplayUnitsSettings >, makVrv::DtBaseSharedSettingsManager< makArchives::DtEntitySettingsRecord, DtSharedEntityDisplaySettings >, makVrv::DtBaseSettingsManager< RecordType >, makVrv::DtBaseSettingsManager< DtExampleSettingsRecord >, makVrv::DtBaseSettingsManager< makArchives::DtIntervisibilitySettingsRecord >, makVrv::DtBaseSettingsManager< makArchives::DtDistributedEnvironmentSettingsRecord >, makVrv::DtBaseSettingsManager< makArchives::DtObserverModesRecord >, makVrv::DtBaseSettingsManager< makArchives::DtGridLinesSettingsRecord >, makVrv::DtBaseSettingsManager< makArchives::DtForestSettingsRecord >, makVrv::DtObserverModeManager, makVrv::DtIntervisibilitySettingsManager, makVrv::DtGridLinesSettingsManager, makVrv::DtForestSettingsManager, makVrv::DtDistributedEnvironmentSettingsManager, and makVrv::DtExampleSettingsManager.
Referenced by makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::exportSettings(), and makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::saveDefaultSettings().
DtSignalConnectionManager makVrv::DtCommonBaseSettingsManager< RecordType >::myConnections [protected] |
std::string makVrv::DtCommonBaseSettingsManager< RecordType >::myName [protected] |
std::string makVrv::DtCommonBaseSettingsManager< RecordType >::myExtension [protected] |
std::string makVrv::DtCommonBaseSettingsManager< RecordType >::myDisplayName [protected] |
bool makVrv::DtCommonBaseSettingsManager< RecordType >::myUseDefaultSettingsRecordFlag [protected] |
Referenced by makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::loadDefaults(), makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::setUseDefaultSettingsRecord(), and makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::useDefaultSettingsRecord().
bool makVrv::DtCommonBaseSettingsManager< RecordType >::myAutoSaveFlag [protected] |
DtSettingsBackup* makVrv::DtCommonBaseSettingsManager< RecordType >::mySettingsBackup [protected] |
Referenced by makVrv::DtBaseSettingsManager< makArchives::DtForestSettingsRecord >::initializeBackup(), makVrv::DtBaseSharedSettingsManager< makArchives::DtEntitySettingsRecord, DtSharedEntityDisplaySettings >::initializeBackup(), makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::settingsBackup(), and makVrv::DtBaseSettingsManager< makArchives::DtForestSettingsRecord >::~DtBaseSettingsManager().
DtDe& makVrv::DtCommonBaseSettingsManager< RecordType >::myDe [protected] |
Referenced by makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::DtCommonBaseSettingsManager(), makVrv::DtBaseSharedSettingsManager< makArchives::DtEntitySettingsRecord, DtSharedEntityDisplaySettings >::getRecord(), makVrv::DtBaseSettingsManager< makArchives::DtForestSettingsRecord >::initializeBackup(), makVrv::DtBaseSharedSettingsManager< makArchives::DtEntitySettingsRecord, DtSharedEntityDisplaySettings >::initializeBackup(), makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::loadDefaults(), makVrv::DtBaseSharedSettingsManager< makArchives::DtEntitySettingsRecord, DtSharedEntityDisplaySettings >::setFromRecord(), and makVrv::DtCommonBaseSettingsManager< makArchives::DtEntitySettingsRecord >::settings().