Difference between revisions of "Extensions.Quantities.GetDisplayValue"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:'''GetDisplayValue '''}}[[Category:Quantities]] | {{DISPLAYTITLE:'''GetDisplayValue '''}}[[Category:Quantities]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | GetDisplayValue | Floating point numeric value | [[Term]] | [[Extensions.Quantities|OTX Quantities extension]] | [[Quantity and Unit related terms]] | - | - }} | + | {{ClassificationActivity | GetDisplayValue | Floating point numeric value | [[Term]] | [[Extensions.Quantities|OTX Quantities extension]] | [[Extensions.Quantities#Terms|Quantity and Unit related terms]] | - | - }} |
== OTL Syntax == | == OTL Syntax == | ||
| Line 9: | Line 9: | ||
== Description == | == Description == | ||
| − | The '''GetDisplayValue''' term | + | The '''GetDisplayValue''' term shall return the (dimensionless) Float value of a Quantity according to the Quantity's display unit. |
| − | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.Float|Float]] | The (dimensionless) float value a | + | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.Float|Float]] | The (dimensionless) float value of a Quantity.}} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| Quantity | [[Extensions.Quantities.Quantity|Quantity]] | [[Term]] | - | [1] | | + | {{TableRowPropertie1| Quantity | [[Extensions.Quantities.Quantity|Quantity]] | [[Term]] | - | [1] | Represents the Quantity from which the numeral value shall be extracted.}} |
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | Quantities.Quantity | + | Quantities.Quantity Quantity = 12.44 [@Unit, "BL_DataLibraMIB.odx", "km/h"]; |
Float Float1; | Float Float1; | ||
| − | Float1 = Quantities.GetDisplayValue( | + | /// Flow |
| + | |||
| + | Float1 = Quantities.GetDisplayValue(Quantity); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 03:43, 2 October 2018
Contents
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 shall 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.
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 shall be extracted. |
OTL Examples
Quantities.Quantity Quantity = 12.44 [@Unit, "BL_DataLibraMIB.odx", "km/h"];
Float Float1;
/// Flow
Float1 = Quantities.GetDisplayValue(Quantity);