Difference between revisions of "Extensions.Measure.ExecuteDeviceService"

From emotive
Jump to navigation Jump to search
Line 16: Line 16:
 
{{TableRowPropertie1| executeAsync | [[Boolean]] | [[Value]] | false | [0..1] | This option tells the communication backend to make this device service execution non-blocking. This means that if executeAsyncis set to true, the OTX execution flow will immediately move on to the  
 
{{TableRowPropertie1| executeAsync | [[Boolean]] | [[Value]] | false | [0..1] | This option tells the communication backend to make this device service execution non-blocking. This means that if executeAsyncis set to true, the OTX execution flow will immediately move on to the  
 
next Action, without waiting for the result of the '''ExecuteDeviceService''' action. }}
 
next Action, without waiting for the result of the '''ExecuteDeviceService''' action. }}
{{TableRowPropertie2| Device | [[OtxLink]] | - | - | [1] | This attribute identifies the measurement device to execute the service on. The link shall point to the corresponding '''DeviceSignature''' for that device. }}
+
{{TableRowPropertie2| suppressInvalidMeasurementException | [[Boolean]] | [[Value]] | false | [0..1] | This flag shall affect only those device services which declare InvalidMeasurementException in their throws block. For other device services, it shall have no effect. }}
{{TableRowPropertie1| Service | [[OtxName]] | - | - | [1] | Identifies the service which shall be executed. The service nameshall be defined within the corresponding service declaration within the '''DeviceSignature'''. }}
+
{{TableRowPropertie1| Device | [[OtxLink]] | - | - | [1] | This attribute identifies the measurement device to execute the service on. The link shall point to the corresponding '''DeviceSignature''' for that device. }}
{{TableRowPropertie2| Arguments | DeviceServiceArguments | - | - | [0..*] | Collection of [[Term]]s which allows an arbitrarylength list of in- and output arguments for the to-be-executed device service's parameters. }}
+
{{TableRowPropertie2| Service | [[OtxName]] | - | - | [1] | Identifies the service which shall be executed. The service nameshall be defined within the corresponding service declaration within the '''DeviceSignature'''. }}
 +
{{TableRowPropertie1| Arguments | DeviceServiceArguments | - | - | [0..*] | Collection of [[Term]]s which allows an arbitrarylength list of in- and output arguments for the to-be-executed device service's parameters. }}
 
|}
 
|}
  

Revision as of 23:16, 11 August 2015

Classification

Name ExecuteDeviceService
Short Description Execute a service providedby 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(Device, Service, DeviceServiceArguments, BooleanTerm, BooleanTerm);

Description

The ExecuteDeviceService action shall execute a service providedby 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 executeAsyncis 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 shall affect only those device services which declare InvalidMeasurementException in their throws block. For other device services, it shall have no effect.
Device OtxLink - - [1] This attribute identifies the measurement device to execute the service on. The link shall point to the corresponding DeviceSignature for that device.
Service OtxName - - [1] Identifies the service which shall be executed. The service nameshall be defined within the corresponding service declaration within the DeviceSignature.
Arguments DeviceServiceArguments - - [0..*] Collection of Terms which allows an arbitrarylength list of in- and output arguments for the to-be-executed device service's parameters.

OTL Examples

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

public procedure main()
{
   Measure.ExecuteDeviceService(DeviceSignature1, DeviceServiceSignature1, {in DeviceServiceInParameter1 = 1, out DeviceServiceOutParameter1 = null}, false, false);
}

See also

DeviceSignature