Difference between revisions of "Extensions.Measure.GetMeasurementStatus"

From emotive
Jump to navigation Jump to search
(Created page with "Category:Measure == Classification == {{ClassificationActivity | GetMeasurementStatus | Gets the status of a measurement | Term | OTX Measure extension | [...")
 
Line 3: Line 3:
 
{{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]] | [[Measure|OTX Measure extension]] | [[Measurement related terms]] | - | - }}
  
== Pseudo-Code Syntax ==
+
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
String GetMeasurementStatus(Measurement measurement);
+
StringTerm = Measure.GetMeasurementStatus(Measurement);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 19: Line 19:
 
|}
 
|}
  
== Examples ==
+
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
String result = GetMeasurementStatus(measurement);
+
package Measure.DeviceSignature TestDocument
 +
{
 +
  DeviceServiceSignature Sin(in Float a, out Measure.Measurement OutValue);
 +
}
 +
 
 +
public procedure GetMeasurementStatus()
 +
{
 +
  Float a = 14;
 +
  Measure.Measurement Sin_Return;
 +
  String Status;
 +
 
 +
  Measure.ExecuteDeviceService(TestDocument, Sin, {in a = a, out OutValue = Sin_Return}, false, false);
 +
  Status = Measure.GetMeasurementStatus(Sin_Return);
 +
}
 
</syntaxhighlight>
 
</syntaxhighlight>
  

Revision as of 09:05, 10 February 2015

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(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.

Icons Note.png 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] The measurement whose status is acquired.

OTL Examples

package Measure.DeviceSignature TestDocument
{
   DeviceServiceSignature Sin(in Float a, out Measure.Measurement OutValue);
}

public procedure GetMeasurementStatus()
{
   Float a = 14;
   Measure.Measurement Sin_Return;
   String Status;

   Measure.ExecuteDeviceService(TestDocument, Sin, {in a = a, out OutValue = Sin_Return}, false, false);
   Status = Measure.GetMeasurementStatus(Sin_Return);
}

See also

GetMeasurementTimestamp
GetMeasurementQuantity
GetMeasurementFloatValue
IsValidMeasurement