Extensions.Quantities.GetBaseUnit

From emotive
Revision as of 07:37, 7 August 2014 by Nb (talk | contribs) (Created page with "Category:Quantities == Classification == {{ClassificationActivity | GetBaseUnit | Return the base unit of a '''Quantity''' value | Term | Quantities|OTX Quantities e...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Classification

Name GetBaseUnit
Short Description Return the base unit of a Quantity value
Class Term
Extension OTX Quantities extension
Group Quantity and Unit related terms
Exceptions UnknownUnitException
Checker Rules -
Standard Compliant Yes

Pseudo-Code Syntax

Unit GetBaseUnit(Quantity quantity);

Description

The GetDisplayUnitName term return the base unit of a Quantity value, according to its physical dimension (e.g. "m", "m/s","s"etc.).

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
Unit The base unit of a Quantity value

Properties

Name Data Type Class Default Cardinality Description
Quantity Quantity Term - [1] Represents the Quantity from which the base unit should be extracted.

Examples

Unit result = GetBaseUnit(myQuantity);

See also

CreateQuantity
GetDisplayValue
GetDisplayUnit