makVrv::DtSharedDisplayUnitsSettings Class Reference

This class will maintain information about the display units used. More...

Inheritance diagram for makVrv::DtSharedDisplayUnitsSettings:

List of all members.

Classes
struct	CoordinateSystemAttributes
struct	DisplayAttributes
struct	UnitEntry
Public Types
typedef makArchives::DtDisplayUnitsSettingsRecord::CoordSys	CoordSys
typedef makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits	DistanceUnits
typedef makArchives::DtDisplayUnitsSettingsRecord::VelocityUnits	VelocityUnits
typedef makArchives::DtDisplayUnitsSettingsRecord::AccelerationUnits	AccelerationUnits
typedef makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits	OrientationUnits
typedef makArchives::DtDisplayUnitsSettingsRecord::RotVelocityUnits	RotVelocityUnits
typedef boost::unordered_map < CoordSys, int >	CoordSysDecimalsMap
typedef boost::unordered_map < CoordSys, DtUnicode >	CoordSysNotationsMap
Public Member Functions
virtual	~DtSharedDisplayUnitsSettings ()
	DTOR.
void	coordinateSystemLabels (const DtCoordinateSystem &displayCS, DtUnicode &x, DtUnicode &y, DtUnicode &z) const
void	coordinateSystemLabels (const DtCoordinateSystem &displayCS, CoordSys coordSys, DtUnicode &x, DtUnicode &y, DtUnicode &z) const
DtUnicode	xyUnitNotation (const DtCoordinateSystem &displayCS) const
DtUnicode	xyUnitNotation (const DtCoordinateSystem &displayCS, CoordSys coordSys) const
DtUnicode	zUnitNotation (const DtCoordinateSystem &displayCS) const
DtUnicode	zUnitNotation (const DtCoordinateSystem &displayCS, CoordSys coordSys) const
std::vector< std::string >	convertPositionToStringList (const DtCoordinateSystem &displayCS, CoordSys coordSys, const DtVector &pos) const
	Converts the given position to list of strings in the given units and decimals.
std::vector< std::string >	convertPositionToStringList (const DtCoordinateSystem &displayCS, const DtVector &pos) const
	Converts the given position to list of strings in the given units and decimals.
Settings setters and accessors
void	setDisplayUnitAttributes (DtUnitConverterCollection::DisplayUnitType attr, const DisplayAttributes &data)
	Retrieves the display attribute data for a given display attribute (speed, distance, altitude, etc.)
bool	getDisplayUnitAttributes (DtUnitConverterCollection::DisplayUnitType attr, DisplayAttributes &value) const
	Retrieves the display attribute data for a given display attribute (speed, distance, altitude, etc.)
DisplayAttributes *	findDisplayUnitAttributes (DtUnitConverterCollection::DisplayUnitType attr)
	Accessor for attribute data for the given display attribute.
const DisplayAttributes *	findDisplayUnitAttributes (DtUnitConverterCollection::DisplayUnitType attr) const
	Accessor for attribute data for the given display attribute (const).
void	setCoordinateSystemAttributes (const CoordinateSystemAttributes &data)
	Set the coordinate system attributes.
CoordinateSystemAttributes *	coordSysAttributes ()
	Get a pointer to the coordinate system attributes.
const CoordinateSystemAttributes *	coordinateSystemAttributes () const
	Get a const pointer to the coordinate system attributes.
void	getCoordinateSystemAttributes (CoordinateSystemAttributes &csAttr) const
	Fill in a CoordinateSystemAttributes object.
