makVrv::DtSharedInterestManagementSettings Class Reference

Object responsible for storing the settings regarding interest management (DDM).

Inheritance diagram for makVrv::DtSharedInterestManagementSettings:

Public Member Functions
virtual	~DtSharedInterestManagementSettings ()
void	setFromRecord (const makArchives::DtInterestManagementRecord &rec)
void	getRecord (makArchives::DtInterestManagementRecord &rec) const
virtual const DtInterestManagementSettingsBackup *	settingsBackup () const
virtual DtInterestManagementSettingsBackup *	settingsBackup ()
virtual void	backup ()
Setting setters/getters
void	setDdmRegionSize (int size)
int	ddmRegionSize () const
void	setRegionUpdateThreshold (int percentage)
int	regionUpdateThreshold () const
void	setAltitudeThresholdEnabled (bool enabled)
bool	altitudeThresholdEnabled () const
void	setAltitudeThreshold (int threshold)
int	altitudeThreshold () const
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
	DtSharedInterestManagementSettings (DtSharedSettingsManager &manager)
bool	applyFactoryOverrides (makArchives::DtInterestManagementRecord &rec) const

Protected Attributes
int	myDdmRegionSize
int	myRegionUpdateThreshold
bool	myAltitudeThresholdEnabled
int	myAltitudeThreshold
DtInterestManagementSettingsBackup *	mySettingsBackup

Friends
class	DtReadSettingsLock< DtSharedInterestManagementSettings >
class	DtWriteSettingsLock< DtSharedInterestManagementSettings >
class	DtBaseSharedSettingsManager< makArchives::DtInterestManagementRecord, DtSharedInterestManagementSettings >

Constructor & Destructor Documentation

virtual makVrv::DtSharedInterestManagementSettings::~DtSharedInterestManagementSettings ( )

virtual

DTOR.

makVrv::DtSharedInterestManagementSettings::DtSharedInterestManagementSettings ( DtSharedSettingsManager &  manager )

protected

Protected CTOR (Use DtReadSettingsLock and DtWriteSettingsLock).

Member Function Documentation

void makVrv::DtSharedInterestManagementSettings::setDdmRegionSize

(

int

size

)

int makVrv::DtSharedInterestManagementSettings::ddmRegionSize

(

)

const

void makVrv::DtSharedInterestManagementSettings::setRegionUpdateThreshold

(

int

percentage

)

int makVrv::DtSharedInterestManagementSettings::regionUpdateThreshold

(

)

const

void makVrv::DtSharedInterestManagementSettings::setAltitudeThresholdEnabled

(

bool

enabled

)

bool makVrv::DtSharedInterestManagementSettings::altitudeThresholdEnabled

(

)

const

void makVrv::DtSharedInterestManagementSettings::setAltitudeThreshold

(

int

threshold

)

int makVrv::DtSharedInterestManagementSettings::altitudeThreshold

(

)

const

void makVrv::DtSharedInterestManagementSettings::setFromRecord

(

const makArchives::DtInterestManagementRecord &

rec

)

Set the interest management settings from a record.

void makVrv::DtSharedInterestManagementSettings::getRecord

(

makArchives::DtInterestManagementRecord &

rec

)

const

Get the interest management settings as a record.

virtual const DtInterestManagementSettingsBackup* makVrv::DtSharedInterestManagementSettings::settingsBackup ( ) const

virtual

Accessor for the settings backup (const).

Reimplemented from makVrv::DtSharedSettings.

virtual DtInterestManagementSettingsBackup* makVrv::DtSharedInterestManagementSettings::settingsBackup ( )

virtual

Accessor for the settings backup.

Reimplemented from makVrv::DtSharedSettings.

virtual void makVrv::DtSharedInterestManagementSettings::backup ( )

virtual

Called to back up the settings.

Reimplemented from makVrv::DtSharedSettings.

static const std::string& makVrv::DtSharedInterestManagementSettings::className ( )

static

The class name for this settings object.

bool makVrv::DtSharedInterestManagementSettings::applyFactoryOverrides ( makArchives::DtInterestManagementRecord &  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< DtSharedInterestManagementSettings >

friend

Use the DtWriteSettingsLock to read the object.

friend class DtWriteSettingsLock< DtSharedInterestManagementSettings >

friend

Use the DtWriteSettingsLock to write to the object.

friend class DtBaseSharedSettingsManager< makArchives::DtInterestManagementRecord, DtSharedInterestManagementSettings >

friend

Member Data Documentation

int makVrv::DtSharedInterestManagementSettings::myDdmRegionSize

protected

int makVrv::DtSharedInterestManagementSettings::myRegionUpdateThreshold

protected

bool makVrv::DtSharedInterestManagementSettings::myAltitudeThresholdEnabled

protected

int makVrv::DtSharedInterestManagementSettings::myAltitudeThreshold

protected

DtInterestManagementSettingsBackup* makVrv::DtSharedInterestManagementSettings::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/DtSharedInterestManagementSettings.h