makVrv::DtSharedDisplayUnitsSettings Class Reference

This class will maintain information about the units, display units, and coordinate systems used in VR-Vantage. More...

Inheritance diagram for makVrv::DtSharedDisplayUnitsSettings:

Classes
struct	UnitEntry
	Attributes for a 'Unit' of measurement, e.g. Meters or Minutes. More...

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 makArchives::DtDisplayUnitsSettingsRecord::TemperatureUnits	TemperatureUnits
typedef makArchives::DtDisplayUnitsSettingsRecord::PressureUnits	PressureUnits
typedef makArchives::DtDisplayUnitsSettingsRecord::NorthUnits	NorthUnits
typedef makArchives::DtDisplayUnitsSettingsRecord::DisplayUnitAttributes	DisplayAttributes
typedef std::vector< UnitEntry >	Units
	A vector of unit names and unit notations. More...
typedef std::unordered_map < makArchives::DtDisplayUnitsSettingsRecord::DisplayUnitType, Units >	UnitMap
	A mapping of display unit types to the unit of measurements that can measure that display unit type. More...
typedef std::map< std::string, DisplayAttributes >	DisplayUnitMap
	A mapping of a display unit's name to the attributes for that display unit. More...
typedef std::unordered_map < std::string, DisplayUnitMap >	DisplayUnitCollectionMap
	A mapping of a display unit collection's name to the collection of display units. More...

Public Member Functions
virtual	~DtSharedDisplayUnitsSettings ()
	DTOR. More...
void	coordinateSystemLabels (const DtCoordinateSystem &displayCS, DtUnicode &x, DtUnicode &y, DtUnicode &z) const
	Retrieve the X/Y/Z axis labels for the provided display coordinate system, by reference. More...
void	coordinateSystemLabels (const DtCoordinateSystem &displayCS, CoordSys coordSys, DtUnicode &x, DtUnicode &y, DtUnicode &z) const
	Retrieve the X/Y/Z axis labels for the provided display coordinate system, by reference. More...
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< DtUnicode >	convertPositionToNotatedStringList (const DtCoordinateSystem &displayCS, CoordSys coordSys, const DtVector &pos, DistanceUnits coordinateSystemUnit, unsigned int coordinateSystemDecimals, DistanceUnits altitudeUnit, unsigned int altitudeDecimals) const
	Convert the geocentric position to a vector of notated strings. More...
std::vector< DtUnicode >	convertPositionToNotatedStringList (const DtCoordinateSystem &displayCS, const DtVector &pos, DistanceUnits coordinateSystemUnit, unsigned int coordinateSystemDecimals, DistanceUnits altitudeUnit, unsigned int altitudeDecimals) const
	Convert the geocentric position to a vector of notated strings. More...
std::vector< std::string >	convertPositionToStringList (const DtCoordinateSystem &displayCS, CoordSys coordSys, const DtVector &pos, DistanceUnits coordinateSystemUnit, unsigned int coordinateSystemDecimals, DistanceUnits altitudeUnit, unsigned int altitudeDecimals) const
	Converts the given position to list of strings in the given units and decimals. More...
std::vector< std::string >	convertPositionToStringList (const DtCoordinateSystem &displayCS, const DtVector &pos, DistanceUnits coordinateSystemUnit, unsigned int coordinateSystemDecimals, DistanceUnits altitudeUnit, unsigned int altitudeDecimals) const
	Converts the given position to list of strings in the given units and decimals. More...
Shared Display Unit Settings Mutators and Accessors
void	setUnitAttributes (makArchives::DtDisplayUnitsSettingsRecord::DisplayUnitType displayUnitType, const Units &data)
	Define a new unit of measurement for a display unit type For example, some units of measurements for Distance are: More...
bool	getUnitAttributes (makArchives::DtDisplayUnitsSettingsRecord::DisplayUnitType displayUnitType, Units &value) const
	Get all the units of measurement for a given display unit type. More...
const DisplayUnitCollectionMap &	displayUnitCollectionMap () const
	Get a const reference to the internal display unit collection map. More...
