VR-Forces 4.0.4 Class Documentation
Public Member Functions | Protected Types
makVrv::DtBaseSharedSettingsManager< RecordType, SettingsType > Class Template Reference

Base class for shared settings managers. More...

Inheritance diagram for makVrv::DtBaseSharedSettingsManager< RecordType, SettingsType >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtBaseSharedSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)
 CTOR.
virtual ~DtBaseSharedSettingsManager ()
 Virtual DTOR.
Setting Persistence Methods
virtual void initializeBackup ()
 Creates a backup of the settings' current state.
virtual void setFromRecord (const RecordType &record)
 Set the current settings' state from the given record.
virtual void getRecord (RecordType &record) const
 Store the current settings' state in the given record.

Protected Types

typedef
DtSharedRecordSettingsBackup
< SettingsType, RecordType > 
SharedRecordBackupType

Detailed Description

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.


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]
template<typename RecordType, typename SettingsType>
virtual makVrv::DtBaseSharedSettingsManager< RecordType, SettingsType >::~DtBaseSharedSettingsManager ( ) [inline, virtual]

Virtual DTOR.


Member Function Documentation

template<typename RecordType, typename SettingsType>
virtual void makVrv::DtBaseSharedSettingsManager< RecordType, SettingsType >::initializeBackup ( ) [inline, virtual]

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) [inline, virtual]

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 [inline, virtual]

Store the current settings' state in the given record.

Implements makVrv::DtCommonBaseSettingsManager< RecordType >.


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)