NDEVR
API Documentation

Provides static accessors for common and uncommon unit definitions used by the software. More...

Static Public Member Functions

static const ConstPointer< Unit > & Acres ()
 Gets the unit definition for acres.
static ConstPointer< UnitAppendInclinationOrientation (const Unit &orientation_unit, const Angle< fltp08 > &horizontal_angle, bool upwards)
 Appends an inclination (vertical tilt) to an existing orientation unit.
static const ConstPointer< Unit > & Ares ()
 Gets the unit definition for ares (100 square meters).
static const ConstPointer< Unit > & Celsius ()
 Gets the unit definition for degrees Celsius.
static const ConstPointer< Unit > & Centimeters ()
 Gets the unit definition for centimeters.
static const ConstPointer< Unit > & CubicFeet ()
 Gets the unit definition for cubic feet.
static const ConstPointer< Unit > & CubicInches ()
 Gets the unit definition for cubic inches.
static const ConstPointer< Unit > & CubicMeters ()
 Gets the unit definition for cubic meters.
static const ConstPointer< Unit > & CubicYards ()
 Gets the unit definition for cubic yards.
static const ConstPointer< Unit > & DDDMMSS ()
 Gets the unit definition for the DDD.MMSS packed angle format.
static const ConstPointer< Unit > & Degrees ()
 Angle Units.
static const ConstPointer< Unit > & DegreesMinutes ()
 Gets the unit definition for degrees and minutes as a combined display format.
static const ConstPointer< Unit > & DegreesMinutesSeconds ()
 Gets the unit definition for degrees, minutes, and seconds as a combined display format.
static const ConstPointer< Unit > & DotsPerInch ()
 Gets the unit definition for dots per inch (DPI).
static ConstPointer< UnitEastingElevationNorthing (const Unit &length_unit)
 Creates a 3D coordinate unit with Easting, Elevation, Northing axis ordering.
static ConstPointer< UnitEastingNorthingElevation (const Unit &length_unit)
 Creates a 3D coordinate unit with Easting, Northing, Elevation axis ordering.
static ConstPointer< UnitEastOrientation (const Unit &length_unit, bool clockwise)
 Creates an orientation unit referenced to east.
static const ConstPointer< Unit > & Fahrenheit ()
 Gets the unit definition for degrees Fahrenheit.
static const ConstPointer< Unit > & Feet ()
 Gets the unit definition for feet.
static const ConstPointer< Unit > & FeetInches ()
 Gets the unit definition for feet and inches as a combined display format.
static const ConstPointer< Unit > & FeetPerSecond ()
 Gets the unit definition for feet per second.
static const ConstPointer< Unit > & Gradians ()
 Gets the unit definition for gradians (gon, 400 per full circle).
static const ConstPointer< Unit > & Grams ()
 Gets the unit definition for grams.
static const ConstPointer< Unit > & Hectares ()
 Gets the unit definition for hectares (10,000 square meters).
static const ConstPointer< Unit > & Hertz ()
 Gets the unit definition for hertz.
static const ConstPointer< Unit > & Hours ()
 Gets the unit definition for hours.
static const ConstPointer< Unit > & Inches ()
 Gets the unit definition for inches.
static const ConstPointer< Unit > & Kelvin ()
 Gets the unit definition for Kelvin.
static const ConstPointer< Unit > & Kilograms ()
 Gets the unit definition for kilograms.
static const ConstPointer< Unit > & Kilometers ()
 Gets the unit definition for kilometers.
static const ConstPointer< Unit > & KilometersPerHour ()
 Gets the unit definition for kilometers per hour.
static ConstPointer< UnitLatLonAlt (const Unit &angle_unit)
 Creates a geographic coordinate unit with Latitude, Longitude, Altitude axis ordering.
static const ConstPointer< Unit > & MegaHertz ()
 Gets the unit definition for megahertz.
static const ConstPointer< Unit > & Meters ()
 Gets the unit definition for meters.
