makVrv::DtSharedSettings Class Reference

The base class for all shared settings. More...

Inheritance diagram for makVrv::DtSharedSettings:

List of all members.

Classes
class	SafetyKey
	Internal key used to ensure thread safety. More...
class	SignalSafety
Public Member Functions
	DtSharedSettings (const DtSharedSettingsManager &manager)
	CTOR.
virtual	~DtSharedSettings ()
	DTOR.
boost::shared_mutex &	mutex ()
	Get the mutex for the settings object.
Section for safely emitting signals in 'set' functions from a
write locked settings object.
class	SignalSafety
	Create a safety key for the function, see above example.
const DtSharedSettingsManager &	myManager
	Create a safety key for the function, see above example.
boost::shared_mutex	myMutex
	Create a safety key for the function, see above example.
boost::unique_lock < boost::shared_mutex > *	myCurrentWriteLock
	Create a safety key for the function, see above example.
SafetyKey	safeToEmitSignals ()
	Create a safety key for the function, see above example.
void	setCurrentWriteLock (boost::unique_lock< boost::shared_mutex > *currentWriteLock)
	No need to call, set by the DtWriteSettingLock object.
virtual const DtSettingsBackup *	settingsBackup () const
	Accessor for the settings backup (const).
virtual DtSettingsBackup *	settingsBackup ()
	Accessor for the settings backup.
virtual void	backup ()
	Called to back up the settings.

---

Detailed Description

The base class for all shared settings.

Actual settings class should have the following members/declarations

friend class DtReadSettingsLock<DtSharedSimulationSettings>; friend class DtWriteSettingsLock<DtSharedSimulationSettings>; friend class DtSharedSettingsManager; static std::string className();

---

Constructor & Destructor Documentation

makVrv::DtSharedSettings::DtSharedSettings

(

const DtSharedSettingsManager &

manager

)

CTOR.

virtual makVrv::DtSharedSettings::~DtSharedSettings

(

)

[virtual]

DTOR.

---

Member Function Documentation

boost::shared_mutex& makVrv::DtSharedSettings::mutex

(

)

[inline]

Get the mutex for the settings object.

SafetyKey makVrv::DtSharedSettings::safeToEmitSignals

(

)

[inline]

Create a safety key for the function, see above example.

void makVrv::DtSharedSettings::setCurrentWriteLock

(

boost::unique_lock< boost::shared_mutex > *

currentWriteLock

)

[inline]

No need to call, set by the DtWriteSettingLock object.

virtual const DtSettingsBackup* makVrv::DtSharedSettings::settingsBackup

(

)

const [virtual]

Accessor for the settings backup (const).

Exceptions:

DtCorruptedState

Re-implement to use.

Reimplemented in makVrv::DtSharedDisplayUnitsSettings, makVrv::DtSharedRadioCommunicationsSettings, makVrv::DtSharedCockpitSettings, makVrv::DtSharedEntityDisplaySettings, makVrv::DtSymbolDecorationSettings, makVrv::DtSharedAggregateDisplaySettings, makVrv::DtSharedRenderSettings, makVrv::DtSharedTacticalGraphicsDisplaySettings, makVrv::DtSharedTrackHistorySettings, makVrv::DtSharedLoaderSettings, and makVrv::DtSharedInterestManagementSettings.

virtual DtSettingsBackup* makVrv::DtSharedSettings::settingsBackup

(

)

[virtual]

Accessor for the settings backup.

Exceptions:

DtCorruptedState

Re-implement to use.

Reimplemented in makVrv::DtSharedDisplayUnitsSettings, makVrv::DtSharedRadioCommunicationsSettings, makVrv::DtSharedCockpitSettings, makVrv::DtSharedEntityDisplaySettings, makVrv::DtSymbolDecorationSettings, makVrv::DtSharedAggregateDisplaySettings, makVrv::DtSharedRenderSettings, makVrv::DtSharedTacticalGraphicsDisplaySettings, makVrv::DtSharedTrackHistorySettings, makVrv::DtSharedLoaderSettings, and makVrv::DtSharedInterestManagementSettings.

virtual void makVrv::DtSharedSettings::backup

(

)

[virtual]

Called to back up the settings.

Exceptions:

DtCorruptedState

Re-implement to use.

Reimplemented in makVrv::DtSharedDisplayUnitsSettings, makVrv::DtSharedRadioCommunicationsSettings, makVrv::DtSharedCockpitSettings, makVrv::DtSymbolDecorationSettings, makVrv::DtSharedEntityDisplaySettings, makVrv::DtSharedAggregateDisplaySettings, makVrv::DtSharedRenderSettings, makVrv::DtSharedTacticalGraphicsDisplaySettings, makVrv::DtSharedLoaderSettings, makVrv::DtSharedTrackHistorySettings, and makVrv::DtSharedInterestManagementSettings.

---

Friends And Related Function Documentation

friend class SignalSafety [friend]

Create a safety key for the function, see above example.

---

Member Data Documentation

const DtSharedSettingsManager& makVrv::DtSharedSettings::myManager [private]

Create a safety key for the function, see above example.

boost::shared_mutex makVrv::DtSharedSettings::myMutex [private]

Create a safety key for the function, see above example.

boost::unique_lock<boost::shared_mutex>* makVrv::DtSharedSettings::myCurrentWriteLock [private]

Create a safety key for the function, see above example.

---

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

• include/vrvCore/DtSharedSettings.h