Difference between revisions of "Extensions.Measure.GetMeasurementStatus"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
 
{{DISPLAYTITLE:'''GetMeasurementStatus '''}}[[Category:Measure]]
 
{{DISPLAYTITLE:'''GetMeasurementStatus '''}}[[Category:Measure]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetMeasurementStatus | Gets the status of a measurement | [[Term]] | [[Extensions.Measure|OTX Measure extension]] | [[Extensions.Measure|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 ==
 
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
StringTerm = Measure.GetMeasurementStatus(Measurement);
+
StringTerm = Measure.GetMeasurementStatus(MeasurementTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 16: Line 16:
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| Measurement | [[Extensions.Measure.Measurement|Measurement]] | [[Term]] | - | [1] | The measurement whose status is acquired.}}
+
{{TableRowPropertie1| Measurement | [[Extensions.Measure.Measurement|Measurement]] | [[Term]] | - | [1] | Represents the '''measurement''' whose status shall be acquired.}}
 
|}
 
|}
  
 
== 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 TestDocument
+
/// Signatures
 +
 
 +
package Measure.DeviceSignature DeviceSignature1
 
{
 
{
  DeviceServiceSignature Sin(in Float a, out Measure.Measurement OutValue);
+
Measure.DeviceServiceSignature Add(in Integer a, out Measure.Measurement Measurement);
 
}
 
}
  
public procedure GetMeasurementStatus()
+
/// Global Declarations
 +
 
 +
public procedure main()
 
{
 
{
  Float a = 14;
+
/// Local Declarations
  Measure.Measurement Sin_Return;
+
 
  String Status;
+
Measure.Measurement Measurement1;
 +
Integer a1 = 10;
 +
String String1 = "";
 +
 
 +
/// Flow
  
  Measure.ExecuteDeviceService(TestDocument, Sin, {in a = a, out OutValue = Sin_Return}, false, false);
+
Measure.ExecuteDeviceService(DeviceSignature1, Add, {a = a1, Measurement = Measurement1}, false, false);
  Status = Measure.GetMeasurementStatus(Sin_Return);
+
String1 = Measure.GetMeasurementStatus(Measurement1);
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>

Revision as of 08:01, 19 October 2018

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);

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] Represents the measurement whose status shall 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