makVrv::DtSharedSettingsManager Class Reference

The shared settings manager, is the global object responsible for managing any shared settings objects. More...

Inheritance diagram for makVrv::DtSharedSettingsManager:

List of all members.

Public Member Functions
virtual	~DtSharedSettingsManager ()
	DTOR.
DtEventQueueInterface &	thisThreadEventQueue () const
	Get the event queue for the current executing thread.
DtEventQueueInterface *	findThisThreadEventQueue () const
	Get the event queue for the current executing thread.
Static Public Member Functions
static DtSharedSettingsManager &	instance (DtDe &)
	Get an instance of the shared settings manager from the DtDe;.
Protected Types
typedef std::map< std::string, DtSharedSettings * >	SettingInstances
Protected Member Functions
const DtSharedSettings *	findSettings (const std::string &className) const
	Find a settings object.
void	registerSettings (const std::string &className, DtSharedSettings *setting)
	Register a settings object.
boost::shared_mutex &	mutex ()
	DtSharedSettingsManager (DtDe &de)
	Use the static instance accessor.
Protected Attributes
boost::shared_mutex	myMutex
SettingInstances	mySettings
DtDe &	myUnsafeDe
DtThreadId	myDeThreadId
Private Member Functions
	DtSharedSettingsManager (const DtSharedSettingsManager &)
	not copyable or assignable.
DtSharedSettingsManager &	operator= (DtSharedSettingsManager &)
Friends
class	DtReadSettingsLock
	Also protected, use the DtReadSettingsLock and DtWriteSettingsLock to access this object.
class	DtWriteSettingsLock

---

Detailed Description

The shared settings manager, is the global object responsible for managing any shared settings objects.

This manager object can be safely shared between threads.

---

Member Typedef Documentation

typedef std::map<std::string, DtSharedSettings*> makVrv::DtSharedSettingsManager::SettingInstances [protected]

---

Constructor & Destructor Documentation

virtual makVrv::DtSharedSettingsManager::~DtSharedSettingsManager

(

)

[virtual]

DTOR.

makVrv::DtSharedSettingsManager::DtSharedSettingsManager

(

DtDe &

de

)

[protected]

Use the static instance accessor.

makVrv::DtSharedSettingsManager::DtSharedSettingsManager

(

const DtSharedSettingsManager &

)

[private]

not copyable or assignable.

---

Member Function Documentation

static DtSharedSettingsManager& makVrv::DtSharedSettingsManager::instance

(

DtDe &

)

[static]

Get an instance of the shared settings manager from the DtDe;.

Referenced by makVrv::DtBaseSharedSettingsManager< makArchives::DtEntitySettingsRecord, DtSharedEntityDisplaySettings >::getRecord(), makVrv::DtBaseSharedSettingsManager< makArchives::DtEntitySettingsRecord, DtSharedEntityDisplaySettings >::initializeBackup(), and makVrv::DtBaseSharedSettingsManager< makArchives::DtEntitySettingsRecord, DtSharedEntityDisplaySettings >::setFromRecord().

DtEventQueueInterface& makVrv::DtSharedSettingsManager::thisThreadEventQueue

(

)

const

Get the event queue for the current executing thread.

Intentionally const, and returning non-const interface. This function is thread safe and re-entrant.

Exceptions:

DtCorruptedState

if unable to get event queue.

DtEventQueueInterface* makVrv::DtSharedSettingsManager::findThisThreadEventQueue

(

)

const

Get the event queue for the current executing thread.

Intentionally const, and returning non-const interface. This function is thread safe and re-entrant.

const DtSharedSettings* makVrv::DtSharedSettingsManager::findSettings

(

const std::string &

className

)

const [protected]

Find a settings object.

Warning:

Must call lock for reading before calling.

void makVrv::DtSharedSettingsManager::registerSettings	(	const std::string &	className,
		DtSharedSettings *	setting
	)		[protected]

Register a settings object.

If an object already exists. Must call lock for writing before calling.

boost::shared_mutex& makVrv::DtSharedSettingsManager::mutex

(

)

[inline, protected]

DtSharedSettingsManager& makVrv::DtSharedSettingsManager::operator=

(

DtSharedSettingsManager &

)

[private]

---

Friends And Related Function Documentation

friend class DtReadSettingsLock [friend]

Also protected, use the DtReadSettingsLock and DtWriteSettingsLock to access this object.

friend class DtWriteSettingsLock [friend]

---

Member Data Documentation

boost::shared_mutex makVrv::DtSharedSettingsManager::myMutex [protected]

SettingInstances makVrv::DtSharedSettingsManager::mySettings [protected]

DtDe& makVrv::DtSharedSettingsManager::myUnsafeDe [protected]

DtThreadId makVrv::DtSharedSettingsManager::myDeThreadId [protected]

---

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

• include/vrvCore/DtSharedSettingsManager.h