makVrv::DtSharedTrackHistorySettings Class Reference

This class maintains the track history settings. More...

Inheritance diagram for makVrv::DtSharedTrackHistorySettings:

List of all members.

Public Member Functions
virtual	~DtSharedTrackHistorySettings ()
	DTOR.
Setting Getters/Setters
virtual int	trackHistoryRibbonLength () const
	Gets the maximum track history ribbon length (in samples).
virtual void	setTrackHistoryRibbonLength (int maxSamples)
	Sets the maximum track history ribbon length (in samples).
virtual float	trackHistoryRibbonSpacing () const
	Gets the spacing between track history ribbon samples (in meters).
virtual void	setTrackHistoryRibbonSpacing (float spacing)
	Sets the spacing between track history ribbon samples (in meters).
virtual bool	trackHistoryRibbonInfinite () const
	Gets whether the track history ribbon is 'infinitely' long (250k samples).
virtual void	setTrackHistoryRibbonInfinite (bool isInfinite)
	Sets whether the track history ribbon is 'infinitely' long (250k samples).
Settings record / backup methods
void	setFromRecord (const makArchives::DtTrackHistorySettingsRecord &rec)
	Restore the settings from a record.
void	getRecord (makArchives::DtTrackHistorySettingsRecord &rec) const
	Get the settings as a record.
virtual const DtTrackHistorySettingsBackup *	settingsBackup () const
	Accessor for the settings backup (const).
virtual DtTrackHistorySettingsBackup *	settingsBackup ()
	Accessor for the settings backup.
virtual void	backup ()
	Called to back up the settings.
Static Public Member Functions
static std::string	className ()
	The class name for this settings object.
Protected Member Functions
	DtSharedTrackHistorySettings (DtSharedSettingsManager &manager)
	Protected CTOR (Use DtReadSettingsLock and DtWriteSettingsLock).
Protected Attributes
int	myTrackHistoryRibbonLength
float	myTrackHistoryRibbonSpacing
bool	myTrackHistoryInfiniteFlag
DtTrackHistorySettingsBackup *	mySettingsBackup
Friends
class	DtReadSettingsLock< DtSharedTrackHistorySettings >
	Use the DtReadSettingsLock to read the object.
class	DtWriteSettingsLock< DtSharedTrackHistorySettings >
	Use the DtWriteSettingsLock to write to the object.

---

Detailed Description

This class maintains the track history settings.

---

Constructor & Destructor Documentation

virtual makVrv::DtSharedTrackHistorySettings::~DtSharedTrackHistorySettings

(

)

[virtual]

DTOR.

makVrv::DtSharedTrackHistorySettings::DtSharedTrackHistorySettings

(

DtSharedSettingsManager &

manager

)

[protected]

Protected CTOR (Use DtReadSettingsLock and DtWriteSettingsLock).

---

Member Function Documentation

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::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).

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

---

Member Data Documentation

int makVrv::DtSharedTrackHistorySettings::myTrackHistoryRibbonLength [protected]

float makVrv::DtSharedTrackHistorySettings::myTrackHistoryRibbonSpacing [protected]

bool makVrv::DtSharedTrackHistorySettings::myTrackHistoryInfiniteFlag [protected]

DtTrackHistorySettingsBackup* makVrv::DtSharedTrackHistorySettings::mySettingsBackup [protected]

---

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

• include/vrvCore/DtSharedTrackHistorySettings.h