DisplayUnitCollectionMap &	displayUnitCollectionMap ()
	Get a reference to the internal display unit collection map. More...
void	setDisplayUnitAttributes (const DtUnicode &displayUnitCollectionName, const DtUnicode &displayUnitName, const DisplayAttributes &data)
	Set the attributes for a given 'display unit'. More...
bool	getDisplayUnitAttributes (const DtUnicode &displayUnitCollectionName, const DtUnicode &displayUnitName, DisplayAttributes &value) const
	Get the attributes for a given 'display unit'. More...
DisplayAttributes *	findDisplayUnitAttributes (const DtUnicode &displayUnitCollectionName, const DtUnicode &displayUnitName)
	Find the attributes for a given 'display unit'. More...
const DisplayAttributes *	findDisplayUnitAttributes (const DtUnicode &displayUnitCollectionName, const DtUnicode &displayUnitName) const
	Find the attributes for a given 'display unit' - const version. More...
void	setSuppressMagneticNorthNotationEnabled (bool isEnabled)
	Set whether or not to suppress the Heading Notation when using Magnetic North. More...
bool	isSuppressMagneticNorthNotationEnabled () const
	Get whether or not to suppress the Heading Notation when using Magnetic North. More...
Coordinate System Info Mutators and Accessors
void	setCoordinateSystem (CoordSys cs)
	Set the Coordinate System display unit in the 'Application' collection Akin to calling: setDisplayUnitUnit(theApplicationDisplayUnitCollectionName, theCoordinateSystemDisplayUnitName, cs) More...
Display Unit Info Mutators and Accessors
void	setDisplayUnitUnit (const DtUnicode &displayUnitCollectionName, const DtUnicode &displayUnitName, unsigned int unitEnumerationValue)
	Update the unit of measurement used for a given 'display unit'. More...
void	setDisplayUnitDecimals (const DtUnicode &displayUnitCollectionName, const DtUnicode &displayUnitName, unsigned int decimals)
	Update the number of decimals used for a given 'display unit'. More...
unsigned int	displayUnitUnit (const DtUnicode &displayUnitCollectionName, const DtUnicode &displayUnitName) const
	Returns the enumeration value of the specific unit of measurement to use for a display unit. More...
unsigned int	displayUnitDecimals (const DtUnicode &displayUnitCollectionName, const DtUnicode &displayUnitName) const
	Returns the number of decimal places to use for a display unit. More...
DtUnicode	displayUnitNotation (const DtUnicode &displayUnitCollectionName, const DtUnicode &displayUnitName) const
	Returns the notation to use for a display unit. More...
Unit of Measurement Info Accessors
DtUnicode	coordinateSystemNotation (CoordSys cs) const
DtUnicode	distanceUnitNotation (DistanceUnits distUnit) const
DtUnicode	velocityUnitNotation (VelocityUnits velocityUnit) const
DtUnicode	orientationUnitNotation (OrientationUnits oriUnit) const
DtUnicode	accelerationUnitNotation (AccelerationUnits accelUnit) const
DtUnicode	rotationalVelocityUnitNotation (RotVelocityUnits wUnit) const
DtUnicode	temperatureUnitNotation (TemperatureUnits tempUnit) const
DtUnicode	pressureUnitNotation (PressureUnits pressureUnit) const
DtUnicode	northUnitNotation (NorthUnits northUnit) const
Current Coordinate System Info Accessors
CoordSys	currentCoordinateSystem () const
int	currentCoordinateSystemDecimals () const
DtUnicode	currentCoordinateSystemNotation () const
Settings record / backup methods
void	setFromRecord (const makArchives::DtDisplayUnitsSettingsRecord &rec)
	Restore the settings from a record. More...
void	getRecord (makArchives::DtDisplayUnitsSettingsRecord &rec) const
	Get the settings as a record. More...
virtual const DtDisplayUnitsSettingsBackup *	settingsBackup () const
	Accessor for the settings backup (const). More...
virtual DtDisplayUnitsSettingsBackup *	settingsBackup ()
	Accessor for the settings backup. More...
