OpenTestSystem.Otx.Extensions.Measure.Actions.ExecuteDeviceService Class Reference

Execute a service provided by a measurement device More...

Inheritance diagram for OpenTestSystem.Otx.Extensions.Measure.Actions.ExecuteDeviceService:

Classes
class	DeviceServiceArguments
	Contains a list of in- and output arguments for the to-be-executed device service's parameters. More...

Public Attributes
DeviceServiceArguments	arguments
	Cardinality [0..1] Maps the parameters to variables or expressions. More...
OtxLink	device
	Cardinality [1] This attribute identifies the measurement device to execute the service on. The link shall point to the corresponding DeviceSignature for that device. More...
System.Boolean	executeAsync
	Cardinality [0..1] This option makes the device service execution non-blocking. If executeAsync is true, the OTX execution flow moves to the next action without waiting for the ExecuteDeviceService result. The DeviceEventSource term can be used to notify when a new result from an asynchronous device service arrives, then the OTX variable(s) linked to a service's output parameter(s) will potentially contain a new value. More...
OtxName	service
	Cardinality [1] Identifies the service which shall be executed. The service nameshall be defined within the corresponding service declaration within the DeviceSignature. More...
System.Boolean	suppressInvalidMeasurementException
	Cardinality [0..1] Two or more of the implementing procedures are valid. The AmbiguousCallException was thrown because throwExceptionOnAmbiguousCall="true". More...
Public Attributes inherited from OpenTestSystem.Otx.Core.Actions.ActionRealisation
OtxLink	validFor
	Cardinality [0..1] Validity of ActionRealisation. More...

Detailed Description

Execute a service provided by a measurement device

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

Checker rules

Core.CheckerRule.Core_Chk053 - no dangling OtxLink associations
CheckerRule.Measure_Chk001 - correct target for ExecuteDeviceService and DeviceEventSource
CheckerRule.Measure_Chk002 - executed device service is declarated in device signature
CheckerRule.Measure_Chk003 - correct ExecuteDeviceService arguments
CheckerRule.Measure_Chk004 - ExecuteDeviceService input argument omission
CheckerRule.Measure_Chk005 - No Path in ExecuteDeviceService ouput arguments

Syntax

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

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

Member Data Documentation

arguments

DeviceServiceArguments OpenTestSystem.Otx.Extensions.Measure.Actions.ExecuteDeviceService.arguments

Cardinality [0..1]
Maps the parameters to variables or expressions.

device

OtxLink OpenTestSystem.Otx.Extensions.Measure.Actions.ExecuteDeviceService.device

Cardinality [1]
This attribute identifies the measurement device to execute the service on. The link shall point to the corresponding DeviceSignature for that device.

executeAsync

System.Boolean OpenTestSystem.Otx.Extensions.Measure.Actions.ExecuteDeviceService.executeAsync

Cardinality [0..1]
This option makes the device service execution non-blocking. If executeAsync is true, the OTX execution flow moves to the next action without waiting for the ExecuteDeviceService result. The DeviceEventSource term can be used to notify when a new result from an asynchronous device service arrives, then the OTX variable(s) linked to a service's output parameter(s) will potentially contain a new value.

service

OtxName OpenTestSystem.Otx.Extensions.Measure.Actions.ExecuteDeviceService.service

Cardinality [1]
Identifies the service which shall be executed. The service nameshall be defined within the corresponding service declaration within the DeviceSignature.

suppressInvalidMeasurementException

System.Boolean OpenTestSystem.Otx.Extensions.Measure.Actions.ExecuteDeviceService.suppressInvalidMeasurementException

Cardinality [0..1]
Two or more of the implementing procedures are valid. The AmbiguousCallException was thrown because throwExceptionOnAmbiguousCall="true".