static const ConstPointer< Unit > & MetersPerSecond ()
 Gets the unit definition for meters per second.
static const ConstPointer< Unit > & Micron ()
 Gets the unit definition for microns (micrometers).
static const ConstPointer< Unit > & MilesPerHour ()
 Gets the unit definition for miles per hour.
static const ConstPointer< Unit > & Millimeters ()
 Gets the unit definition for millimeters.
static const ConstPointer< Unit > & Milliseconds ()
 Gets the unit definition for milliseconds.
static const ConstPointer< Unit > & Millivolts ()
 Gets the unit definition for millivolts.
static const ConstPointer< Unit > & Minutes ()
 Gets the unit definition for minutes.
static const ConstPointer< Unit > & MinutesSeconds ()
 Gets the unit definition for minutes and seconds as a combined display format.
static ConstPointer< UnitNorthingEastingElevation (const Unit &length_unit)
 Creates a 3D coordinate unit with Northing, Easting, Elevation axis ordering.
static ConstPointer< UnitNorthingElevationEasting (const Unit &length_unit)
 Creates a 3D coordinate unit with Northing, Elevation, Easting axis ordering.
static ConstPointer< UnitNorthOrientation (const Unit &length_unit, bool clockwise)
 Creates an orientation unit referenced to north.
static const ConstPointer< Unit > & Percent ()
 Gets the unit definition for percent values.
static const ConstPointer< Unit > & Pixels ()
 Gets the unit definition for pixels.
static const ConstPointer< Unit > & Pounds ()
 Gets the unit definition for pounds.
static const ConstPointer< Unit > & Radians ()
 Gets the unit definition for radians.
static const ConstPointer< Unit > & RotationsPerMinute ()
 Gets the unit definition for rotations per minute (RPM).
static const ConstPointer< Unit > & Seconds ()
 Gets the unit definition for seconds.
static ConstPointer< UnitSouthOrientation (const Unit &length_unit, bool clockwise)
 Creates an orientation unit referenced to south.
static const ConstPointer< Unit > & SqrFeet ()
 Gets the unit definition for square feet.
static const ConstPointer< Unit > & SqrInches ()
 Gets the unit definition for square inches.
static const ConstPointer< Unit > & SqrKilometers ()
 Gets the unit definition for square kilometers.
static const ConstPointer< Unit > & SqrMeters ()
 Gets the unit definition for square meters.
static const ConstPointer< Unit > & SqrYards ()
 Gets the unit definition for square yards.
static const ConstPointer< Unit > & SurfaceNormalPercent ()
 Gets the unit definition for surface normal percent (slope as rise/run percentage).
static const ConstPointer< Unit > & Volts ()
 Gets the unit definition for volts.
static ConstPointer< UnitWestingElevationSouthing (const Unit &length_unit)
 Creates a 3D coordinate unit with Westing, Elevation, Southing axis ordering.
static ConstPointer< UnitWestingSouthingElevation (const Unit &length_unit)
 Creates a 3D coordinate unit with Westing, Southing, Elevation axis ordering.
static ConstPointer< UnitWestOrientation (const Unit &length_unit, bool clockwise)
 Creates an orientation unit referenced to west.
static ConstPointer< UnitXYZ (const Unit &length_unit)
 Creates a 3D coordinate unit with X, Y, Z axis ordering.
static const ConstPointer< Unit > & Yards ()
 Gets the unit definition for yards.
static ConstPointer< UnitYXZ (const Unit &length_unit)
 Creates a 3D coordinate unit with Y, X, Z axis ordering.

Detailed Description

Provides static accessors for common and uncommon unit definitions used by the software.


Definition at line 11 of file UnitDefinitions.h.

Member Function Documentation

◆ Acres()

const ConstPointer< Unit > & UnitDefinitions::Acres ( )
static

Gets the unit definition for acres.

Returns
A const reference to the acres Unit.