virtual void	backup ()
	Called to back up the settings. More...
Public Member Functions inherited from makVrv::DtSharedSettings
	DtSharedSettings (const DtSharedSettingsManager &manager)
	CTOR. More...
virtual	~DtSharedSettings ()
	DTOR. More...
boost::shared_mutex &	mutex ()
	Get the mutex for the settings object. More...
SafetyKey	safeToEmitSignals ()
	Create a safety key for the function, see above example. More...
void	setCurrentWriteLock (boost::unique_lock< boost::shared_mutex > *currentWriteLock)
	No need to call, set by the DtWriteSettingLock object. More...
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor. More...
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor. More...

Static Public Attributes
static const DtUnicode	theApplicationDisplayUnitCollectionName
	The DtUnicode names used for the display unit collections. More...
static const DtUnicode	theWeatherDisplayUnitCollectionName
static const DtUnicode	theDefaultDisplayUnitCollectionName
static const DtUnicode	theFixedWingDisplayUnitCollectionName
static const DtUnicode	theRotaryWingDisplayUnitCollectionName
static const DtUnicode	theLifeFormDisplayUnitCollectionName
static const DtUnicode	theGroundDisplayUnitCollectionName
static const DtUnicode	theSurfaceDisplayUnitCollectionName
static const DtUnicode	theSubsurfaceDisplayUnitCollectionName
static const DtUnicode	theSpaceDisplayUnitCollectionName
static const DtUnicode	theSmallDistanceDisplayUnitName
	The DtUnicode names used for the display units. More...
static const DtUnicode	theDistanceDisplayUnitName
static const DtUnicode	theAltitudeDisplayUnitName
static const DtUnicode	theSpeedDisplayUnitName
static const DtUnicode	theRotationalVelocityDisplayUnitName
static const DtUnicode	theAccelerationDisplayUnitName
static const DtUnicode	theOrientationDisplayUnitName
static const DtUnicode	theHeadingDisplayUnitName
static const DtUnicode	theCoordinateSystemDisplayUnitName
static const DtUnicode	theSensorViewCoordinateSystemDisplayUnitName
static const DtUnicode	theVisibilityDisplayUnitName
static const DtUnicode	thePressureDisplayUnitName
static const DtUnicode	theTemperatureDisplayUnitName
static const DtUnicode	thePrecipitationDepthDisplayUnitName
static const DtUnicode	thePrecipitationRateDisplayUnitName
static const DtUnicode	theWindSpeedDisplayUnitName
static const DtUnicode	theDirectionDisplayUnitName

Protected Member Functions
	DtSharedDisplayUnitsSettings (DtSharedSettingsManager &manager)
	Protected CTOR Use DtReadSettingsLock and DtWriteSettingsLock. More...
CoordSys	currentCoordSysIndex () const
	Get the current coordinate system index. More...
int	currentCoordSysDecimals () const
	Get the decimals for the current coordinate system. More...
std::string	valueToText (double value, int decimals) const
void	initEntries ()
	Set up the map of attribute data. More...

Static Protected Member Functions
static const std::string &	className ()

Protected Attributes
UnitMap	myUnits
DisplayUnitCollectionMap	myDisplayUnits
bool	mySurpressMagneticNorthNotationEnabled
DtDisplayUnitsSettingsBackup *	mySettingsBackup

Friends
class	DisplayAttributes
class	DtReadSettingsLock< DtSharedDisplayUnitsSettings >
	Use the DtReadSettingsLock to read the object. More...
class	DtWriteSettingsLock< DtSharedDisplayUnitsSettings >
	Use the DtWriteSettingsLock to write to the object. More...

Detailed Description

This class will maintain information about the units, display units, and coordinate systems used in VR-Vantage.

Definitions:

• Unit: A unit of measurement for a display unit type. Ex: Meters, Minutes
• Display Unit: A collection of attributes that describe how to display information in a given context.

Example 'Display Unit' use cases this class addresses are:

• How should I display the velocity of a fixed-wing aircraft?
• How should I display visibility information as it relates to weather conditions, e.g. fog?

The class defaults are defined in DtSharedDisplayUnitsSettings::initEntries.

This class maintains information about the following units of measurements for distance:

• Meters - Feet - Nautical Miles
• Kilometers - Miles - Fathoms
• Inches - Millimeters

This class maintains information about the following units of measurements for velocity:

• Meters/Second - Kilometers/Hour - Miles/Hour
• Meters/Hour - Feet/Hour - Knots
• Millimeters/Hour - Inches/Hour

This class maintains information about the following units of measurements for acceleration:

• Meters/Second^2 - Feet/Second^2 - Miles/Second^2
• Kilometers/Second^2 - Nautical Miles/Second^2

This class maintains information about the following units of measurements for orientation:

• Degrees - Radians

This class maintains information about the following units of measurements for rotational velocity:

• Radians/Second - Radians/Minute - Radians/Hour
• Degrees/Second - Degrees/Minute - Degrees/Hour

This class maintains information about the following units of measurements for pressure:

• Pascals - Inches of Mercury - Millibars
• Kilopascals - Atmospheres

This class maintains information about the following units of measurements for temperature:

• Kelvin - Celsius - Fahrenheit

This class maintains multiple collections of display units by name. This class defines the following collections by default:

• Application
• Weather
• Default
• Fixed Wing
• Rotary Wing
• Life Form
• Ground
• Surface
• Subsurface
• Space A collection of display units can have display units exclusive to that collection.

By default, the 'Application' display units are defined as:

• Coordinate System
• Coordinate System (Sensor View)
• Distance
• Distance (Small)
• Rotational Velocity
• Acceleration
• Orientation
• Heading

By default, the 'Weather' display units are defined as:

• Distance
• Altitude
• Visibility
• Pressure
• Temperature
• Precipitation Depth
• Precipitation Rate
• Wind Speed
• Direction

By default, the 'Default', 'Fixed Wing', 'Rotary Wing', 'Surface', 'Subsurface', and 'Space' display units are defined as:

• Distance
• Altitude
• Speed

This class maintains information about the following coordinate systems:

• Database - Geodetic Deg/Min/Sec - Geodetic Decimal
• Geocentric - UTM - MGRS
• Geodetic Deg/Dec/Min

This class maintains information about the following heading types:

• True North - Magnetic North That is, a heading can be relative to either Earth's True North position or Magnetic North position.

This class provides methods that allows users to access unit of measurement information. For example, to get information about all the units of measurements for Distance: Units foundUnits; getUnitAttributes(DtUnitConverterCollection::Distance, foundUnits);

This class considers each coordinate system as a 'unit of measurement' for the 'Coordinate System' display unit type. Thus getting information about all supported coordinate systems is the same as getting information about another display unit type. For example, for coordinate systems: Units foundAttributes; getUnitAttributes(DtUnitConverterCollection::CoordinateSystem, foundAttributes);

This class provides methods that allows users to access display unit information by name. For example, to get display unit information for Visibility, in the context of Weather, users of this class would do the following: DisplayAttributes desiredDisplayUnitAttributes; getDisplayUnitAttributes(theWeatherDisplayUnitCollectionName, theVisibilityDisplayUnitName, desiredDisplayUnitAttributes); or by doing the following: DisplayAttributes* desiredDisplayUnitAttributes; desiredDisplayUnitAttributes = findDisplayUnitAttributes( theWeatherDisplayUnitCollectionName, theVisibilityDisplayUnitName);

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 makArchives::DtDisplayUnitsSettingsRecord::TemperatureUnits makVrv::DtSharedDisplayUnitsSettings::TemperatureUnits

typedef makArchives::DtDisplayUnitsSettingsRecord::PressureUnits makVrv::DtSharedDisplayUnitsSettings::PressureUnits

typedef makArchives::DtDisplayUnitsSettingsRecord::NorthUnits makVrv::DtSharedDisplayUnitsSettings::NorthUnits

