Extensions.Measure.ExecuteDeviceService

From emotive
Jump to navigation Jump to search

Classification

Name ExecuteDeviceService
Short Description Executes a service provided by a measurement device.
Class Action
Extension OTX Measure extension
Group Measure related actions
Exceptions -
Checker Rules Core_Chk053
Measure_Chk001
Measure_Chk002
Measure_Chk003
Measure_Chk004
Measure_Chk005
Standard Compliant Yes

OTL Syntax

Measure.ExecuteDeviceService(OtxLink device, OtxName service, {DeviceServiceArguments[ ] arguments}, Boolean suppressInvalidMeasurementException, Boolean executeAsync);

Description

The ExecuteDeviceService action will execute a service provided by a measurement device. The action connects to physical devices from where it retrieves measurements.

Properties

Name Data Type Class Default Cardinality Description
ExecuteAsync Boolean Value false [0..1] This option tells the communication backend to make this device service execution non-blocking. This means that if executeAsync is set to true, the OTX execution flow will immediately move on to the next Action, without waiting for the result of the ExecuteDeviceService action.
SuppressInvalidMeasurementException Boolean Value false [0..1] This flag will affect only those device services which declare InvalidMeasurementException in their <throws> block. For other device services, it will have no effect.
Device OtxLink - - [1] This attribute identifies the measurement device to execute the service on. The link will point to the corresponding DeviceSignature for that device.
Service OtxName - - [1] Identifies the service which will be executed. The service name will be defined within the corresponding service declaration within the DeviceSignature.
Arguments DeviceServiceArguments - - [0..1] The content-type of this simple container element is <xsd:choice> [1..*] which allows an arbitrarylength list of in- and output arguments for the to-be-executed device service's parameters.

OTL Examples

/// Signatures

package Measure.DeviceSignature DeviceSignature1
{
	Measure.DeviceServiceSignature DeviceServiceSignature1(in Integer DeviceServiceInParameter1, out String DeviceServiceOutParameter1);
}

/// Global Declarations

public procedure main()
{
	/// Local Declarations

	/// Flow

	Measure.ExecuteDeviceService(DeviceSignature1, DeviceServiceSignature1, {DeviceServiceInParameter1 = 4, DeviceServiceOutParameter1}, false, false);

See also

DeviceSignature