Difference between revisions of "Extensions.Quantities.GetBaseUnit"
Jump to navigation
Jump to search
m (Hb moved page GetBaseUnit to Extensions.Quantities.GetBaseUnit: #3153) |
|||
| Line 1: | Line 1: | ||
| − | [[Category:Quantities]] | + | {{DISPLAYTITLE:'''GetBaseUnit '''}}[[Category:Quantities]] |
== Classification == | == Classification == | ||
| − | {{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]] | [[Extensions.Quantities|OTX Quantities extension]] | [[Quantity and Unit related terms]] | [[Extensions.Quantities.UnknownUnitException|UnknownUnitException]] | - }} |
== OTL Syntax == | == OTL Syntax == | ||
| Line 11: | Line 11: | ||
The '''GetDisplayUnitName''' term return the base unit of a '''Quantity''' value, according to its physical dimension (e.g. "m", "m/s","s"etc.). | The '''GetDisplayUnitName''' term return the base unit of a '''Quantity''' value, according to its physical dimension (e.g. "m", "m/s","s"etc.). | ||
| − | {{TermReturnValue| [[Unit]] | The base unit of a '''Quantity''' value}} | + | {{TermReturnValue| [[Extensions.Quantities.Unit|Unit]] | The base unit of a '''Quantity''' value}} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| Quantity | [[Quantity]] | [[Term]] | - | [1] | Represents the '''Quantity''' from which the base unit should be extracted.}} | + | {{TableRowPropertie1| Quantity | [[Extensions.Quantities.Quantity|Quantity]] | [[Term]] | - | [1] | Represents the '''Quantity''' from which the base unit should be extracted.}} |
|} | |} | ||
| Line 28: | Line 28: | ||
== See also == | == See also == | ||
| − | [[CreateQuantity]] <br/> | + | [[Extensions.Quantities.CreateQuantity|CreateQuantity]] <br/> |
| − | [[GetDisplayValue]] <br/> | + | [[Extensions.Quantities.GetDisplayValue|GetDisplayValue]] <br/> |
| − | [[GetDisplayUnit]] | + | [[Extensions.Quantities.GetDisplayUnit|GetDisplayUnit]] |
Revision as of 03:07, 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);