typedef makArchives::DtDisplayUnitsSettingsRecord::DisplayUnitAttributes makVrv::DtSharedDisplayUnitsSettings::DisplayAttributes

typedef std::vector<UnitEntry> makVrv::DtSharedDisplayUnitsSettings::Units

A vector of unit names and unit notations.

typedef std::unordered_map<makArchives::DtDisplayUnitsSettingsRecord::DisplayUnitType, Units> makVrv::DtSharedDisplayUnitsSettings::UnitMap

A mapping of display unit types to the unit of measurements that can measure that display unit type.

For example, for the 'Distance' display unit type, we can use units of measurements like Meters, Feet, etc. You could not use Minutes...

typedef std::map<std::string, DisplayAttributes> makVrv::DtSharedDisplayUnitsSettings::DisplayUnitMap

A mapping of a display unit's name to the attributes for that display unit.

typedef std::unordered_map<std::string, DisplayUnitMap> makVrv::DtSharedDisplayUnitsSettings::DisplayUnitCollectionMap

A mapping of a display unit collection's name to the collection of display units.

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::setUnitAttributes	(	makArchives::DtDisplayUnitsSettingsRecord::DisplayUnitType	displayUnitType,
		const Units &	data
	)

Define a new unit of measurement for a display unit type For example, some units of measurements for Distance are:

• Meters
• Kilometers
• Feet
• Miles
• Nautical Miles
• etc..

bool makVrv::DtSharedDisplayUnitsSettings::getUnitAttributes	(	makArchives::DtDisplayUnitsSettingsRecord::DisplayUnitType	displayUnitType,
		Units &	value
	)		const

Get all the units of measurement for a given display unit type.

Parameters

DisplayUnitType	displayUnitType The type of display unit to get units of measurement for
Units&	value Argument in which the data is returned

Returns

True if the data was successfully retrieved. False otherwise

const DisplayUnitCollectionMap& makVrv::DtSharedDisplayUnitsSettings::displayUnitCollectionMap

(

)

const

Get a const reference to the internal display unit collection map.

DisplayUnitCollectionMap& makVrv::DtSharedDisplayUnitsSettings::displayUnitCollectionMap

(

)

Get a reference to the internal display unit collection map.

void makVrv::DtSharedDisplayUnitsSettings::setDisplayUnitAttributes	(	const DtUnicode &	displayUnitCollectionName,
		const DtUnicode &	displayUnitName,
		const DisplayAttributes &	data
	)

Set the attributes for a given 'display unit'.

Parameters

const	DtUnicode& displayUnitCollectionName The name of the collection the 'display unit' is a part of
const	DtUnicode& displayUnitName The name of the 'display unit'
DisplayAttributes&	data Argument in which the data is passed in

bool makVrv::DtSharedDisplayUnitsSettings::getDisplayUnitAttributes	(	const DtUnicode &	displayUnitCollectionName,
		const DtUnicode &	displayUnitName,
		DisplayAttributes &	value
	)		const

Get the attributes for a given 'display unit'.

Parameters

const	DtUnicode& displayUnitCollectionName The name of the collection the 'display unit' is a part of
const	DtUnicode& displayUnitName The name of the 'display unit'
DisplayAttributes&	value Argument in which the data is pass in

Returns

True if the data was successfully retrieved. False otherwise.

DisplayAttributes* makVrv::DtSharedDisplayUnitsSettings::findDisplayUnitAttributes	(	const DtUnicode &	displayUnitCollectionName,
		const DtUnicode &	displayUnitName
	)

Find the attributes for a given 'display unit'.

Parameters

const	DtUnicode& displayUnitCollectionName The name of the collection the 'display unit' is a part of
const	DtUnicode& displayUnitName The name of the 'display unit'

Returns

A pointer to the display attributes. Can return NULL.

const DisplayAttributes* makVrv::DtSharedDisplayUnitsSettings::findDisplayUnitAttributes	(	const DtUnicode &	displayUnitCollectionName,
		const DtUnicode &	displayUnitName
	)		const

Find the attributes for a given 'display unit' - const version.

Parameters

