Difference between revisions of "Extensions.Measure.IsValidMeasurement"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:'''IsValidMeasurement '''}}[[Category:Measure]] | {{DISPLAYTITLE:'''IsValidMeasurement '''}}[[Category:Measure]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | IsValidMeasurement | Evaluates the status of a measurement | [[Term]] | [[Extensions.Measure|OTX Measure extension]] | [[Measurement related terms]] | - | - }} | + | {{ClassificationActivity | IsValidMeasurement | Evaluates the status of a measurement.| [[Term]] | [[Extensions.Measure|OTX Measure extension]] | [[Extensions.Measure#Terms|Measurement related terms]] | - | - }} |
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | BooleanTerm = Measure.IsValidMeasurement( | + | BooleanTerm = Measure.IsValidMeasurement(MeasurementTerm); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == 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. | + | 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 shall be considered valid if it contains at least a quantity and a timestamp. |
| − | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | A measurement is considered valid if it contains at least an | + | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | A measurement is considered valid if it contains at least an quantity and a timestamp. }} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{ | + | {{TableRowPropertie2| Measurement | [[Extensions.Measure.Measurement|Measurement]] | [[Term]] | - | [1] | The '''measurement''' whose status shall be evaluated.}} |
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | package Measure.DeviceSignature | + | /// Signatures |
| + | |||
| + | package Measure.DeviceSignature DeviceSignature1 | ||
{ | { | ||
| − | + | Measure.DeviceServiceSignature Add(in Integer a, out Measure.Measurement Measurement); | |
} | } | ||
| − | public procedure | + | /// 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); | |
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 08:27, 19 October 2018
Contents
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);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 shall be considered valid if it contains at least a quantity and a timestamp.
Return Value
The Term returns the value, see table below.
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 shall 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
