Extensions.Measure.IsValidMeasurement

From emotive
Jump to navigation Jump to search

Classification

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

OTL Syntax

BooleanTerm Measure.IsValidMeasurement(MeasurementTerm measurement);

Description

This term evaluates the status of a measurement. Since the state constants are not defined in this standard, this activity can be used to determine whether the measurement is used or not. A measurement will be considered valid if it contains at least a quantity and a timestamp.

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
Boolean A measurement is considered valid if it contains at least an quantity and a timestamp.

Properties

Name Data Type Class Default Cardinality Description
Measurement Measurement Term - [1] The measurement whose status will be evaluated.

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;
	Boolean Boolean1 = false;

	/// Flow

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

See also

GetMeasurementTimestamp
GetMeasurementStatus
GetMeasurementQuantity
GetMeasurementFloatValue