Difference between revisions of "Extensions.Measure.GetMeasurementQuantity"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
 
{{DISPLAYTITLE:'''GetMeasurementQuantity '''}}[[Category:Measure]]
 
{{DISPLAYTITLE:'''GetMeasurementQuantity '''}}[[Category:Measure]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetMeasurementQuantity | Gets the measured NumericQuantity from a measurement | [[Term]] | [[Extensions.Measure|OTX Measure extension]] | [[Measurement related terms]] | [[Extensions.Measure.InvalidMeasurementException|InvalidMeasurementException]] | - }}
+
{{ClassificationActivity | GetMeasurementQuantity | Gets the measured NumericQuantity from a measurement | [[Term]] | [[Extensions.Measure|OTX Measure extension]] | [[Measurement related terms]] | [[Core.Actions.Throw.Exception.InvalidMeasurementException|InvalidMeasurementException]] | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==

Revision as of 06:57, 16 February 2016

Classification

Name GetMeasurementQuantity
Short Description Gets the measured NumericQuantity from a measurement
Class Term
Extension OTX Measure extension
Group Measurement related terms
Exceptions InvalidMeasurementException
Checker Rules -
Standard Compliant Yes

OTL Syntax

QuantityTerm = Measure.GetMeasurementQuantity(Measurement);

Description

This term gets the measured NumericQuantity from a measurement.

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
Quantity The NumericQuantity of a measurement.

Properties

Name Data Type Class Default Cardinality Description
Measurement Measurement Term - [1] The measurement whose quantity value is acquired.

OTL Examples

package Measure.DeviceSignature TestDocument
{
   DeviceServiceSignature Addition(in Integer a, in Integer b, out Measure.Measurement OutValue);
}

public procedure GetMeasurementQuantity()
{
   Measure.Measurement Return;
   Float a = 12;
   Quantities.Quantity Quantity;

   Measure.ExecuteDeviceService(TestDocument, Addition, {in a = 2, in b = 3, out OutValue = Return}, false, false);
   Quantity = Measure.GetMeasurementQuantity(Return);
}

See also

GetMeasurementTimestamp
GetMeasurementStatus
GetMeasurementFloatValue
IsValidMeasurement