Difference between revisions of "Extensions.Quantities.GetBaseUnit"
Jump to navigation
Jump to search
(Created page with "Category:Quantities == Classification == {{ClassificationActivity | GetBaseUnit | Return the base unit of a '''Quantity''' value | Term | Quantities|OTX Quantities e...") |
|||
| Line 3: | Line 3: | ||
{{ClassificationActivity | GetBaseUnit | Return the base unit of a '''Quantity''' value | [[Term]] | [[Quantities|OTX Quantities extension]] | [[Quantity and Unit related terms]] | [[UnknownUnitException]] | - }} | {{ClassificationActivity | GetBaseUnit | Return the base unit of a '''Quantity''' value | [[Term]] | [[Quantities|OTX Quantities extension]] | [[Quantity and Unit related terms]] | [[UnknownUnitException]] | - }} | ||
| − | == | + | == OTL Syntax == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | + | UnitTerm = Quantities.GetBaseUnit(QuantityTerm); | |
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 19: | Line 19: | ||
|} | |} | ||
| − | == Examples == | + | == OTL Examples == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | Unit | + | Quantities.Quantity Quantity1 = 0 [@Unit, "ODX_RS_UNIT_LIB.odx", "%/ms"]; |
| + | Quantities.Unit Unit1; | ||
| + | |||
| + | Unit1 = Quantities.GetBaseUnit(Quantity1); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 09:52, 10 February 2015
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);