Display Unit Info Mutators
void	setCoordinateSystem (CoordSys cs)
void	setDistanceUnits (DistanceUnits distUnits)
void	setAltitudeUnits (DistanceUnits altUnits)
void	setVelocityUnits (VelocityUnits velocityUnits)
void	setOrientationUnits (OrientationUnits oriUnits)
void	setAccelerationUnits (AccelerationUnits accelUnits)
void	setRotationalVelocityUnits (RotVelocityUnits wUnits)
void	setCoordinateSystemDecimals (CoordSys cs, int decimals)
void	setDistanceUnitDecimals (DistanceUnits distUnit, int decimals)
void	setAltitudeUnitDecimals (DistanceUnits altUnit, int decimals)
void	setVelocityUnitDecimals (VelocityUnits velocityUnit, int decimals)
void	setOrientationUnitDecimals (OrientationUnits oriUnit, int decimals)
void	setAccelerationUnitDecimals (AccelerationUnits accelUnit, int decimals)
void	setRotationalVelocityUnitDecimals (RotVelocityUnits wUnit, int decimals)
Display Unit Info Accessors
int	coordinateSystemDecimals (CoordSys cs) const
int	distanceUnitDecimals (DistanceUnits distUnit) const
int	altitudeUnitDecimals (DistanceUnits altUnit) const
int	velocityUnitDecimals (VelocityUnits velocityUnit) const
int	orientationUnitDecimals (OrientationUnits oriUnit) const
int	accelerationUnitDecimals (AccelerationUnits accelUnit) const
int	rotationalVelocityUnitDecimals (RotVelocityUnits wUnit) const
DtUnicode	coordinateSystemNotation (CoordSys cs) const
DtUnicode	distanceUnitNotation (DistanceUnits distUnit) const
DtUnicode	altitudeUnitNotation (DistanceUnits altUnit) const
DtUnicode	velocityUnitNotation (VelocityUnits velocityUnit) const
DtUnicode	orientationUnitNotation (OrientationUnits oriUnit) const
DtUnicode	accelerationUnitNotation (AccelerationUnits accelUnit) const
DtUnicode	rotationalVelocityUnitNotation (RotVelocityUnits wUnit) const
Current Display Unit Info Accessors
CoordSys	currentCoordinateSystem () const
DistanceUnits	currentDistanceUnits () const
DistanceUnits	currentAltitudeUnits () const
VelocityUnits	currentVelocityUnits () const
OrientationUnits	currentOrientationUnits () const
AccelerationUnits	currentAccelerationUnits () const
RotVelocityUnits	currentRotationalVelocityUnits () const
int	currentCoordinateSystemDecimals () const
int	currentDistanceUnitDecimals () const
int	currentAltitudeUnitDecimals () const
int	currentVelocityUnitDecimals () const
int	currentOrientationUnitDecimals () const
int	currentAccelerationUnitDecimals () const
int	currentRotationalVelocityUnitDecimals () const
DtUnicode	currentCoordinateSystemNotation () const
DtUnicode	currentDistanceUnitNotation () const
DtUnicode	currentAltitudeUnitNotation () const
DtUnicode	currentVelocityUnitNotation () const
DtUnicode	currentOrientationUnitNotation () const
DtUnicode	currentAccelerationUnitNotation () const
DtUnicode	currentRotationalVelocityUnitNotation () const
Settings record / backup methods
void	setFromRecord (const makArchives::DtDisplayUnitsSettingsRecord &rec)
	Restore the settings from a record.
void	getRecord (makArchives::DtDisplayUnitsSettingsRecord &rec) const
	Get the settings as a record.
virtual const DtDisplayUnitsSettingsBackup *	settingsBackup () const
	Accessor for the settings backup (const).
virtual DtDisplayUnitsSettingsBackup *	settingsBackup ()
	Accessor for the settings backup.
virtual void	backup ()
	Called to back up the settings.
Protected Types
typedef boost::unordered_map < DtUnitConverterCollection::DisplayUnitType, DisplayAttributes >	EntryMap
	Map type that maps display unit types to its display attributes.
Protected Member Functions
	DtSharedDisplayUnitsSettings (DtSharedSettingsManager &manager)
	Protected CTOR Use DtReadSettingsLock and DtWriteSettingsLock.
CoordSys	currentCoordSysIndex () const
	Get the current coordinate system index.
int	currentCoordSysDecimals () const
	Get the decimals for the current coordinate system.
std::string	valueToText (double value, int decimals) const
void	initEntries ()
	Set up the map of attribute data.
