UOM Namespace Reference

Classes
class	CONVERTER
class	MEASURE
	Measure container. More...
class	SYSTEM
	System methods. More...
class	UNIT
	Single unit container. More...
Typedefs
typedef MILIST< MEASURE >	MEASURELIST
Enumerations
enum	FORMATSCALE { FORMATSCALE_Ratio = 0x00, FORMATSCALE_UnitFraction = 0x01, FORMATSCALE_AddNewline = 0x02, FORMATSCALE_AddSpacesAlways = 0x04 }
enum	IDNUM {   IDNUM_Unspecified = 0, IDNUM_Scale_Unity = (MEASURE::TYPE_Scale << 8) | UNIT_Scale_Unity, IDNUM_Scale_Percent = (MEASURE::TYPE_Scale << 8) | UNIT_Scale_Percent, IDNUM_Scale_PartsPerMillion = (MEASURE::TYPE_Scale << 8) | UNIT_Scale_PartsPerMillion,   IDNUM_Length_Kilometer = (MEASURE::TYPE_Length << 8) | UNIT_Length_Kilometer, IDNUM_Length_Decimeter = (MEASURE::TYPE_Length << 8) | UNIT_Length_Decimeter, IDNUM_Length_Meter = (MEASURE::TYPE_Length << 8) | UNIT_Length_Meter, IDNUM_Length_Centimeter = (MEASURE::TYPE_Length << 8) | UNIT_Length_Centimeter,   IDNUM_Length_Millimeter = (MEASURE::TYPE_Length << 8) | UNIT_Length_Millimeter, IDNUM_Length_Micrometer = (MEASURE::TYPE_Length << 8) | UNIT_Length_Micrometer, IDNUM_Length_Nanometer = (MEASURE::TYPE_Length << 8) | UNIT_Length_Nanometer, IDNUM_Length_Mile = (MEASURE::TYPE_Length << 8) | UNIT_Length_Mile,   IDNUM_Length_Foot = (MEASURE::TYPE_Length << 8) | UNIT_Length_Foot, IDNUM_Length_TenthFoot = (MEASURE::TYPE_Length << 8) | UNIT_Length_TenthFoot, IDNUM_Length_HundredthFoot = (MEASURE::TYPE_Length << 8) | UNIT_Length_HundredthFoot, IDNUM_Length_Inch = (MEASURE::TYPE_Length << 8) | UNIT_Length_Inch,   IDNUM_PlaneAngle_Degree = (MEASURE::TYPE_PlaneAngle << 8) | UNIT_PlaneAngle_Degree, IDNUM_PlaneAngle_Radian = (MEASURE::TYPE_PlaneAngle << 8) | UNIT_PlaneAngle_Radian, IDNUM_PlaneAngle_ArcMinute = (MEASURE::TYPE_PlaneAngle << 8) | UNIT_PlaneAngle_ArcMinute, IDNUM_PlaneAngle_ArcSecond = (MEASURE::TYPE_PlaneAngle << 8) | UNIT_PlaneAngle_ArcSecond,   IDNUM_Area_SquareMeter = (MEASURE::TYPE_Area << 8) | UNIT_Area_SquareMeter, IDNUM_Area_SquareKilometer = (MEASURE::TYPE_Area << 8) | UNIT_Area_SquareKilometer, IDNUM_Area_SquareMillimeter = (MEASURE::TYPE_Area << 8) | UNIT_Area_SquareMillimeter, IDNUM_Time_Second = (MEASURE::TYPE_Time << 8) | UNIT_Time_Second,   IDNUM_Time_Millisecond = (MEASURE::TYPE_Time << 8) | UNIT_Time_Millisecond, IDNUM_Time_Microsecond = (MEASURE::TYPE_Time << 8) | UNIT_Time_Microsecond, IDNUM_Velocity_MetersPerSecond = (MEASURE::TYPE_Velocity << 8) | UNIT_Velocity_MetersPerSecond, IDNUM_Velocity_FeetPerSecond = (MEASURE::TYPE_Velocity << 8) | UNIT_Velocity_FeetPerSecond,   IDNUM_Velocity_KilometersPerHour = (MEASURE::TYPE_Velocity << 8) | UNIT_Velocity_KilometersPerHour, IDNUM_Velocity_MilesPerHour = (MEASURE::TYPE_Velocity << 8) | UNIT_Velocity_MilesPerHour, IDNUM_Velocity_Knots = (MEASURE::TYPE_Velocity << 8) | UNIT_Velocity_Knots }
enum	SYSTEMID { SYSTEMID_Unspecified = 0, SYSTEMID_Metric = 1, SYSTEMID_English = 2 }
Functions
LIBEXPORT double	ConvertToScale (double ScaleDenominator, UOM::SYSTEMID UnitSystem, const UOM::UNIT &UnitSrc, UOM::UNIT &UnitTgt)
LIBEXPORT MISTRING	FormatScale (double ScaleDenominator, UOM::SYSTEMID UnitSystem, const UOM::UNIT &UnitSrc, FORMATSCALE format, int MinPrecision=3)
bool	operator!= (const UNIT &lhs, const UNIT &rhs)
bool	operator!= (const MEASURE &lhs, const MEASURE &rhs)
bool	operator== (const UNIT &lhs, const UNIT &rhs)
bool	operator== (const MEASURE &lhs, const MEASURE &rhs)

