makVrv::DtReadSettingsLock< SettingsClass > Class Template Reference

a read settings lock on a setting object. More...

Inheritance diagram for makVrv::DtReadSettingsLock< SettingsClass >:

List of all members.

Public Member Functions
	DtReadSettingsLock (DtSharedSettingsManager &manager)
	~DtReadSettingsLock ()
const SettingsClass *	operator-> ()
const SettingsClass *	operator-> () const
const SettingsClass &	operator* ()
const SettingsClass &	operator* () const
Private Member Functions
	DtReadSettingsLock (const DtReadSettingsLock &)
DtReadSettingsLock &	operator= (const DtReadSettingsLock &)
Private Attributes
DtSharedSettingsManager &	myManager
SettingsClass *	myObject
boost::shared_lock < boost::shared_mutex >	myManagerLock
boost::shared_lock < boost::shared_mutex >	myObjectLock

---

Detailed Description

template<typename SettingsClass>
class makVrv::DtReadSettingsLock< SettingsClass >

a read settings lock on a setting object.

The object can only get read access aka const functions.

Warning:

DO NOT pass lock objects around.

DO NOT keep lock objects as members.

DO NOT store lock objects as pointers.

Minimize use multiple locks to the same object at the same time.

DO NOT use write locks to an object with a read lock, DEADLOCKS!

 Usage
 temp for reading
 bool value(false);
 
 {
    DtReadSettingsLock<DtTestSettings> readTest(mySharedSettingsManager);
    value = readTest->getValue();
 }

---

Constructor & Destructor Documentation

template<typename SettingsClass>

makVrv::DtReadSettingsLock< SettingsClass >::DtReadSettingsLock

(

DtSharedSettingsManager &

manager

)

template<typename SettingsClass>

makVrv::DtReadSettingsLock< SettingsClass >::~DtReadSettingsLock

(

)

template<typename SettingsClass>

makVrv::DtReadSettingsLock< SettingsClass >::DtReadSettingsLock

(

const DtReadSettingsLock< SettingsClass > &

)

[private]

---

Member Function Documentation

template<typename SettingsClass>

const SettingsClass* makVrv::DtReadSettingsLock< SettingsClass >::operator->

(

)

[inline]

template<typename SettingsClass>

const SettingsClass* makVrv::DtReadSettingsLock< SettingsClass >::operator->

(

)

const [inline]

template<typename SettingsClass>

const SettingsClass& makVrv::DtReadSettingsLock< SettingsClass >::operator*

(

)

[inline]

template<typename SettingsClass>

const SettingsClass& makVrv::DtReadSettingsLock< SettingsClass >::operator*

(

)

const [inline]

template<typename SettingsClass>

DtReadSettingsLock& makVrv::DtReadSettingsLock< SettingsClass >::operator=

(

const DtReadSettingsLock< SettingsClass > &

)

[private]

---

Member Data Documentation

template<typename SettingsClass>

DtSharedSettingsManager& makVrv::DtReadSettingsLock< SettingsClass >::myManager [private]

template<typename SettingsClass>

SettingsClass* makVrv::DtReadSettingsLock< SettingsClass >::myObject [private]

Referenced by makVrv::DtReadSettingsLock< DtSharedSimulationSettings >::operator*(), and makVrv::DtReadSettingsLock< DtSharedSimulationSettings >::operator->().

template<typename SettingsClass>

boost::shared_lock<boost::shared_mutex> makVrv::DtReadSettingsLock< SettingsClass >::myManagerLock [private]

template<typename SettingsClass>

boost::shared_lock<boost::shared_mutex> makVrv::DtReadSettingsLock< SettingsClass >::myObjectLock [private]

---

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

• include/vrvCore/DtReadSettingsLock.h