makVrv::DtWriteSettingsLock< SettingsClass > Class Template Reference

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

Inheritance diagram for makVrv::DtWriteSettingsLock< SettingsClass >:

List of all members.

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

---

Detailed Description

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

a write settings lock on a setting object.

The object can be read and modified, but no other threads can access the object.

Warning:

Keep this lock as short as possible, it will freeze other threads.

DO NOT pass lock objects around.

DO NOT keep lock objects as members.

DO NOT store lock objects as pointers.

DO NOT use multiple lock objects at the same time.

 Usage
 
 {
    DtWriteSettingsLock<DtTestSettings> readTest(mySharedSettingsManager);
    bool value = readTest->getValue();
    readTest->setValue(!value);
 }

---

Constructor & Destructor Documentation

template<typename SettingsClass>

makVrv::DtWriteSettingsLock< SettingsClass >::DtWriteSettingsLock

(

DtSharedSettingsManager &

manager

)

template<typename SettingsClass>

makVrv::DtWriteSettingsLock< SettingsClass >::~DtWriteSettingsLock

(

)

template<typename SettingsClass>

makVrv::DtWriteSettingsLock< SettingsClass >::DtWriteSettingsLock

(

const DtWriteSettingsLock< SettingsClass > &

)

[private]

---

Member Function Documentation

template<typename SettingsClass>

SettingsClass* makVrv::DtWriteSettingsLock< SettingsClass >::operator->

(

)

[inline]

template<typename SettingsClass>

SettingsClass& makVrv::DtWriteSettingsLock< SettingsClass >::operator*

(

)

[inline]

template<typename SettingsClass>

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

(

const DtWriteSettingsLock< SettingsClass > &

)

[private]

---

Member Data Documentation

template<typename SettingsClass>

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

template<typename SettingsClass>

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

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

template<typename SettingsClass>

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

template<typename SettingsClass>

boost::unique_lock<boost::shared_mutex> makVrv::DtWriteSettingsLock< SettingsClass >::myObjectLock [private]

---

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

• include/vrvCore/DtWriteSettingsLock.h