makVrv::DtSharedSettings Class Reference

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 const std::string& className();

Inheritance diagram for makVrv::DtSharedSettings:

Classes
class	SafetyKey
class	SignalSafety

Public Member Functions
	DtSharedSettings (const DtSharedSettingsManager &manager)
virtual	~DtSharedSettings ()
boost::shared_mutex &	mutex ()
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
virtual	~DtVirtualBaseClass ()

Section for safely emitting signals in 'set' functions from a
write locked settings object.
class	SignalSafety
const DtSharedSettingsManager &	myManager
boost::shared_mutex	myMutex
boost::unique_lock < boost::shared_mutex > *	myCurrentWriteLock
SafetyKey	safeToEmitSignals ()
void	setCurrentWriteLock (boost::unique_lock< boost::shared_mutex > *currentWriteLock)
virtual const DtSettingsBackup *	settingsBackup () const
virtual DtSettingsBackup *	settingsBackup ()
virtual void	backup ()

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::DtSharedEntityDisplaySettings, makVrv::DtSharedRadioCommunicationsSettings, makVrv::DtSharedRenderSettings, makVrv::DtSharedPostProcessorSettings, makVrv::DtSharedCockpitSettings, makVrv::DtSymbolDecorationSettings, makVrv::DtSharedAggregateDisplaySettings, makVrv::DtSharedOceanRenderSettings, makVrv::DtSharedIntersectorSettings, makVrv::DtSharedDiGuySettings, makVrv::DtSharedTrackHistorySettings, makVrv::DtSharedLightingRenderSettings, makVrv::DtSharedLaserDesignatorSettings, makVrv::DtSharedTacticalGraphicsDisplaySettings, 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::DtSharedEntityDisplaySettings, makVrv::DtSharedRadioCommunicationsSettings, makVrv::DtSharedRenderSettings, makVrv::DtSharedCockpitSettings, makVrv::DtSharedPostProcessorSettings, makVrv::DtSymbolDecorationSettings, makVrv::DtSharedAggregateDisplaySettings, makVrv::DtSharedOceanRenderSettings, makVrv::DtSharedIntersectorSettings, makVrv::DtSharedDiGuySettings, makVrv::DtSharedTrackHistorySettings, makVrv::DtSharedLightingRenderSettings, makVrv::DtSharedLaserDesignatorSettings, makVrv::DtSharedTacticalGraphicsDisplaySettings, 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::DtSharedEntityDisplaySettings, makVrv::DtSharedRadioCommunicationsSettings, makVrv::DtSharedCockpitSettings, makVrv::DtSharedRenderSettings, makVrv::DtSharedPostProcessorSettings, makVrv::DtSymbolDecorationSettings, makVrv::DtSharedAggregateDisplaySettings, makVrv::DtSharedOceanRenderSettings, makVrv::DtSharedIntersectorSettings, makVrv::DtSharedDiGuySettings, makVrv::DtSharedTrackHistorySettings, makVrv::DtSharedLightingRenderSettings, makVrv::DtSharedLaserDesignatorSettings, makVrv::DtSharedTacticalGraphicsDisplaySettings, makVrv::DtSharedLoaderSettings, 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:

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrvCore/DtSharedSettings.h