Difference between revisions of "Extensions.Measure.ExecuteDeviceService"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
| − | [[Category:Measure]] | + | {{DISPLAYTITLE:'''ExecuteDeviceService '''}}[[Category:Measure]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | ExecuteDeviceService | Execute a service providedby a measurement device. | [[Action]] | [[Measure|OTX Measure extension]] | [[Measure related actions]] | - | [[CoreChk053|Core_Chk053]]<br />[[MeasureChk001|Measure_Chk001]]<br />[[MeasureChk002|Measure_Chk002]]<br/>[[MeasureChk003|Measure_Chk003]]<br/>[[MeasureChk004|Measure_Chk004]]<br/>[[MeasureChk005|Measure_Chk005]] }} | + | {{ClassificationActivity | ExecuteDeviceService | Execute a service providedby a measurement device. | [[Action]] | [[Extensions.Measure|OTX Measure extension]] | [[Measure related actions]] | - | [[Core.Validation.CoreChk053|Core_Chk053]]<br />[[Extensions.Measure.MeasureChk001|Measure_Chk001]]<br />[[Extensions.Measure.MeasureChk002|Measure_Chk002]]<br/>[[Extensions.Measure.MeasureChk003|Measure_Chk003]]<br/>[[Extensions.Measure.MeasureChk004|Measure_Chk004]]<br/>[[Extensions.Measure.MeasureChk005|Measure_Chk005]] }} |
== OTL Syntax == | == OTL Syntax == | ||
| Line 14: | Line 14: | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{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 | [[Core.DataTypes.SimpleDataType.Boolean|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| 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. }} | + | {{TableRowPropertie2| suppressInvalidMeasurementException | [[Core.DataTypes.SimpleDataType.Boolean|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| 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. }} | {{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| Service | [[OtxName]] | - | - | [1] | Identifies the service which shall be executed. The service nameshall be defined within the corresponding service declaration within the '''DeviceSignature'''. }} | {{TableRowPropertie2| Service | [[OtxName]] | - | - | [1] | Identifies the service which shall be executed. The service nameshall be defined within the corresponding service declaration within the '''DeviceSignature'''. }} | ||
Revision as of 02:25, 16 February 2016
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 device, Service service, DeviceServiceArguments arguments, BooleanTerm executeAsync, BooleanTerm suppressInvalidMeasurementException);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);
}