Extensions.Measure.GetMeasurementFloatValue

From emotive
Jump to navigation Jump to search

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.

Icons Note.png 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