Difference between revisions of "Extensions.Measure.GetMeasurementStatus"
Jump to navigation
Jump to search
(Created page with "Category:Measure == Classification == {{ClassificationActivity | GetMeasurementStatus | Gets the status of a measurement | Term | OTX Measure extension | [...") |
|||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | [[Category:Measure]] | + | {{DISPLAYTITLE:'''GetMeasurementStatus '''}}[[Category:Measure]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | GetMeasurementStatus | Gets the status of a measurement | [[Term]] | [[Measure|OTX Measure extension]] | [[Measurement related terms]] | - | - }} | + | {{ClassificationActivity | GetMeasurementStatus | Gets the status of a measurement | [[Term]] | [[Extensions.Measure|OTX Measure extension]] | [[Extensions.Measure#Terms|Measurement related terms]] | - | - }} |
| − | == | + | == OTL Syntax == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | + | StringTerm Measure.GetMeasurementStatus(MeasurementTerm measurement); | |
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 11: | Line 11: | ||
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'' | 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'' | ||
| − | {{TermReturnValue| [[String]] | The status of a measurement. }} | + | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | The status of a measurement. }} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{ | + | {{TableRowPropertie2| Measurement | [[Extensions.Measure.Measurement|Measurement]] | [[Term]] | - | [1] | Represents the '''measurement''' whose status will be acquired.}} |
|} | |} | ||
| − | == Examples == | + | == OTL Examples == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | String | + | /// 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); | ||
| + | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
| − | [[GetMeasurementTimestamp]] <br/> | + | [[Extensions.Measure.GetMeasurementTimestamp|GetMeasurementTimestamp]] <br/> |
| − | [[GetMeasurementQuantity]] <br/> | + | [[Extensions.Measure.GetMeasurementQuantity|GetMeasurementQuantity]] <br/> |
| − | [[GetMeasurementFloatValue]] <br/> | + | [[Extensions.Measure.GetMeasurementFloatValue|GetMeasurementFloatValue]] <br/> |
| − | [[IsValidMeasurement]] | + | [[Extensions.Measure.IsValidMeasurement|IsValidMeasurement]] |
Latest revision as of 02:51, 13 September 2019
Contents
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.
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
