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:

Public Member Functions
virtual	~DtSharedSettingsManager ()
	DTOR. More...
DtEventQueueInterface &	thisThreadEventQueue () const
	Get the event queue for the current executing thread. More...
DtEventQueueInterface *	findThisThreadEventQueue () const
	Get the event queue for the current executing thread. More...
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor. More...
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor. More...

Static Public Member Functions
static DtSharedSettingsManager &	instance (DtDe &)
	Get an instance of the shared settings manager from the DtDe;. More...

Protected Types
typedef boost::unordered_map < std::string, DtSharedSettings * >	SettingInstances

Protected Member Functions
const DtSharedSettings *	findSettings (const std::string &className) const
	Find a settings object. More...
void	registerSettings (const std::string &className, DtSharedSettings *setting)
	Register a settings object. More...
boost::shared_mutex &	mutex ()
	DtSharedSettingsManager (DtDe &de)
	Use the static instance accessor. More...

Protected Attributes
boost::shared_mutex	myMutex
SettingInstances	mySettings
DtDe &	myUnsafeDe
DtThreadId	myDeThreadId

Private Member Functions
	DtSharedSettingsManager (const DtSharedSettingsManager &)
	not copyable or assignable. More...
DtSharedSettingsManager &	operator= (DtSharedSettingsManager &)

Friends
template<typename SettingsClass >
class	DtReadSettingsLock
	Also protected, use the DtReadSettingsLock and DtWriteSettingsLock to access this object. More...
template<typename SettingsClass >
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 boost::unordered_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::DtSymbolDecorationSettingsRecord, DtSymbolDecorationSettings >::getRecord(), makVrv::DtBaseSharedSettingsManager< makArchives::DtSymbolDecorationSettingsRecord, DtSymbolDecorationSettings >::initializeBackup(), makVrf::DtVrfModelSetManager::parameterPropertyFor(), and makVrv::DtBaseSharedSettingsManager< makArchives::DtSymbolDecorationSettingsRecord, DtSymbolDecorationSettings >::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 ( )

inlineprotected

DtSharedSettingsManager& makVrv::DtSharedSettingsManager::operator= ( DtSharedSettingsManager &  )

private

Friends And Related Function Documentation

template<typename SettingsClass >

friend class DtReadSettingsLock

friend

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

template<typename SettingsClass >

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:

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrvCore/DtSharedSettingsManager.h