Extensions.Measure.GetMeasurementStatus

From emotive
Jump to navigation Jump to search

Classification

Name GetMeasurementStatus
Short Description Gets the status of a measurement
Class Term
Extension OTX Measure extension
Group Measurement related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

StringTerm Measure.GetMeasurementStatus(MeasurementTerm measurement);

Description

This term gets the status of a measurement. The status of the measurement reflects the situation of the generation of the measurement. The returned status is a String

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
String The status of a measurement.

Properties

Name Data Type Class Default Cardinality Description
Measurement Measurement Term - [1] Represents the measurement whose status 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;
	String String1 = "";

	/// Flow

	Measure.ExecuteDeviceService(DeviceSignature1, Add, {a = a1, Measurement = Measurement1}, false, false);
	String1 = Measure.GetMeasurementStatus(Measurement1);
}

See also

GetMeasurementTimestamp
GetMeasurementQuantity
GetMeasurementFloatValue
IsValidMeasurement