Difference between revisions of "Extensions.Quantities.GetBaseUnit"

From emotive
Jump to navigation Jump to search
Line 16: Line 16:
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| Quantity | [[Extensions.Quantities.Quantity|Quantity]] | [[Term]] | - | [1] | Represents the '''Quantity''' from which the base unit shall be extracted.}}
+
{{TableRowPropertie2| Quantity | [[Extensions.Quantities.Quantity|Quantity]] | [[Term]] | - | [1] | Represents the '''Quantity''' from which the base unit shall be extracted.}}
 
|}
 
|}
  

Revision as of 04:11, 2 October 2018

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 GetBaseUnit term shall 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 shall be extracted.

OTL Examples

Quantities.Quantity Quantity = 12.44 [@Unit, "BL_DataLibraMIB.odx", "km/h"];
Quantities.Unit Unit1;

/// Flow

Unit1 = Quantities.GetBaseUnit(Quantity);

See also

CreateQuantity
GetDisplayValue
GetDisplayUnit