Difference between revisions of "Extensions.Measure.IsValidMeasurement"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
[[Category:Measure]]
+
{{DISPLAYTITLE:'''IsValidMeasurement '''}}[[Category:Measure]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | IsValidMeasurement | Evaluates the status of a measurement | [[Term]] | [[Measure|OTX Measure extension]] | [[Measurement related terms]] | - | - }}
+
{{ClassificationActivity | IsValidMeasurement | Evaluates the status of a measurement | [[Term]] | [[Extensions.Measure|OTX Measure extension]] | [[Measurement related terms]] | - | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
Line 11: Line 11:
 
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.
 
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.
  
{{TermReturnValue| [[Boolean]] | A measurement is considered valid if it contains at least an amount and a time stamp. }}
+
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | A measurement is considered valid if it contains at least an amount and a time stamp. }}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| Measurement | [[Measurement]] | [[Term]] | - | [1] | The measurement whose status is being evaluated.}}
+
{{TableRowPropertie1| Measurement | [[Extensions.Measure.Measurement|Measurement]] | [[Term]] | - | [1] | The measurement whose status is being evaluated.}}
 
|}
 
|}
  
Line 37: Line 37:
  
 
== 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/>
[[GetMeasurementFloatValue]]
+
[[Extensions.Measure.GetMeasurementFloatValue|GetMeasurementFloatValue]]

Revision as of 02:36, 16 February 2016

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