◆ AppendInclinationOrientation()

ConstPointer< Unit > UnitDefinitions::AppendInclinationOrientation ( const Unit & orientation_unit,
const Angle< fltp08 > & horizontal_angle,
bool upwards )
static

Appends an inclination (vertical tilt) to an existing orientation unit.

Parameters
[in]orientation_unitThe base orientation unit to extend.
[in]horizontal_angleThe reference horizontal angle for the inclination.
[in]upwardsWhether the inclination measures upward from the horizontal plane.
Returns
A new Unit combining the orientation with inclination information.

◆ Ares()

const ConstPointer< Unit > & UnitDefinitions::Ares ( )
static

Gets the unit definition for ares (100 square meters).

Returns
A const reference to the ares Unit.

◆ Celsius()

const ConstPointer< Unit > & UnitDefinitions::Celsius ( )
static

Gets the unit definition for degrees Celsius.

Returns
A const reference to the Celsius Unit.

◆ Centimeters()

const ConstPointer< Unit > & UnitDefinitions::Centimeters ( )
static

Gets the unit definition for centimeters.

Returns
A const reference to the centimeters Unit.

Referenced by ConvertFromCADUnit().

◆ CubicFeet()

const ConstPointer< Unit > & UnitDefinitions::CubicFeet ( )
static

Gets the unit definition for cubic feet.

Returns
A const reference to the cubic feet Unit.

◆ CubicInches()

const ConstPointer< Unit > & UnitDefinitions::CubicInches ( )
static

Gets the unit definition for cubic inches.

Returns
A const reference to the cubic inches Unit.

◆ CubicMeters()

const ConstPointer< Unit > & UnitDefinitions::CubicMeters ( )
static

Gets the unit definition for cubic meters.

Returns
A const reference to the cubic meters Unit.

◆ CubicYards()

const ConstPointer< Unit > & UnitDefinitions::CubicYards ( )
static

Gets the unit definition for cubic yards.

Returns
A const reference to the cubic yards Unit.

◆ DDDMMSS()

const ConstPointer< Unit > & UnitDefinitions::DDDMMSS ( )
static

Gets the unit definition for the DDD.MMSS packed angle format.

Returns
A const reference to the DDDMMSS Unit.

◆ Degrees()

const ConstPointer< Unit > & UnitDefinitions::Degrees ( )
static

Angle Units.

Gets the unit definition for degrees.

Returns
A const reference to the degrees Unit.

◆ DegreesMinutes()

const ConstPointer< Unit > & UnitDefinitions::DegreesMinutes ( )
static

Gets the unit definition for degrees and minutes as a combined display format.

Returns
A const reference to the degrees-minutes Unit.

◆ DegreesMinutesSeconds()

const ConstPointer< Unit > & UnitDefinitions::DegreesMinutesSeconds ( )
static

Gets the unit definition for degrees, minutes, and seconds as a combined display format.

Returns
A const reference to the degrees-minutes-seconds Unit.

◆ DotsPerInch()

const ConstPointer< Unit > & UnitDefinitions::DotsPerInch ( )
static

Gets the unit definition for dots per inch (DPI).

Returns
A const reference to the DPI Unit.

◆ EastingElevationNorthing()

ConstPointer< Unit > UnitDefinitions::EastingElevationNorthing ( const Unit & length_unit)
static

Creates a 3D coordinate unit with Easting, Elevation, Northing axis ordering.

Parameters
[in]length_unitThe length unit to use for all three axes.
Returns
A coordinate Unit with EEN ordering using the given length unit.

◆ EastingNorthingElevation()

ConstPointer< Unit > UnitDefinitions::EastingNorthingElevation ( const Unit & length_unit)
static

Creates a 3D coordinate unit with Easting, Northing, Elevation axis ordering.

Parameters
[in]length_unitThe length unit to use for all three axes.
Returns
A coordinate Unit with ENE ordering using the given length unit.

◆ EastOrientation()

