Difference between revisions of "Extensions.Quantities.GetBaseUnit"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:'''GetBaseUnit '''}}[[Category:Quantities]] | {{DISPLAYTITLE:'''GetBaseUnit '''}}[[Category:Quantities]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | GetBaseUnit | Return the base unit of a '''Quantity''' value | [[Term]] | [[Extensions.Quantities|OTX Quantities extension]] | [[Quantity and Unit related terms]] | [[ | + | {{ClassificationActivity | GetBaseUnit | Return the base unit of a '''Quantity''' value | [[Term]] | [[Extensions.Quantities|OTX Quantities extension]] | [[Quantity and Unit related terms]] | [[Core.Actions.Throw.Exception.UnknownUnitException|UnknownUnitException]] | - }} |
== OTL Syntax == | == OTL Syntax == | ||
Revision as of 06:49, 16 February 2016
Contents
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 |
OTL Syntax
UnitTerm = Quantities.GetBaseUnit(QuantityTerm);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.
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. |
OTL Examples
Quantities.Quantity Quantity1 = 0 [@Unit, "ODX_RS_UNIT_LIB.odx", "%/ms"];
Quantities.Unit Unit1;
Unit1 = Quantities.GetBaseUnit(Quantity1);