Difference between revisions of "Extensions.Measure.GetMeasurementFloatValue"
Jump to navigation
Jump to search
(Created page with "Category:Measure == Classification == {{ClassificationActivity | GetMeasurementFloatValue | Gets the float value of a measurement | Term | Measure|OTX Measure extens...") |
|||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | [[Category:Measure]] | + | {{DISPLAYTITLE:'''GetMeasurementFloatValue '''}}[[Category:Measure]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | GetMeasurementFloatValue | Gets the float value of a measurement | [[Term]] | [[Measure|OTX Measure extension]] | [[Measurement related terms]] | [[InvalidMeasurementException]] | - }} | + | {{ClassificationActivity | GetMeasurementFloatValue | Gets the raw float value of a measurement| [[Term]] | [[Extensions.Measure|OTX Measure extension]] | [[Extensions.Measure#Terms|Measurement related terms]] | [[Extensions.Measure.InvalidMeasurementException|InvalidMeasurementException]] | - }} |
| − | == | + | == OTL Syntax == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | + | FloatTerm Measure.GetMeasurementFloatValue(MeasurementTerm measurement); | |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | This term | + | This term gets the raw float value of a measurement as it has been received from the measurement device, disregarding any physical unit information. |
| − | {{TermReturnValue| [[Float]] | The float value of a measurement. }} | + | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.Float|Float]] | The raw float value of a measurement. }} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{ | + | {{TableRowPropertie2| Measurement | [[Extensions.Measure.Measurement|Measurement]] | [[Term]] | - | [1] | The '''measurement''' whose raw float value will be acquired.}} |
|} | |} | ||
| − | == Examples == | + | == OTL Examples == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | Float | + | /// Signatures |
| + | |||
| + | package Measure.DeviceSignature DeviceSignature1 | ||
| + | { | ||
| + | Measure.DeviceServiceSignature Add(in Integer a, out Measure.Measurement Measurement); | ||
| + | } | ||
| + | |||
| + | /// Global Declarations | ||
| + | |||
| + | public procedure main() | ||
| + | { | ||
| + | /// Local Declarations | ||
| + | |||
| + | Measure.Measurement Measurement1; | ||
| + | Integer a1 = 10; | ||
| + | Float Float1; | ||
| + | |||
| + | /// Flow | ||
| + | |||
| + | Measure.ExecuteDeviceService(DeviceSignature1, Add, {a = a1, Measurement = Measurement1}, false, false); | ||
| + | Float1 = Measure.GetMeasurementFloatValue(Measurement1); | ||
| + | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
| − | [[GetMeasurementTimestamp]] <br/> | + | [[Extensions.Measure.GetMeasurementTimestamp|GetMeasurementTimestamp]] <br/> |
| − | [[GetMeasurementStatus]] <br/> | + | [[Extensions.Measure.GetMeasurementStatus|GetMeasurementStatus]] <br/> |
| − | [[GetMeasurementQuantity]] <br/> | + | [[Extensions.Measure.GetMeasurementQuantity|GetMeasurementQuantity]] <br/> |
| − | [[IsValidMeasurement]] | + | [[Extensions.Measure.IsValidMeasurement|IsValidMeasurement]] |
Latest revision as of 02:52, 13 September 2019
Contents
Classification
| Name | GetMeasurementFloatValue |
| Short Description | Gets the raw float value of a measurement |
| Class | Term |
| Extension | OTX Measure extension |
| Group | Measurement related terms |
| Exceptions | InvalidMeasurementException |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
FloatTerm Measure.GetMeasurementFloatValue(MeasurementTerm measurement);Description
This term gets the raw float value of a measurement as it has been received from the measurement device, disregarding any physical unit information.
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 raw float value of a measurement. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Measurement | Measurement | Term | - | [1] | The measurement whose raw float value will be acquired. |
OTL Examples
/// Signatures
package Measure.DeviceSignature DeviceSignature1
{
Measure.DeviceServiceSignature Add(in Integer a, out Measure.Measurement Measurement);
}
/// Global Declarations
public procedure main()
{
/// Local Declarations
Measure.Measurement Measurement1;
Integer a1 = 10;
Float Float1;
/// Flow
Measure.ExecuteDeviceService(DeviceSignature1, Add, {a = a1, Measurement = Measurement1}, false, false);
Float1 = Measure.GetMeasurementFloatValue(Measurement1);
}See also
GetMeasurementTimestamp
GetMeasurementStatus
GetMeasurementQuantity
IsValidMeasurement
