Difference between revisions of "Extensions.Job.GetJobProgress"
Jump to navigation
Jump to search
Line 5: | Line 5: | ||
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
− | + | /// Local Declarations | |
+ | Integer IntegerVariable; | ||
+ | /// Flow | ||
+ | IntegerVariable = Job.GetJobProgress(DiagServiceValue); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Line 21: | Line 24: | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
+ | /// Local Declarations | ||
+ | |||
DiagCom.DiagService DiagService1; | DiagCom.DiagService DiagService1; | ||
Integer Integer1; | Integer Integer1; |
Revision as of 07:16, 25 October 2018
Contents
Classification
Name | GetJobProgress |
Short Description | Gets progress information from a DiagService object |
Class | Term |
Extension | OTX Job extension |
Group | Job related terms |
Exceptions | - |
Checker Rules | - |
Standard Compliant | Yes |
OTL Syntax
/// Local Declarations
Integer IntegerVariable;
/// Flow
IntegerVariable = Job.GetJobProgress(DiagServiceValue);
Description
The GetJobProgress retrieves progress information out of a DiagService object that encapsulates an OTX job.
Return Value
The Term returns the value, see table below.
![]()
In OTX, Terms are categorized according to its return data type!
Data Type | Description |
Integer | Progress information from a DiagService |
Properties
Name | Data Type | Class | Default | Cardinality | Description |
DiagJob | DiagService | Value | - | [0..1] | This diagnostic service object represents the job from which job progress information shall be retrieved. |
OTL Examples
/// Local Declarations
DiagCom.DiagService DiagService1;
Integer Integer1;
/// Flow
Integer1 = Job.GetJobProgress(DiagService1);