makVrv::DtSharedLaserDesignatorSettings Class Reference

The shared simulation settings.

Inheritance diagram for makVrv::DtSharedLaserDesignatorSettings:

Public Member Functions
virtual	~DtSharedLaserDesignatorSettings ()
virtual void	setDe (DtDe *)
virtual void	setFromRecord (const makArchives::DtLaserDesignatorSettingsRecord &rec)
virtual void	getRecord (makArchives::DtLaserDesignatorSettingsRecord &rec) const
virtual void	setLaserDesignatorsEnabled (bool enable)
virtual bool	laserDesignatorsEnabled () const
virtual void	setLaserDesignatorCodesEnabled (bool enable)
virtual bool	laserDesignatorCodesEnabled () const
const std::vector< DtUnicode > &	definitions () const
const DtSettingsBackup *	settingsBackup () const
DtSettingsBackup *	settingsBackup ()
virtual void	backup ()
Public Member Functions inherited from makVrv::DtSharedSettings
	DtSharedSettings (const DtSharedSettingsManager &manager)
virtual	~DtSharedSettings ()
boost::shared_mutex &	mutex ()
SafetyKey	safeToEmitSignals ()
void	setCurrentWriteLock (boost::unique_lock< boost::shared_mutex > *currentWriteLock)
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
virtual	~DtVirtualBaseClass ()

Static Public Member Functions
static const std::string &	className ()

Protected Member Functions
	DtSharedLaserDesignatorSettings (DtSharedSettingsManager &manager)
bool	applyFactoryOverrides (makArchives::DtLaserDesignatorSettingsRecord &rec) const

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

Friends
class	DtReadSettingsLock< DtSharedLaserDesignatorSettings >
class	DtWriteSettingsLock< DtSharedLaserDesignatorSettings >
class	DtBaseSharedSettingsManager< makArchives::DtLaserDesignatorSettingsRecord, DtSharedLaserDesignatorSettings >
class	DtSharedSettingsManager

Constructor & Destructor Documentation

virtual makVrv::DtSharedLaserDesignatorSettings::~DtSharedLaserDesignatorSettings ( )

virtual

DTOR.

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

protected

CTOR.

Member Function Documentation

static const 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.

bool makVrv::DtSharedLaserDesignatorSettings::applyFactoryOverrides ( makArchives::DtLaserDesignatorSettingsRecord &  rec ) const

protected

Get overrides to the factory record, if any. If there are overrides, this function returns true. This is an internal utility function used by VR-Vantage engineers to update factory defaults. As a result, this function returns false in releases but can be overriden by toolkit users if desired; however, generally toolkit users can and should use DtDeInitializer::addDefaultSettingsRecord(...) instead.

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 DtBaseSharedSettingsManager< makArchives::DtLaserDesignatorSettingsRecord, 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:

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