ConstPointer< Unit > UnitDefinitions::EastOrientation ( const Unit & length_unit,
bool clockwise )
static

Creates an orientation unit referenced to east.

Parameters
[in]length_unitThe length unit for the coordinate system.
[in]clockwiseWhether angles increase in the clockwise direction.
Returns
A coordinate Unit with east-referenced orientation.

◆ Fahrenheit()

const ConstPointer< Unit > & UnitDefinitions::Fahrenheit ( )
static

Gets the unit definition for degrees Fahrenheit.

Returns
A const reference to the Fahrenheit Unit.

◆ Feet()

const ConstPointer< Unit > & UnitDefinitions::Feet ( )
static

Gets the unit definition for feet.

Returns
A const reference to the feet Unit.

Referenced by ConvertFromCADUnit().

◆ FeetInches()

const ConstPointer< Unit > & UnitDefinitions::FeetInches ( )
static

Gets the unit definition for feet and inches as a combined display format.

Returns
A const reference to the feet-inches Unit.

◆ FeetPerSecond()

const ConstPointer< Unit > & UnitDefinitions::FeetPerSecond ( )
static

Gets the unit definition for feet per second.

Returns
A const reference to the feet per second Unit.

◆ Gradians()

const ConstPointer< Unit > & UnitDefinitions::Gradians ( )
static

Gets the unit definition for gradians (gon, 400 per full circle).

Returns
A const reference to the gradians Unit.

◆ Grams()

const ConstPointer< Unit > & UnitDefinitions::Grams ( )
static

Gets the unit definition for grams.

Returns
A const reference to the grams Unit.

◆ Hectares()

const ConstPointer< Unit > & UnitDefinitions::Hectares ( )
static

Gets the unit definition for hectares (10,000 square meters).

Returns
A const reference to the hectares Unit.

◆ Hertz()

const ConstPointer< Unit > & UnitDefinitions::Hertz ( )
static

Gets the unit definition for hertz.

Returns
A const reference to the hertz Unit.

◆ Hours()

const ConstPointer< Unit > & UnitDefinitions::Hours ( )
static

Gets the unit definition for hours.

Returns
A const reference to the hours Unit.

◆ Inches()

const ConstPointer< Unit > & UnitDefinitions::Inches ( )
static

Gets the unit definition for inches.

Returns
A const reference to the inches Unit.

Referenced by ConvertFromCADUnit().

◆ Kelvin()

const ConstPointer< Unit > & UnitDefinitions::Kelvin ( )
static

Gets the unit definition for Kelvin.

Returns
A const reference to the Kelvin Unit.

◆ Kilograms()

const ConstPointer< Unit > & UnitDefinitions::Kilograms ( )
static

Gets the unit definition for kilograms.

Returns
A const reference to the kilograms Unit.

◆ Kilometers()

const ConstPointer< Unit > & UnitDefinitions::Kilometers ( )
static

Gets the unit definition for kilometers.

Returns
A const reference to the kilometers Unit.

Referenced by ConvertFromCADUnit().

◆ KilometersPerHour()

const ConstPointer< Unit > & UnitDefinitions::KilometersPerHour ( )
static

Gets the unit definition for kilometers per hour.

Returns
A const reference to the kilometers per hour Unit.

◆ LatLonAlt()

ConstPointer< Unit > UnitDefinitions::LatLonAlt ( const Unit & angle_unit)
static

Creates a geographic coordinate unit with Latitude, Longitude, Altitude axis ordering.

Parameters
[in]angle_unitThe angle unit to use for latitude and longitude.
Returns
A coordinate Unit with lat/lon/alt ordering using the given angle unit.

◆ MegaHertz()

const ConstPointer< Unit > & UnitDefinitions::MegaHertz ( )
static

Gets the unit definition for megahertz.

Returns
A const reference to the megahertz Unit.

◆ Meters()

const ConstPointer< Unit > & UnitDefinitions::Meters ( )
static