const	DtUnicode& displayUnitCollectionName The name of the collection the 'display unit' is a part of
const	DtUnicode& displayUnitName The name of the 'display unit'

Returns

A const pointer to the display attributes. Can return NULL.

void makVrv::DtSharedDisplayUnitsSettings::setSuppressMagneticNorthNotationEnabled

(

bool

isEnabled

)

Set whether or not to suppress the Heading Notation when using Magnetic North.

Parameters

isEnabled

Whether or not to suppress Magnetic North Heading Notation The default value is false.

bool makVrv::DtSharedDisplayUnitsSettings::isSuppressMagneticNorthNotationEnabled

(

)

const

Get whether or not to suppress the Heading Notation when using Magnetic North.

Returns

Whether or not to suppress Magnetic North Heading Notation

void makVrv::DtSharedDisplayUnitsSettings::setCoordinateSystem

(

CoordSys

cs

)

Set the Coordinate System display unit in the 'Application' collection Akin to calling: setDisplayUnitUnit(theApplicationDisplayUnitCollectionName, theCoordinateSystemDisplayUnitName, cs)

void makVrv::DtSharedDisplayUnitsSettings::setDisplayUnitUnit	(	const DtUnicode &	displayUnitCollectionName,
		const DtUnicode &	displayUnitName,
		unsigned int	unitEnumerationValue
	)

Update the unit of measurement used for a given 'display unit'.

Parameters

const	DtUnicode& displayUnitCollectionName The name of the collection the 'display unit' is a part of
const	DtUnicode& displayUnitName The name of the 'display unit'
unsigned	int unitEnumerationValue The enumeration value of the specific unit of measurement Emits the DtDisplayUnitsSettingsSignaler::signal_displayUnitChanged(...) signal

See Also

DtDisplayUnitsSettingsRecord::DistanceUnits

DtDisplayUnitsSettingsRecord::VelocityUnits

DtDisplayUnitsSettingsRecord::AccelerationUnits

DtDisplayUnitsSettingsRecord::OrientationUnits

DtDisplayUnitsSettingsRecord::RotVelocityUnits

void makVrv::DtSharedDisplayUnitsSettings::setDisplayUnitDecimals	(	const DtUnicode &	displayUnitCollectionName,
		const DtUnicode &	displayUnitName,
		unsigned int	decimals
	)

Update the number of decimals used for a given 'display unit'.

Parameters

const	DtUnicode& displayUnitCollectionName The name of the collection the 'display unit' is a part of
const	DtUnicode& displayUnitName The name of the 'display unit'
unsigned	int decimals The number of decimals to use

unsigned int makVrv::DtSharedDisplayUnitsSettings::displayUnitUnit	(	const DtUnicode &	displayUnitCollectionName,
		const DtUnicode &	displayUnitName
	)		const

Returns the enumeration value of the specific unit of measurement to use for a display unit.

Parameters

const	DtUnicode& displayUnitCollectionName The name of the collection the 'display unit' is a part of
const	DtUnicode& displayUnitName The name of the 'display unit'

Returns

An enumerated value corresponding to a unit of measurement

See Also

DtDisplayUnitsSettingsRecord::DistanceUnits

DtDisplayUnitsSettingsRecord::VelocityUnits

DtDisplayUnitsSettingsRecord::AccelerationUnits

DtDisplayUnitsSettingsRecord::OrientationUnits

DtDisplayUnitsSettingsRecord::RotVelocityUnits

unsigned int makVrv::DtSharedDisplayUnitsSettings::displayUnitDecimals	(	const DtUnicode &	displayUnitCollectionName,
		const DtUnicode &	displayUnitName
	)		const

Returns the number of decimal places to use for a display unit.

Parameters

displayUnitCollectionName	The name of the collection the display unit is in
displayUnitName	The name of the display unit of interest The function will return 0 if a display unit collection OR display unit with the provided names cannot be found.

DtUnicode makVrv::DtSharedDisplayUnitsSettings::displayUnitNotation	(	const DtUnicode &	displayUnitCollectionName,
		const DtUnicode &	displayUnitName
	)		const