Generic Display Unit Info Accessors
int	currentDisplayUnitIndex (DtUnitConverterCollection::DisplayUnitType attr) const
int	currentDisplayUnitDecimals (DtUnitConverterCollection::DisplayUnitType attr) const
DtUnicode	currentDisplayUnitNotation (DtUnitConverterCollection::DisplayUnitType attr) const
DtUnicode	currentDisplayUnitName (DtUnitConverterCollection::DisplayUnitType attr) const
void	currentDisplayUnitData (DtUnitConverterCollection::DisplayUnitType attr, int &index, DtUnicode &name, DtUnicode &notation, int &decimals) const
Static Protected Member Functions
static std::string	className ()
Protected Attributes
EntryMap	myEntries
CoordinateSystemAttributes	myCoordSysEntries
DtDisplayUnitsSettingsBackup *	mySettingsBackup
Friends
class	DtReadSettingsLock< DtSharedDisplayUnitsSettings >
	Use the DtReadSettingsLock to read the object.
class	DtWriteSettingsLock< DtSharedDisplayUnitsSettings >
	Use the DtWriteSettingsLock to write to the object.

---

Detailed Description

This class will maintain information about the display units used.

---

Member Typedef Documentation

typedef makArchives::DtDisplayUnitsSettingsRecord::CoordSys makVrv::DtSharedDisplayUnitsSettings::CoordSys

typedef makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits makVrv::DtSharedDisplayUnitsSettings::DistanceUnits

typedef makArchives::DtDisplayUnitsSettingsRecord::VelocityUnits makVrv::DtSharedDisplayUnitsSettings::VelocityUnits

typedef makArchives::DtDisplayUnitsSettingsRecord::AccelerationUnits makVrv::DtSharedDisplayUnitsSettings::AccelerationUnits

typedef makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits makVrv::DtSharedDisplayUnitsSettings::OrientationUnits

typedef makArchives::DtDisplayUnitsSettingsRecord::RotVelocityUnits makVrv::DtSharedDisplayUnitsSettings::RotVelocityUnits

typedef boost::unordered_map<CoordSys, int> makVrv::DtSharedDisplayUnitsSettings::CoordSysDecimalsMap

typedef boost::unordered_map<CoordSys, DtUnicode> makVrv::DtSharedDisplayUnitsSettings::CoordSysNotationsMap

typedef boost::unordered_map<DtUnitConverterCollection::DisplayUnitType, DisplayAttributes> makVrv::DtSharedDisplayUnitsSettings::EntryMap [protected]

Map type that maps display unit types to its display attributes.

---

Constructor & Destructor Documentation

virtual makVrv::DtSharedDisplayUnitsSettings::~DtSharedDisplayUnitsSettings

(

)

[virtual]

DTOR.

makVrv::DtSharedDisplayUnitsSettings::DtSharedDisplayUnitsSettings

(

DtSharedSettingsManager &

manager

)

[protected]

Protected CTOR Use DtReadSettingsLock and DtWriteSettingsLock.

---

Member Function Documentation

void makVrv::DtSharedDisplayUnitsSettings::setDisplayUnitAttributes	(	DtUnitConverterCollection::DisplayUnitType	attr,
		const DisplayAttributes &	data
	)

Retrieves the display attribute data for a given display attribute (speed, distance, altitude, etc.)

Returns:

True if the data was successfully retrieved. False otherwise.

Parameters:

DisplayUnitType	attr Attribute to get the data for
DisplayAttributeData&	value Argument in which the data is returned

bool makVrv::DtSharedDisplayUnitsSettings::getDisplayUnitAttributes	(	DtUnitConverterCollection::DisplayUnitType	attr,
		DisplayAttributes &	value
	)		const

Retrieves the display attribute data for a given display attribute (speed, distance, altitude, etc.)

Returns:

True if the data was successfully retrieved. False otherwise.

Parameters:

DisplayUnitType	attr Attribute to get the data for
DisplayAttributeData&	value Argument in which the data is returned

DisplayAttributes* makVrv::DtSharedDisplayUnitsSettings::findDisplayUnitAttributes

(

DtUnitConverterCollection::DisplayUnitType

attr

)

Accessor for attribute data for the given display attribute.

Parameters:

DisplayUnitType

attr

Returns:

Display attribute data associated with the given display attribute (speed, distance, altitude, etc.)

const DisplayAttributes* makVrv::DtSharedDisplayUnitsSettings::findDisplayUnitAttributes

(

DtUnitConverterCollection::DisplayUnitType

attr

)

const

Accessor for attribute data for the given display attribute (const).

Parameters:

