makVrv::DtExampleSettingsManager Class Reference

Example Settings Manager.

Inheritance diagram for makVrv::DtExampleSettingsManager:

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 ()
virtual bool	getOverriddenFactoryRecord (DtExampleSettingsRecord &record) const
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 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
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
virtual	~DtVirtualBaseClass ()

Static Public Member Functions
static DtExampleSettingsManager &	instance (DtDe &de)

Public Attributes
Boost signals for changed settings
vrvSignalsLib::signal< void(int)>	signal_dummyValSet

Protected Member Functions
	DtExampleSettingsManager (DtDe &)
virtual bool	applyFactoryOverrides (DtExampleSettingsRecord &rec) const

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
DtSettingsBackup *	mySettingsBackup
DtDe &	myDe

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 >.

virtual bool makVrv::DtExampleSettingsManager::applyFactoryOverrides ( DtExampleSettingsRecord &  rec ) const

protectedvirtual

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::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)
{
   defaultManagerRegisterInstanceFunction(de,mgr);
}
...else where call.
// Assuming class NewManager : public Manager
Manager::registerInstance(de,new NewManager(de));

Member Data Documentation

vrvSignalsLib::signal<void ( int )> makVrv::DtExampleSettingsManager::signal_dummyValSet

int makVrv::DtExampleSettingsManager::myDummyVal

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/examples/exampleDialogPage/DtExampleSettingsManager.h