Returns the notation to use for a display unit.

Parameters

displayUnitCollectionName	The name of the collection the display unit is in
displayUnitName	The name of the display unit of interest The function will return an empty DtUnicode if a display unit collection OR display unit with the provided names cannot be found.

DtUnicode makVrv::DtSharedDisplayUnitsSettings::coordinateSystemNotation

(

CoordSys

cs

)

const

DtUnicode makVrv::DtSharedDisplayUnitsSettings::distanceUnitNotation

(

DistanceUnits

distUnit

)

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

DtUnicode makVrv::DtSharedDisplayUnitsSettings::temperatureUnitNotation

(

TemperatureUnits

tempUnit

)

const

DtUnicode makVrv::DtSharedDisplayUnitsSettings::pressureUnitNotation

(

PressureUnits

pressureUnit

)

const

DtUnicode makVrv::DtSharedDisplayUnitsSettings::northUnitNotation

(

NorthUnits

northUnit

)

const

CoordSys makVrv::DtSharedDisplayUnitsSettings::currentCoordinateSystem

(

)

const

int makVrv::DtSharedDisplayUnitsSettings::currentCoordinateSystemDecimals

(

)

const

DtUnicode makVrv::DtSharedDisplayUnitsSettings::currentCoordinateSystemNotation

(

)

const

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

Retrieve the X/Y/Z axis labels for the provided display coordinate system, by reference.

For example, return 'Lat' for the X axis, 'Lon' for the Y axis, and 'Alt' for the Z axis for geodetic coordinate systems (like DMS and DDM).

Parameters

displayCS	The coordinate system we want axis labels for
x	The DtUnicode reference to store the X axis label in
y	The DtUnicode reference to store the Y axis label in
z	The DtUnicode reference to store the Z axis label in

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

Retrieve the X/Y/Z axis labels for the provided display coordinate system, by reference.

For example, return 'Lat' for the X axis, 'Lon' for the Y axis, and 'Alt' for the Z axis for geodetic coordinate systems (like DMS and DDM).

Parameters

displayCS	The coordinate system we want axis labels for
coordSys	The enumeration value for the 'current' coordinate system
x	The DtUnicode reference to store the X axis label in
y	The DtUnicode reference to store the Y axis label in
z	The DtUnicode reference to store the Z axis label in

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<DtUnicode> makVrv::DtSharedDisplayUnitsSettings::convertPositionToNotatedStringList	(	const DtCoordinateSystem &	displayCS,
		CoordSys	coordSys,
		const DtVector &	pos,
		DistanceUnits	coordinateSystemUnit,
		unsigned int	coordinateSystemDecimals,
		DistanceUnits	altitudeUnit,
		unsigned int	altitudeDecimals
	)		const

Convert the geocentric position to a vector of notated strings.

Parameters

displayCS	The coordinate system to convert the position to.
coordSys	The coordinate system to convert the position from.
pos	The position to get the display string for.

std::vector<DtUnicode> makVrv::DtSharedDisplayUnitsSettings::convertPositionToNotatedStringList	(	const DtCoordinateSystem &	displayCS,
		const DtVector &	pos,
		DistanceUnits	coordinateSystemUnit,
		unsigned int	coordinateSystemDecimals,
		DistanceUnits	altitudeUnit,
		unsigned int	altitudeDecimals
	)		const

Convert the geocentric position to a vector of notated strings.

Parameters

displayCS	The coordinate system to convert the position to.
pos	The position to get the display string for.

std::vector<std::string> makVrv::DtSharedDisplayUnitsSettings::convertPositionToStringList	(	const DtCoordinateSystem &	displayCS,
		CoordSys	coordSys,
		const DtVector &	pos,
		DistanceUnits	coordinateSystemUnit,
		unsigned int	coordinateSystemDecimals,
		DistanceUnits	altitudeUnit,
		unsigned int	altitudeDecimals
	)		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,
		DistanceUnits	coordinateSystemUnit,
		unsigned int	coordinateSystemDecimals,
		DistanceUnits	altitudeUnit,
		unsigned int	altitudeDecimals
	)		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.

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

