Extensions.Quantities.GetDisplayValue

From emotive
Jump to navigation Jump to search

Classification

Name GetDisplayValue
Short Description Floating point numeric value
Class Term
Extension OTX Quantities extension
Group Quantity and Unit related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

FloatTerm Quantities.GetDisplayValue(QuantityTerm quantity);

Description

The GetDisplayValue term will return the (dimensionless) Float value of a Quantity according to the Quantity's display unit.

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
Float The (dimensionless) float value of a Quantity.

Properties

Name Data Type Class Default Cardinality Description
Quantity Quantity Term - [1] Represents the Quantity from which the numeral value will be extracted.

OTL Examples

/// Local Declarations

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

/// Flow

Float1 = Quantities.GetDisplayValue(Quantity);

See also

CreateQuantity
GetDisplayUnit
GetBaseUnit