makVrv::DtSharedTrackHistorySettings Class Reference

This class maintains the track history settings.

Inheritance diagram for makVrv::DtSharedTrackHistorySettings:

Public Member Functions
virtual	~DtSharedTrackHistorySettings ()
Setting Getters/Setters
virtual int	trackHistoryRibbonLength () const
virtual void	setTrackHistoryRibbonLength (int maxSamples)
virtual float	trackHistoryRibbonTimeout () const
virtual void	setTrackHistoryRibbonTimeout (float duration)
virtual float	trackHistoryRibbonSpacing () const
virtual void	setTrackHistoryRibbonSpacing (float spacing)
virtual bool	trackHistoryRibbonInfinite () const
virtual void	setTrackHistoryRibbonInfinite (bool isInfinite)
virtual bool	trackHistoryHeightLinesEnabled () const
virtual void	setTrackHistoryHeightLinesEnabled (bool enabled)
Settings record / backup methods
void	setFromRecord (const makArchives::DtTrackHistorySettingsRecord &rec)
void	getRecord (makArchives::DtTrackHistorySettingsRecord &rec) const
virtual const DtTrackHistorySettingsBackup *	settingsBackup () const
virtual DtTrackHistorySettingsBackup *	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
	DtSharedTrackHistorySettings (DtSharedSettingsManager &manager)
bool	applyFactoryOverrides (makArchives::DtTrackHistorySettingsRecord &rec) const

Protected Attributes
int	myTrackHistoryRibbonLength
float	myTrackHistoryRibbonTimeout
float	myTrackHistoryRibbonSpacing
bool	myTrackHistoryInfiniteFlag
bool	myTrackHistoryHeightLinesEnabled
DtTrackHistorySettingsBackup *	mySettingsBackup

Private Member Functions
	DtSharedTrackHistorySettings ()
	DtSharedTrackHistorySettings (const DtSharedTrackHistorySettings &)
DtSharedTrackHistorySettings &	operator= (const DtSharedTrackHistorySettings &)

Friends
class	DtReadSettingsLock< DtSharedTrackHistorySettings >
class	DtWriteSettingsLock< DtSharedTrackHistorySettings >
class	DtBaseSharedSettingsManager< makArchives::DtTrackHistorySettingsRecord, DtSharedTrackHistorySettings >

Constructor & Destructor Documentation

virtual makVrv::DtSharedTrackHistorySettings::~DtSharedTrackHistorySettings ( )

virtual

DTOR.

makVrv::DtSharedTrackHistorySettings::DtSharedTrackHistorySettings ( DtSharedSettingsManager &  manager )

protected

Protected CTOR (Use DtReadSettingsLock and DtWriteSettingsLock).

makVrv::DtSharedTrackHistorySettings::DtSharedTrackHistorySettings ( )

private

unimplemented private default constructor

makVrv::DtSharedTrackHistorySettings::DtSharedTrackHistorySettings ( const DtSharedTrackHistorySettings &  )

private

Copy Constructor not implemented – Copy not allowed.

Member Function Documentation

bool makVrv::DtSharedTrackHistorySettings::applyFactoryOverrides ( makArchives::DtTrackHistorySettingsRecord &  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.

DtSharedTrackHistorySettings& makVrv::DtSharedTrackHistorySettings::operator= ( const DtSharedTrackHistorySettings &  )

private

Assignment Operator not implemented – Copy not allowed.

virtual int makVrv::DtSharedTrackHistorySettings::trackHistoryRibbonLength ( ) const

virtual

Gets the maximum track history ribbon length (in samples).

virtual void makVrv::DtSharedTrackHistorySettings::setTrackHistoryRibbonLength ( int  maxSamples )

virtual

Sets the maximum track history ribbon length (in samples).

virtual float makVrv::DtSharedTrackHistorySettings::trackHistoryRibbonTimeout ( ) const

virtual

Gets the maximum track history ribbon segment timeout (in seconds).

virtual void makVrv::DtSharedTrackHistorySettings::setTrackHistoryRibbonTimeout ( float  duration )

virtual

Sets the maximum track history ribbon segment timeout (in seconds).

virtual float makVrv::DtSharedTrackHistorySettings::trackHistoryRibbonSpacing ( ) const

virtual

Gets the spacing between track history ribbon samples (in meters).

virtual void makVrv::DtSharedTrackHistorySettings::setTrackHistoryRibbonSpacing ( float  spacing )

virtual

Sets the spacing between track history ribbon samples (in meters).

virtual bool makVrv::DtSharedTrackHistorySettings::trackHistoryRibbonInfinite ( ) const

virtual

Gets whether the track history ribbon is 'infinitely' long (250k samples).

virtual void makVrv::DtSharedTrackHistorySettings::setTrackHistoryRibbonInfinite ( bool  isInfinite )

virtual

Sets whether the track history ribbon is 'infinitely' long (250k samples).

virtual bool makVrv::DtSharedTrackHistorySettings::trackHistoryHeightLinesEnabled ( ) const

virtual

Gets whether the track history height lines are enabled.

virtual void makVrv::DtSharedTrackHistorySettings::setTrackHistoryHeightLinesEnabled ( bool  enabled )

virtual

Sets whether the track history height lines are enabled.

void makVrv::DtSharedTrackHistorySettings::setFromRecord

(

const makArchives::DtTrackHistorySettingsRecord &

rec

)

Restore the settings from a record.

void makVrv::DtSharedTrackHistorySettings::getRecord

(

makArchives::DtTrackHistorySettingsRecord &

rec

)

const

Get the settings as a record.

virtual const DtTrackHistorySettingsBackup* makVrv::DtSharedTrackHistorySettings::settingsBackup ( ) const

virtual

Accessor for the settings backup (const).

Reimplemented from makVrv::DtSharedSettings.

virtual DtTrackHistorySettingsBackup* makVrv::DtSharedTrackHistorySettings::settingsBackup ( )

virtual

Accessor for the settings backup.

Reimplemented from makVrv::DtSharedSettings.

virtual void makVrv::DtSharedTrackHistorySettings::backup ( )

virtual

Called to back up the settings.

Reimplemented from makVrv::DtSharedSettings.

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

static

The class name for this settings object.

Friends And Related Function Documentation

friend class DtReadSettingsLock< DtSharedTrackHistorySettings >

friend

Use the DtReadSettingsLock to read the object.

friend class DtWriteSettingsLock< DtSharedTrackHistorySettings >

friend

Use the DtWriteSettingsLock to write to the object.

friend class DtBaseSharedSettingsManager< makArchives::DtTrackHistorySettingsRecord, DtSharedTrackHistorySettings >

friend

Member Data Documentation

int makVrv::DtSharedTrackHistorySettings::myTrackHistoryRibbonLength

protected

float makVrv::DtSharedTrackHistorySettings::myTrackHistoryRibbonTimeout

protected

float makVrv::DtSharedTrackHistorySettings::myTrackHistoryRibbonSpacing

protected

bool makVrv::DtSharedTrackHistorySettings::myTrackHistoryInfiniteFlag

protected

bool makVrv::DtSharedTrackHistorySettings::myTrackHistoryHeightLinesEnabled

protected

DtTrackHistorySettingsBackup* makVrv::DtSharedTrackHistorySettings::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/DtSharedTrackHistorySettings.h