Extensions.Measure.IsValidMeasurement

From emotive
Revision as of 09:13, 10 February 2015 by Tl (talk | contribs)
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(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.

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 amount and a time stamp.

Properties

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

OTL Examples

package Measure.DeviceSignature TestDocument
{
   DeviceServiceSignature Addition(in Integer a, in Integer b, out Measure.Measurement OutValue);
}

public procedure IsValidMeasurement()
{
   Measure.Measurement Addition_Return;
   Boolean Boolean = false;

   Measure.ExecuteDeviceService(TestDocument, Addition, {in a = 2, in b = 3, out OutValue = Addition_Return}, false, false);
   Boolean = Measure.IsValidMeasurement(Addition_Return);
}

See also

GetMeasurementTimestamp
GetMeasurementStatus
GetMeasurementQuantity
GetMeasurementFloatValue