Gets the unit definition for meters.

Returns
A const reference to the meters Unit.

Referenced by ConvertFromCADUnit().

◆ MetersPerSecond()

const ConstPointer< Unit > & UnitDefinitions::MetersPerSecond ( )
static

Gets the unit definition for meters per second.

Returns
A const reference to the meters per second Unit.

◆ Micron()

const ConstPointer< Unit > & UnitDefinitions::Micron ( )
static

Gets the unit definition for microns (micrometers).

Returns
A const reference to the micron Unit.

◆ MilesPerHour()

const ConstPointer< Unit > & UnitDefinitions::MilesPerHour ( )
static

Gets the unit definition for miles per hour.

Returns
A const reference to the miles per hour Unit.

◆ Millimeters()

const ConstPointer< Unit > & UnitDefinitions::Millimeters ( )
static

Gets the unit definition for millimeters.

Returns
A const reference to the millimeters Unit.

Referenced by ConvertFromCADUnit().

◆ Milliseconds()

const ConstPointer< Unit > & UnitDefinitions::Milliseconds ( )
static

Gets the unit definition for milliseconds.

Returns
A const reference to the milliseconds Unit.

◆ Millivolts()

const ConstPointer< Unit > & UnitDefinitions::Millivolts ( )
static

Gets the unit definition for millivolts.

Returns
A const reference to the millivolts Unit.

◆ Minutes()

const ConstPointer< Unit > & UnitDefinitions::Minutes ( )
static

Gets the unit definition for minutes.

Returns
A const reference to the minutes Unit.

◆ MinutesSeconds()

const ConstPointer< Unit > & UnitDefinitions::MinutesSeconds ( )
static

Gets the unit definition for minutes and seconds as a combined display format.

Returns
A const reference to the minutes-seconds Unit.

◆ NorthingEastingElevation()

ConstPointer< Unit > UnitDefinitions::NorthingEastingElevation ( const Unit & length_unit)
static

Creates a 3D coordinate unit with Northing, Easting, Elevation axis ordering.

Parameters
[in]length_unitThe length unit to use for all three axes.
Returns
A coordinate Unit with NEE ordering using the given length unit.

◆ NorthingElevationEasting()

ConstPointer< Unit > UnitDefinitions::NorthingElevationEasting ( const Unit & length_unit)
static

Creates a 3D coordinate unit with Northing, Elevation, Easting axis ordering.

Parameters
[in]length_unitThe length unit to use for all three axes.
Returns
A coordinate Unit with NEE ordering using the given length unit.

◆ NorthOrientation()

ConstPointer< Unit > UnitDefinitions::NorthOrientation ( const Unit & length_unit,
bool clockwise )
static

Creates an orientation unit referenced to north.

Parameters
[in]length_unitThe length unit for the coordinate system.
[in]clockwiseWhether angles increase in the clockwise direction.
Returns
A coordinate Unit with north-referenced orientation.

◆ Percent()

const ConstPointer< Unit > & UnitDefinitions::Percent ( )
static

Gets the unit definition for percent values.

Returns
A const reference to the percent Unit.

◆ Pixels()

const ConstPointer< Unit > & UnitDefinitions::Pixels ( )
static

Gets the unit definition for pixels.

Returns
A const reference to the pixels Unit.

◆ Pounds()

const ConstPointer< Unit > & UnitDefinitions::Pounds ( )
static

Gets the unit definition for pounds.

Returns
A const reference to the pounds Unit.

◆ Radians()

const ConstPointer< Unit > & UnitDefinitions::Radians ( )
static

Gets the unit definition for radians.

Returns
A const reference to the radians Unit.

◆ RotationsPerMinute()

const ConstPointer< Unit > & UnitDefinitions::RotationsPerMinute ( )
static

Gets the unit definition for rotations per minute (RPM).

Returns
A const reference to the RPM Unit.

◆ Seconds()