DisplayUnitType

attr

Returns:

Display attribute data associated with the given display attribute (speed, distance, altitude, etc.)

void makVrv::DtSharedDisplayUnitsSettings::setCoordinateSystemAttributes

(

const CoordinateSystemAttributes &

data

)

Set the coordinate system attributes.

CoordinateSystemAttributes* makVrv::DtSharedDisplayUnitsSettings::coordSysAttributes

(

)

Get a pointer to the coordinate system attributes.

const CoordinateSystemAttributes* makVrv::DtSharedDisplayUnitsSettings::coordinateSystemAttributes

(

)

const

Get a const pointer to the coordinate system attributes.

void makVrv::DtSharedDisplayUnitsSettings::getCoordinateSystemAttributes

(

CoordinateSystemAttributes &

csAttr

)

const

Fill in a CoordinateSystemAttributes object.

void makVrv::DtSharedDisplayUnitsSettings::setCoordinateSystem

(

CoordSys

cs

)

void makVrv::DtSharedDisplayUnitsSettings::setDistanceUnits

(

DistanceUnits

distUnits

)

void makVrv::DtSharedDisplayUnitsSettings::setAltitudeUnits

(

DistanceUnits

altUnits

)

void makVrv::DtSharedDisplayUnitsSettings::setVelocityUnits

(

VelocityUnits

velocityUnits

)

void makVrv::DtSharedDisplayUnitsSettings::setOrientationUnits

(

OrientationUnits

oriUnits

)

void makVrv::DtSharedDisplayUnitsSettings::setAccelerationUnits

(

AccelerationUnits

accelUnits

)

void makVrv::DtSharedDisplayUnitsSettings::setRotationalVelocityUnits

(

RotVelocityUnits

wUnits

)

void makVrv::DtSharedDisplayUnitsSettings::setCoordinateSystemDecimals	(	CoordSys	cs,
		int	decimals
	)

void makVrv::DtSharedDisplayUnitsSettings::setDistanceUnitDecimals	(	DistanceUnits	distUnit,
		int	decimals
	)

void makVrv::DtSharedDisplayUnitsSettings::setAltitudeUnitDecimals	(	DistanceUnits	altUnit,
		int	decimals
	)

void makVrv::DtSharedDisplayUnitsSettings::setVelocityUnitDecimals	(	VelocityUnits	velocityUnit,
		int	decimals
	)

void makVrv::DtSharedDisplayUnitsSettings::setOrientationUnitDecimals	(	OrientationUnits	oriUnit,
		int	decimals
	)

void makVrv::DtSharedDisplayUnitsSettings::setAccelerationUnitDecimals	(	AccelerationUnits	accelUnit,
		int	decimals
	)

void makVrv::DtSharedDisplayUnitsSettings::setRotationalVelocityUnitDecimals	(	RotVelocityUnits	wUnit,
		int	decimals
	)

int makVrv::DtSharedDisplayUnitsSettings::coordinateSystemDecimals

(

CoordSys

cs

)

const

int makVrv::DtSharedDisplayUnitsSettings::distanceUnitDecimals

(

DistanceUnits

distUnit

)

const

int makVrv::DtSharedDisplayUnitsSettings::altitudeUnitDecimals

(

DistanceUnits

altUnit

)

const

int makVrv::DtSharedDisplayUnitsSettings::velocityUnitDecimals

(

VelocityUnits

velocityUnit

)

const

int makVrv::DtSharedDisplayUnitsSettings::orientationUnitDecimals

(

OrientationUnits

oriUnit

)

const

int makVrv::DtSharedDisplayUnitsSettings::accelerationUnitDecimals

(

AccelerationUnits

accelUnit

)

const

int makVrv::DtSharedDisplayUnitsSettings::rotationalVelocityUnitDecimals

(

RotVelocityUnits

wUnit

)

const

DtUnicode makVrv::DtSharedDisplayUnitsSettings::coordinateSystemNotation

(

CoordSys

cs

)

const

DtUnicode makVrv::DtSharedDisplayUnitsSettings::distanceUnitNotation

(

DistanceUnits

distUnit

)

const

DtUnicode makVrv::DtSharedDisplayUnitsSettings::altitudeUnitNotation

