makVrv::DtSharedLaserDesignatorSettings Class Reference

The shared simulation settings. More...

Inheritance diagram for makVrv::DtSharedLaserDesignatorSettings:

Public Member Functions
virtual	~DtSharedLaserDesignatorSettings ()
	DTOR.
virtual void	setDe (DtDe *)
	Sets the display engine used for the settings object.
virtual void	setFromRecord (const makArchives::DtLaserDesignatorSettingsRecord &rec)
	Set the entity settings as a record.
virtual void	getRecord (makArchives::DtLaserDesignatorSettingsRecord &rec) const
	Get the settings as a record.
virtual void	setLaserDesignatorsEnabled (bool enable)
	turns all laser designators on or off
virtual bool	laserDesignatorsEnabled () const
	checks whether all cockpits are on or off
virtual void	setLaserDesignatorCodesEnabled (bool enable)
	turns all laser designator codes on or off
virtual bool	laserDesignatorCodesEnabled () const
	checks whether all designator codes are on or off
const std::vector< DtUnicode > &	definitions () const
const DtSettingsBackup *	settingsBackup () const
	Accessor for the settings backup (const).
DtSettingsBackup *	settingsBackup ()
	Accessor for the settings backup.
virtual void	backup ()
	\brief Backs up current state using backup settings object
Public Member Functions inherited from makVrv::DtSharedSettings
	DtSharedSettings (const DtSharedSettingsManager &manager)
	CTOR.
virtual	~DtSharedSettings ()
	DTOR.
boost::shared_mutex &	mutex ()
	Get the mutex for the settings object.
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.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static std::string	className ()
	Get an instance of the settings object.

Protected Member Functions
	DtSharedLaserDesignatorSettings (DtSharedSettingsManager &manager)
	CTOR.

Protected Attributes
bool	myLaserDesignatorsEnabled
bool	myLaserDesignatorCodesEnabled
std::vector< DtUnicode >	myDefinitions
DtDe *	myDe
DtLaserDesignatorSettingsBackup *	mySettingsBackup

Friends
class	DtReadSettingsLock< DtSharedLaserDesignatorSettings >
	Also protected, use the DtReadSettingsLock and DtWriteSettingsLock to access the object.
class	DtWriteSettingsLock< DtSharedLaserDesignatorSettings >
class	DtSharedSettingsManager

Detailed Description

The shared simulation settings.

Constructor & Destructor Documentation

virtual makVrv::DtSharedLaserDesignatorSettings::~DtSharedLaserDesignatorSettings ( )

virtual

DTOR.

makVrv::DtSharedLaserDesignatorSettings::DtSharedLaserDesignatorSettings ( DtSharedSettingsManager &  manager )

protected

CTOR.

Member Function Documentation

static std::string makVrv::DtSharedLaserDesignatorSettings::className ( )

static

Get an instance of the settings object.

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

virtual void makVrv::DtSharedLaserDesignatorSettings::setDe ( DtDe *  )

virtual

Sets the display engine used for the settings object.

virtual void makVrv::DtSharedLaserDesignatorSettings::setFromRecord ( const makArchives::DtLaserDesignatorSettingsRecord &  rec )

virtual

Set the entity settings as a record.

virtual void makVrv::DtSharedLaserDesignatorSettings::getRecord ( makArchives::DtLaserDesignatorSettingsRecord &  rec ) const

virtual

Get the settings as a record.

virtual void makVrv::DtSharedLaserDesignatorSettings::setLaserDesignatorsEnabled ( bool  enable )

virtual

turns all laser designators on or off

virtual bool makVrv::DtSharedLaserDesignatorSettings::laserDesignatorsEnabled ( ) const

virtual

checks whether all cockpits are on or off

virtual void makVrv::DtSharedLaserDesignatorSettings::setLaserDesignatorCodesEnabled ( bool  enable )

virtual

turns all laser designator codes on or off

virtual bool makVrv::DtSharedLaserDesignatorSettings::laserDesignatorCodesEnabled ( ) const

virtual

checks whether all designator codes are on or off

const std::vector<DtUnicode>& makVrv::DtSharedLaserDesignatorSettings::definitions

(

)

const

const DtSettingsBackup* makVrv::DtSharedLaserDesignatorSettings::settingsBackup ( ) const

inlinevirtual

Accessor for the settings backup (const).

Exceptions

DtCorruptedState

Re-implement to use.

Reimplemented from makVrv::DtSharedSettings.

DtSettingsBackup* makVrv::DtSharedLaserDesignatorSettings::settingsBackup ( )

inlinevirtual

Accessor for the settings backup.

Exceptions

DtCorruptedState

Re-implement to use.

Reimplemented from makVrv::DtSharedSettings.

virtual void makVrv::DtSharedLaserDesignatorSettings::backup ( )

virtual

\brief Backs up current state using backup settings object

Reimplemented from makVrv::DtSharedSettings.

Friends And Related Function Documentation

friend class DtReadSettingsLock< DtSharedLaserDesignatorSettings >

friend

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

friend class DtWriteSettingsLock< DtSharedLaserDesignatorSettings >

friend

friend class DtSharedSettingsManager

friend

Member Data Documentation

bool makVrv::DtSharedLaserDesignatorSettings::myLaserDesignatorsEnabled

protected

bool makVrv::DtSharedLaserDesignatorSettings::myLaserDesignatorCodesEnabled

protected

std::vector<DtUnicode> makVrv::DtSharedLaserDesignatorSettings::myDefinitions

protected

DtDe* makVrv::DtSharedLaserDesignatorSettings::myDe

protected

DtLaserDesignatorSettingsBackup* makVrv::DtSharedLaserDesignatorSettings::mySettingsBackup

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCore/DtSharedLaserDesignatorSettings.h