---

Typedef Documentation

typedef MILIST<MEASURE> UOM::MEASURELIST

---

Enumeration Type Documentation

enum UOM::FORMATSCALE

Format settings for UOM::FormatScale.

Enumerator:

FORMATSCALE_Ratio
FORMATSCALE_UnitFraction
FORMATSCALE_AddNewline
FORMATSCALE_AddSpacesAlways

enum UOM::IDNUM

Composite measure/unit ID enumeration.

Enumerator:

IDNUM_Unspecified
IDNUM_Scale_Unity
IDNUM_Scale_Percent
IDNUM_Scale_PartsPerMillion
IDNUM_Length_Kilometer
IDNUM_Length_Decimeter
IDNUM_Length_Meter
IDNUM_Length_Centimeter
IDNUM_Length_Millimeter
IDNUM_Length_Micrometer
IDNUM_Length_Nanometer
IDNUM_Length_Mile
IDNUM_Length_Foot
IDNUM_Length_TenthFoot
IDNUM_Length_HundredthFoot
IDNUM_Length_Inch
IDNUM_PlaneAngle_Degree
IDNUM_PlaneAngle_Radian
IDNUM_PlaneAngle_ArcMinute
IDNUM_PlaneAngle_ArcSecond
IDNUM_Area_SquareMeter
IDNUM_Area_SquareKilometer
IDNUM_Area_SquareMillimeter
IDNUM_Time_Second
IDNUM_Time_Millisecond
IDNUM_Time_Microsecond
IDNUM_Velocity_MetersPerSecond
IDNUM_Velocity_FeetPerSecond
IDNUM_Velocity_KilometersPerHour
IDNUM_Velocity_MilesPerHour
IDNUM_Velocity_Knots

enum UOM::SYSTEMID

Unit system IDs.

These are defined primarily to allow applications to provide a user interface for selection of a system of units. There is no specific set of units defined as belonging to a particular system.

Enumerator:

SYSTEMID_Unspecified
SYSTEMID_Metric	Metric/SI (meter, kilometer).
SYSTEMID_English	(foot, mile)

---

Function Documentation

LIBEXPORT double UOM::ConvertToScale	(	double	ScaleDenominator,
		UOM::SYSTEMID	UnitSystem,
		const UOM::UNIT &	UnitSrc,
		UOM::UNIT &	UnitTgt
	)

Convert scale denominator to corresponding value in unit system.

Returns:

Converted value, typically in range from 1-9999 where possible. Typically the converted value will be displayed to the user and should be limited to appropriate precision.

Parameters:

	ScaleDenominator	Scale denominator, eg 100000 for scale of 1 to 100000
	UnitSystem	Unit system
	UnitSrc	Unit for base measurement, typically cm or inch and corresponding to UnitSystem
	UnitTgt	Scaled target units in specified system returned

LIBEXPORT MISTRING UOM::FormatScale	(	double	ScaleDenominator,
		UOM::SYSTEMID	UnitSystem,
		const UOM::UNIT &	UnitSrc,
		FORMATSCALE	format,
		int	MinPrecision = 3
	)

Format scale for display.

Returns:

Formatted string, will be empty if no formatting done.

Parameters:

	ScaleDenominator	Scale denominator, eg 100000 for scale of 1 to 100000
	UnitSystem	Unit system
	UnitSrc	Unit for base measurement, typically cm or inch and corresponding to UnitSystem
	format	Formatting
	MinPrecision	Minimum precision (2-5)

bool UOM::operator!=	(	const UNIT &	lhs,
		const UNIT &	rhs
	)			[inline]

Inequality.

bool UOM::operator!=	(	const MEASURE &	lhs,
		const MEASURE &	rhs
	)			[inline]

Inequality.

bool UOM::operator==	(	const UNIT &	lhs,
		const UNIT &	rhs
	)			[inline]

Equality.

bool UOM::operator==	(	const MEASURE &	lhs,
		const MEASURE &	rhs
	)			[inline]

Equality.