(

DistanceUnits

altUnit

)

const

DtUnicode makVrv::DtSharedDisplayUnitsSettings::velocityUnitNotation

(

VelocityUnits

velocityUnit

)

const

DtUnicode makVrv::DtSharedDisplayUnitsSettings::orientationUnitNotation

(

OrientationUnits

oriUnit

)

const

DtUnicode makVrv::DtSharedDisplayUnitsSettings::accelerationUnitNotation

(

AccelerationUnits

accelUnit

)

const

DtUnicode makVrv::DtSharedDisplayUnitsSettings::rotationalVelocityUnitNotation

(

RotVelocityUnits

wUnit

)

const

CoordSys makVrv::DtSharedDisplayUnitsSettings::currentCoordinateSystem

(

)

const

DistanceUnits makVrv::DtSharedDisplayUnitsSettings::currentDistanceUnits

(

)

const

DistanceUnits makVrv::DtSharedDisplayUnitsSettings::currentAltitudeUnits

(

)

const

VelocityUnits makVrv::DtSharedDisplayUnitsSettings::currentVelocityUnits

(

)

const

OrientationUnits makVrv::DtSharedDisplayUnitsSettings::currentOrientationUnits

(

)

const

AccelerationUnits makVrv::DtSharedDisplayUnitsSettings::currentAccelerationUnits

(

)

const

RotVelocityUnits makVrv::DtSharedDisplayUnitsSettings::currentRotationalVelocityUnits

(

)

const

int makVrv::DtSharedDisplayUnitsSettings::currentCoordinateSystemDecimals

(

)

const

int makVrv::DtSharedDisplayUnitsSettings::currentDistanceUnitDecimals

(

)

const

int makVrv::DtSharedDisplayUnitsSettings::currentAltitudeUnitDecimals

(

)

const

int makVrv::DtSharedDisplayUnitsSettings::currentVelocityUnitDecimals

(

)

const

int makVrv::DtSharedDisplayUnitsSettings::currentOrientationUnitDecimals

(

)

const

int makVrv::DtSharedDisplayUnitsSettings::currentAccelerationUnitDecimals

(

)

const

int makVrv::DtSharedDisplayUnitsSettings::currentRotationalVelocityUnitDecimals

(

)

const

DtUnicode makVrv::DtSharedDisplayUnitsSettings::currentCoordinateSystemNotation

(

)

const

DtUnicode makVrv::DtSharedDisplayUnitsSettings::currentDistanceUnitNotation

(

)

const

DtUnicode makVrv::DtSharedDisplayUnitsSettings::currentAltitudeUnitNotation

(

)

const

DtUnicode makVrv::DtSharedDisplayUnitsSettings::currentVelocityUnitNotation

(

)

const

DtUnicode makVrv::DtSharedDisplayUnitsSettings::currentOrientationUnitNotation

(

)

const

DtUnicode makVrv::DtSharedDisplayUnitsSettings::currentAccelerationUnitNotation

(

)

const

DtUnicode makVrv::DtSharedDisplayUnitsSettings::currentRotationalVelocityUnitNotation

(

)

const

void makVrv::DtSharedDisplayUnitsSettings::coordinateSystemLabels	(	const DtCoordinateSystem &	displayCS,
		DtUnicode &	x,
		DtUnicode &	y,
		DtUnicode &	z
	)		const

void makVrv::DtSharedDisplayUnitsSettings::coordinateSystemLabels	(	const DtCoordinateSystem &	displayCS,
		CoordSys	coordSys,
		DtUnicode &	x,
		DtUnicode &	y,
		DtUnicode &	z
	)		const

DtUnicode makVrv::DtSharedDisplayUnitsSettings::xyUnitNotation

(

const DtCoordinateSystem &

displayCS

)

const

DtUnicode makVrv::DtSharedDisplayUnitsSettings::xyUnitNotation	(	const DtCoordinateSystem &	displayCS,
		CoordSys	coordSys
	)		const

DtUnicode makVrv::DtSharedDisplayUnitsSettings::zUnitNotation

(

const DtCoordinateSystem &

displayCS

)

const

DtUnicode makVrv::DtSharedDisplayUnitsSettings::zUnitNotation	(	const DtCoordinateSystem &	displayCS,
		CoordSys	coordSys
	)		const