protected

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

staticprotected

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 DisplayAttributes

friend

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

const DtUnicode makVrv::DtSharedDisplayUnitsSettings::theApplicationDisplayUnitCollectionName

static

The DtUnicode names used for the display unit collections.

const DtUnicode makVrv::DtSharedDisplayUnitsSettings::theWeatherDisplayUnitCollectionName

static

const DtUnicode makVrv::DtSharedDisplayUnitsSettings::theDefaultDisplayUnitCollectionName

static

const DtUnicode makVrv::DtSharedDisplayUnitsSettings::theFixedWingDisplayUnitCollectionName

static

const DtUnicode makVrv::DtSharedDisplayUnitsSettings::theRotaryWingDisplayUnitCollectionName

static

const DtUnicode makVrv::DtSharedDisplayUnitsSettings::theLifeFormDisplayUnitCollectionName

static

const DtUnicode makVrv::DtSharedDisplayUnitsSettings::theGroundDisplayUnitCollectionName

static

const DtUnicode makVrv::DtSharedDisplayUnitsSettings::theSurfaceDisplayUnitCollectionName

static

const DtUnicode makVrv::DtSharedDisplayUnitsSettings::theSubsurfaceDisplayUnitCollectionName

static

const DtUnicode makVrv::DtSharedDisplayUnitsSettings::theSpaceDisplayUnitCollectionName

static

const DtUnicode makVrv::DtSharedDisplayUnitsSettings::theSmallDistanceDisplayUnitName

static

The DtUnicode names used for the display units.

const DtUnicode makVrv::DtSharedDisplayUnitsSettings::theDistanceDisplayUnitName

static

const DtUnicode makVrv::DtSharedDisplayUnitsSettings::theAltitudeDisplayUnitName

static

const DtUnicode makVrv::DtSharedDisplayUnitsSettings::theSpeedDisplayUnitName

static

const DtUnicode makVrv::DtSharedDisplayUnitsSettings::theRotationalVelocityDisplayUnitName

static

const DtUnicode makVrv::DtSharedDisplayUnitsSettings::theAccelerationDisplayUnitName

static

const DtUnicode makVrv::DtSharedDisplayUnitsSettings::theOrientationDisplayUnitName

static

const DtUnicode makVrv::DtSharedDisplayUnitsSettings::theHeadingDisplayUnitName

static

const DtUnicode makVrv::DtSharedDisplayUnitsSettings::theCoordinateSystemDisplayUnitName

static

const DtUnicode makVrv::DtSharedDisplayUnitsSettings::theSensorViewCoordinateSystemDisplayUnitName

static

const DtUnicode makVrv::DtSharedDisplayUnitsSettings::theVisibilityDisplayUnitName

static

const DtUnicode makVrv::DtSharedDisplayUnitsSettings::thePressureDisplayUnitName

static

const DtUnicode makVrv::DtSharedDisplayUnitsSettings::theTemperatureDisplayUnitName

static

const DtUnicode makVrv::DtSharedDisplayUnitsSettings::thePrecipitationDepthDisplayUnitName

static

const DtUnicode makVrv::DtSharedDisplayUnitsSettings::thePrecipitationRateDisplayUnitName

static

const DtUnicode makVrv::DtSharedDisplayUnitsSettings::theWindSpeedDisplayUnitName

static

const DtUnicode makVrv::DtSharedDisplayUnitsSettings::theDirectionDisplayUnitName

static

UnitMap makVrv::DtSharedDisplayUnitsSettings::myUnits

protected

DisplayUnitCollectionMap makVrv::DtSharedDisplayUnitsSettings::myDisplayUnits

protected

bool makVrv::DtSharedDisplayUnitsSettings::mySurpressMagneticNorthNotationEnabled

protected

DtDisplayUnitsSettingsBackup* makVrv::DtSharedDisplayUnitsSettings::mySettingsBackup

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvCore/DtSharedDisplayUnitsSettings.h