makVrv::DtExampleSettingsManager Class Reference

Example Settings Manager. More...

Inheritance diagram for makVrv::DtExampleSettingsManager:

List of all members.

Public Member Functions
virtual	~DtExampleSettingsManager ()
	DTOR.
Setters/getters for settings
virtual void	setDummyVal (int val)
virtual int	dummyVal () const
Setting Persistence Methods
void	setFromRecord (const DtExampleSettingsRecord &rec)
	Set the current settings' state from the given record.
void	getRecord (DtExampleSettingsRecord &rec) const
	Store the current settings' state in the given record.
Static Public Member Functions
static DtExampleSettingsManager &	instance (DtDe &de)
	Get an instance of the settings manager.
Public Attributes
Boost signals for changed settings
boost::signal< void(int)>	signal_dummyValSet
Protected Member Functions
	DtExampleSettingsManager (DtDe &)
	CTOR.
Protected Attributes
int	myDummyVal
Friends
template<typename ManagerClass >
ManagerClass &	defaultManagerInstanceFunction (DtDe &, bool)
	Befriend the manager instance functions for instance retreival/creation.
template<typename ManagerClass >
void	defaultManagerRegisterInstanceFunction (DtDe &, ManagerClass *)
	Befriend the manager instance functions for instance retreival/creation.

---

Detailed Description

Example Settings Manager.

---

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.

Manager requirements: 1) Static instance function 2) Protected DtSignalConnectionManager named myConnections. 3) Member functioned called loadDefaults which takes no arguments. and loads the default settings of the manager or factory from disk. 4) define defaultManagerInstanceFunction as friend. 5) define defaultManagerRegisterInstanceFunction as friend (see below). 5) Protected Constructor which only takes a DtDe reference.

 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.

 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

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

int makVrv::DtExampleSettingsManager::myDummyVal [protected]

---

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

• examples/exampleDialogPage/DtExampleSettingsManager.h