VR-Forces 5.0.1 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends
makVrv::DtExampleSettingsManager Class Reference

Example Settings Manager.

Inheritance diagram for makVrv::DtExampleSettingsManager:
Inheritance graph
[legend]

Public Member Functions

virtual ~DtExampleSettingsManager ()
 
Setters/getters for settings
virtual void setDummyVal (int val)
 
virtual int dummyVal () const
 
Setting Persistence Methods
void setFromRecord (const DtExampleSettingsRecord &rec)
 
void getRecord (DtExampleSettingsRecord &rec) const
 
- Public Member Functions inherited from makVrv::DtBaseSettingsManager< DtExampleSettingsRecord >
 DtBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)
 
virtual ~DtBaseSettingsManager ()
 
virtual void initializeBackup ()
 
- Public Member Functions inherited from makVrv::DtCommonBaseSettingsManager< DtExampleSettingsRecord >
 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 DtDeSettingssettings ()
 
virtual const DtDeSettingssettings () const
 
virtual DtSettingsBackupsettingsBackup ()
 
virtual const DtSettingsBackupsettingsBackup () 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< DtExampleSettingsRecord > &rec, std::vector< std::string > &fileNames)
 
virtual void addRecords (DtExampleSettingsRecord &rec, DtExampleSettingsRecord &combinedRec)
 
- Public Member Functions inherited from makVrv::DtVirtualBaseClass
 DtVirtualBaseClass ()
 
virtual ~DtVirtualBaseClass ()
 

Static Public Member Functions

static DtExampleSettingsManagerinstance (DtDe &de)
 

Public Attributes

Boost signals for changed settings
boost::signalslib::signal
< void(int)> 
signal_dummyValSet
 

Protected Member Functions

 DtExampleSettingsManager (DtDe &)
 

Protected Attributes

int myDummyVal
 
- Protected Attributes inherited from makVrv::DtCommonBaseSettingsManager< DtExampleSettingsRecord >
DtSignalConnectionManager myConnections
 
std::string myName
 
std::string myExtension
 
std::string myDisplayName
 
bool myUseDefaultSettingsRecordFlag
 
bool myAutoSaveFlag
 
DtSettingsBackupmySettingsBackup
 
DtDemyDe
 

Friends

template<typename ManagerClass >
ManagerClass & defaultManagerInstanceFunction (DtDe &, bool)
 
template<typename ManagerClass >
void defaultManagerRegisterInstanceFunction (DtDe &, ManagerClass *)
 

Additional Inherited Members

- Protected Types inherited from makVrv::DtBaseSettingsManager< DtExampleSettingsRecord >
typedef DtRecordSettingsBackup
< DtBaseSettingsManager
< DtExampleSettingsRecord >
, DtExampleSettingsRecord
RecordBackupType
 

Constructor & Destructor Documentation

virtual makVrv::DtExampleSettingsManager::~DtExampleSettingsManager ( )
virtual

DTOR.

makVrv::DtExampleSettingsManager::DtExampleSettingsManager ( DtDe )
protected

CTOR.

Member Function Documentation

static DtExampleSettingsManager& makVrv::DtExampleSettingsManager::instance ( DtDe de)
static

Get an instance of the settings manager.

virtual void makVrv::DtExampleSettingsManager::setDummyVal ( int  val)
virtual
virtual int makVrv::DtExampleSettingsManager::dummyVal ( ) const
virtual
void makVrv::DtExampleSettingsManager::setFromRecord ( const DtExampleSettingsRecord rec)
virtual

Set the current settings' state from the given record.

Implements makVrv::DtBaseSettingsManager< DtExampleSettingsRecord >.

void makVrv::DtExampleSettingsManager::getRecord ( DtExampleSettingsRecord rec) const
virtual

Store the current settings' state in the given record.

Implements makVrv::DtBaseSettingsManager< DtExampleSettingsRecord >.

Friends And Related Function Documentation

template<typename ManagerClass >
ManagerClass& defaultManagerInstanceFunction ( DtDe de,
bool  allowedInSlave 
)
friend

Befriend the manager instance functions for instance retreival/creation.

Befriend the manager instance functions for instance retrieval / creation.

Befriend the manager instance functions for instance retrieval and creation.

Befriend the manager instance functions for instance retreival/creation.

Befriend the manager instance functions for instance retrieval/creation.

class Manager
{
public:
static Manager& instance(DtDe& de);
void loadDefaults();
protected:
template <typename ManagerClass>
friend ManagerClass& defaultManagerInstanceFunction(DtDe& de, bool);
template <typename ManagerClass>
friend void defaultManagerRegisterInstanceFunction(DtDe& de, ManagerClass* mgr)
Manager(DtDe&);
DtSignalConnectionManager myConnections;
};

Then simply in the implementation of instance call defaultManagerInstanceFunction with the de object and return the return value.

Manager& Manager::instance(DtDe& de)
{
return defaultManagerInstanceFunction<Manager>(de);
}
template<typename ManagerClass >
void defaultManagerRegisterInstanceFunction ( DtDe de,
ManagerClass *  mgr 
)
friend

Befriend the manager instance functions for instance retreival/creation.

Befriend the manager instance functions for instance retrieval / creation.

Befriend the manager instance functions for instance retrieval and creation.

Befriend the manager instance functions for instance retreival/creation.

Befriend the manager instance functions for instance retrieval/creation.

static void Manager::registerInstance(DtDe& de, Manager* mgr)
{
}
...else where call.
// Assuming class NewManager : public Manager
Manager::registerInstance(de,new NewManager(de));

Member Data Documentation

boost::signalslib::signal<void ( int )> makVrv::DtExampleSettingsManager::signal_dummyValSet
int makVrv::DtExampleSettingsManager::myDummyVal
protected

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

Document ID: Generated on Mon Jun 20 00:38:30 EDT 2022 from SVN revision 244029
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)