Difference between revisions of "Extensions.Quantities.GetDisplayValue"

From emotive
Jump to navigation Jump to search
(Created page with "Category:Quantities == Classification == {{ClassificationActivity | GetDisplayValue | Floating point numeric value | Term | OTX Quantities extension | [...")
 
Line 3: Line 3:
 
{{ClassificationActivity | GetDisplayValue | Floating point numeric value | [[Term]] | [[Quantities|OTX Quantities extension]] | [[Quantity and Unit related terms]] | - | - }}
 
{{ClassificationActivity | GetDisplayValue | Floating point numeric value | [[Term]] | [[Quantities|OTX Quantities extension]] | [[Quantity and Unit related terms]] | - | - }}
  
== Pseudo-Code Syntax ==
+
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
Quantity GetDisplayValue(Quantity quantity);
+
FloatTerm = Quantities.GetDisplayValue(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;">
Float result = GetDisplayValue(myQuantity);
+
Quantities.Quantity Quantity1 = 0 [@Unit, "ODX_RS_UNIT_LIB.odx", "%/ms"];
 +
Float Float1;
 +
 
 +
Float1 = Quantity.GetDisplayValue(Quantity1);
 
</syntaxhighlight>
 
</syntaxhighlight>
  

Revision as of 09:49, 10 February 2015

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);

Description

The GetDisplayValue term which as a result of the non-dimensional value of a numeric variable (NumericQuantity) as float returns (float).

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 a NumericQuantity.

Properties

Name Data Type Class Default Cardinality Description
Quantity Quantity Term - [1] The NumericQuantity, from which the float value to be extracted

OTL Examples

Quantities.Quantity Quantity1 = 0 [@Unit, "ODX_RS_UNIT_LIB.odx", "%/ms"];
Float Float1;

Float1 = Quantity.GetDisplayValue(Quantity1);

See also

CreateQuantity
GetDisplayUnit
GetBaseUnit