makVrv::DtSharedInterestManagementSettings Class Reference

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

Inheritance diagram for makVrv::DtSharedInterestManagementSettings:

Public Member Functions
virtual	~DtSharedInterestManagementSettings ()
	DTOR.
void	setFromRecord (const makArchives::DtInterestManagementRecord &rec)
	Set the interest management settings from a record.
void	getRecord (makArchives::DtInterestManagementRecord &rec) const
	Get the interest management settings as a record.
virtual const DtInterestManagementSettingsBackup *	settingsBackup () const
	Accessor for the settings backup (const).
virtual DtInterestManagementSettingsBackup *	settingsBackup ()
	Accessor for the settings backup.
virtual void	backup ()
	Called to back up the settings.
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)
	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 ()
	The class name for this settings object.

Protected Member Functions
	DtSharedInterestManagementSettings (DtSharedSettingsManager &manager)
	Protected CTOR (Use DtReadSettingsLock and DtWriteSettingsLock).

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

Friends
class	DtReadSettingsLock< DtSharedInterestManagementSettings >
	Use the DtWriteSettingsLock to read the object.
class	DtWriteSettingsLock< DtSharedInterestManagementSettings >
	Use the DtWriteSettingsLock to write to the object.

Detailed Description

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

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 std::string makVrv::DtSharedInterestManagementSettings::className ( )

static

The class name for this settings object.

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.

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:

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