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...") |
|||
| (8 intermediate revisions by 2 users not shown) | |||
| 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]] | [[Extensions.Quantities#Terms|Quantity and Unit related terms]] | [[Extensions.Quantities.UnknownUnitException|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 quantity); | |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The ''' | + | The '''GetBaseUnit''' term will 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}} | ||
| − | {{ | + | {{TableRowPropertie2| Quantity | [[Extensions.Quantities.Quantity|Quantity]] | [[Term]] | - | [1] | Represents the '''Quantity''' from which the base unit will be extracted.}} |
|} | |} | ||
| − | == Examples == | + | == OTL Examples == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | Unit | + | /// Local Declarations |
| + | |||
| + | Quantities.Quantity Quantity = 12.44 [@Unit, "BL_DataLibraMIB.odx", "km/h"]; | ||
| + | Quantities.Unit Unit1; | ||
| + | |||
| + | /// Flow | ||
| + | |||
| + | Unit1 = Quantities.GetBaseUnit(Quantity); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
| − | [[CreateQuantity]] <br/> | + | [[Extensions.Quantities.CreateQuantity|CreateQuantity]] <br/> |
| − | [[GetDisplayValue]] <br/> | + | [[Extensions.Quantities.GetDisplayValue|GetDisplayValue]] <br/> |
| − | [[GetDisplayUnit]] | + | [[Extensions.Quantities.GetDisplayUnit|GetDisplayUnit]] |
Latest revision as of 03:12, 13 September 2019
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 quantity);Description
The GetBaseUnit term will 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 will be extracted. |
OTL Examples
/// Local Declarations
Quantities.Quantity Quantity = 12.44 [@Unit, "BL_DataLibraMIB.odx", "km/h"];
Quantities.Unit Unit1;
/// Flow
Unit1 = Quantities.GetBaseUnit(Quantity);