const ConstPointer< Unit > & UnitDefinitions::Seconds ( )
static

Gets the unit definition for seconds.

Returns
A const reference to the seconds Unit.

◆ SouthOrientation()

ConstPointer< Unit > UnitDefinitions::SouthOrientation ( const Unit & length_unit,
bool clockwise )
static

Creates an orientation unit referenced to south.

Parameters
[in]length_unitThe length unit for the coordinate system.
[in]clockwiseWhether angles increase in the clockwise direction.
Returns
A coordinate Unit with south-referenced orientation.

◆ SqrFeet()

const ConstPointer< Unit > & UnitDefinitions::SqrFeet ( )
static

Gets the unit definition for square feet.

Returns
A const reference to the square feet Unit.

◆ SqrInches()

const ConstPointer< Unit > & UnitDefinitions::SqrInches ( )
static

Gets the unit definition for square inches.

Returns
A const reference to the square inches Unit.

◆ SqrKilometers()

const ConstPointer< Unit > & UnitDefinitions::SqrKilometers ( )
static

Gets the unit definition for square kilometers.

Returns
A const reference to the square kilometers Unit.

◆ SqrMeters()

const ConstPointer< Unit > & UnitDefinitions::SqrMeters ( )
static

Gets the unit definition for square meters.

Returns
A const reference to the square meters Unit.

◆ SqrYards()

const ConstPointer< Unit > & UnitDefinitions::SqrYards ( )
static

Gets the unit definition for square yards.

Returns
A const reference to the square yards Unit.

◆ SurfaceNormalPercent()

const ConstPointer< Unit > & UnitDefinitions::SurfaceNormalPercent ( )
static

Gets the unit definition for surface normal percent (slope as rise/run percentage).

Returns
A const reference to the surface normal percent Unit.

◆ Volts()

const ConstPointer< Unit > & UnitDefinitions::Volts ( )
static

Gets the unit definition for volts.

Returns
A const reference to the volts Unit.

◆ WestingElevationSouthing()

ConstPointer< Unit > UnitDefinitions::WestingElevationSouthing ( const Unit & length_unit)
static

Creates a 3D coordinate unit with Westing, Elevation, Southing axis ordering.

Parameters
[in]length_unitThe length unit to use for all three axes.
Returns
A coordinate Unit with WES ordering using the given length unit.

◆ WestingSouthingElevation()

ConstPointer< Unit > UnitDefinitions::WestingSouthingElevation ( const Unit & length_unit)
static

Creates a 3D coordinate unit with Westing, Southing, Elevation axis ordering.

Parameters
[in]length_unitThe length unit to use for all three axes.
Returns
A coordinate Unit with WSE ordering using the given length unit.

◆ WestOrientation()

ConstPointer< Unit > UnitDefinitions::WestOrientation ( const Unit & length_unit,
bool clockwise )
static

Creates an orientation unit referenced to west.

Parameters
[in]length_unitThe length unit for the coordinate system.
[in]clockwiseWhether angles increase in the clockwise direction.
Returns
A coordinate Unit with west-referenced orientation.

◆ XYZ()

ConstPointer< Unit > UnitDefinitions::XYZ ( const Unit & length_unit)
static

Creates a 3D coordinate unit with X, Y, Z axis ordering.

Parameters
[in]length_unitThe length unit to use for all three axes.
Returns
A coordinate Unit with XYZ ordering using the given length unit.

◆ Yards()

const ConstPointer< Unit > & UnitDefinitions::Yards ( )
static

Gets the unit definition for yards.

Returns
A const reference to the yards Unit.

Referenced by ConvertFromCADUnit().

◆ YXZ()

ConstPointer< Unit > UnitDefinitions::YXZ ( const Unit & length_unit)
static

Creates a 3D coordinate unit with Y, X, Z axis ordering.

Parameters
[in]length_unitThe length unit to use for all three axes.
Returns
A coordinate Unit with YXZ ordering using the given length unit.

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