std::vector<std::string> makVrv::DtSharedDisplayUnitsSettings::convertPositionToStringList	(	const DtCoordinateSystem &	displayCS,
		CoordSys	coordSys,
		const DtVector &	pos
	)		const

Converts the given position to list of strings in the given units and decimals.

Performs the conversion for the given coordinate system (coordSys)

std::vector<std::string> makVrv::DtSharedDisplayUnitsSettings::convertPositionToStringList	(	const DtCoordinateSystem &	displayCS,
		const DtVector &	pos
	)		const

Converts the given position to list of strings in the given units and decimals.

Performs the conversion for the current coordinate system.

void makVrv::DtSharedDisplayUnitsSettings::setFromRecord

(

const makArchives::DtDisplayUnitsSettingsRecord &

rec

)

Restore the settings from a record.

void makVrv::DtSharedDisplayUnitsSettings::getRecord

(

makArchives::DtDisplayUnitsSettingsRecord &

rec

)

const

Get the settings as a record.

virtual const DtDisplayUnitsSettingsBackup* makVrv::DtSharedDisplayUnitsSettings::settingsBackup

(

)

const [virtual]

Accessor for the settings backup (const).

Reimplemented from makVrv::DtSharedSettings.

virtual DtDisplayUnitsSettingsBackup* makVrv::DtSharedDisplayUnitsSettings::settingsBackup

(

)

[virtual]

Accessor for the settings backup.

Reimplemented from makVrv::DtSharedSettings.

virtual void makVrv::DtSharedDisplayUnitsSettings::backup

(

)

[virtual]

Called to back up the settings.

Reimplemented from makVrv::DtSharedSettings.

CoordSys makVrv::DtSharedDisplayUnitsSettings::currentCoordSysIndex

(

)

const [protected]

Get the current coordinate system index.

int makVrv::DtSharedDisplayUnitsSettings::currentCoordSysDecimals

(

)

const [protected]

Get the decimals for the current coordinate system.

int makVrv::DtSharedDisplayUnitsSettings::currentDisplayUnitIndex

(

DtUnitConverterCollection::DisplayUnitType

attr

)

const [protected]

int makVrv::DtSharedDisplayUnitsSettings::currentDisplayUnitDecimals

(

DtUnitConverterCollection::DisplayUnitType

attr

)

const [protected]

DtUnicode makVrv::DtSharedDisplayUnitsSettings::currentDisplayUnitNotation

(

DtUnitConverterCollection::DisplayUnitType

attr

)

const [protected]

DtUnicode makVrv::DtSharedDisplayUnitsSettings::currentDisplayUnitName

(

DtUnitConverterCollection::DisplayUnitType

attr

)

const [protected]

void makVrv::DtSharedDisplayUnitsSettings::currentDisplayUnitData	(	DtUnitConverterCollection::DisplayUnitType	attr,
		int &	index,
		DtUnicode &	name,
		DtUnicode &	notation,
		int &	decimals
	)		const [protected]

std::string makVrv::DtSharedDisplayUnitsSettings::valueToText	(	double	value,
		int	decimals
	)		const [protected]

static std::string makVrv::DtSharedDisplayUnitsSettings::className

(

)

[static, protected]

void makVrv::DtSharedDisplayUnitsSettings::initEntries

(

)

[protected]

Set up the map of attribute data.

Creates the map of attribute data for storing the different display unit parameters.

---

Friends And Related Function Documentation

friend class DtReadSettingsLock< DtSharedDisplayUnitsSettings > [friend]

Use the DtReadSettingsLock to read the object.

friend class DtWriteSettingsLock< DtSharedDisplayUnitsSettings > [friend]

Use the DtWriteSettingsLock to write to the object.

---

Member Data Documentation

EntryMap makVrv::DtSharedDisplayUnitsSettings::myEntries [protected]

CoordinateSystemAttributes makVrv::DtSharedDisplayUnitsSettings::myCoordSysEntries [protected]

DtDisplayUnitsSettingsBackup* makVrv::DtSharedDisplayUnitsSettings::mySettingsBackup [protected]

---

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

• include/vrvCore/DtSharedDisplayUnitsSettings.h