Difference between revisions of "Extensions.Job.SetProgressInfo"
Jump to navigation
Jump to search
| (4 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE: '''SetProgressInfo '''}} | {{DISPLAYTITLE: '''SetProgressInfo '''}} | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | SetProgressInfo | Sends progress information | [[Action]] | [[Extensions.Job|OTX Job extension]] | [[Job related actions]] | [[Extensions.DiagCom.InvalidStateException|InvalidStateException]] | - }} | + | {{ClassificationActivity | SetProgressInfo | Sends progress information to the tester.| [[Action]] | [[Extensions.Job|OTX Job extension]] | [[Extensions.Job#Actions|Job related actions]] | [[Extensions.DiagCom.InvalidStateException|InvalidStateException]] | - }} |
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | Job.SetProgressInfo( | + | Job.SetProgressInfo(NumericTerm progress); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | '''SetProgressInfo''' | + | The '''SetProgressInfo''' will send progress information in the form of an integer value to the tester. The value represents a percentage to completion and will be a number between 0 and 100. In case the provided value is smaller than 0, the OTX runtime will set the value to 0. In case the provided value is higher than 100, the OTX runtime will set the value to 100. |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{ | + | {{TableRowPropertie2| Progress | [[Numeric]] | [[Term]] | - | [1] | Represents the progress information as percentage to completion (0..100). [[Core.DataTypes.SimpleDataType.Float|Float]] values will be truncated.}} |
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| + | /// Local Declarations | ||
| + | |||
| + | /// Flow | ||
| + | |||
Job.SetProgressInfo(50); | Job.SetProgressInfo(50); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 26: | Line 30: | ||
[[Extensions.Job.SendIntermediateResult|SendIntermediateResult]]<br/> | [[Extensions.Job.SendIntermediateResult|SendIntermediateResult]]<br/> | ||
[[Extensions.Job.SetJobInfo|SetJobInfo]]<br/> | [[Extensions.Job.SetJobInfo|SetJobInfo]]<br/> | ||
| + | <!--[[Extensions.Job.SetProgressInfo|SetProgressInfo]]<br/>--> | ||
[[Extensions.Job.AddElement|AddElement]]<br/> | [[Extensions.Job.AddElement|AddElement]]<br/> | ||
[[Extensions.Job.AddBranchByName|AddBranchByName]]<br/> | [[Extensions.Job.AddBranchByName|AddBranchByName]]<br/> | ||
Latest revision as of 03:26, 13 September 2019
Classification
| Name | SetProgressInfo |
| Short Description | Sends progress information to the tester. |
| Class | Action |
| Extension | OTX Job extension |
| Group | Job related actions |
| Exceptions | InvalidStateException |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
Job.SetProgressInfo(NumericTerm progress);Description
The SetProgressInfo will send progress information in the form of an integer value to the tester. The value represents a percentage to completion and will be a number between 0 and 100. In case the provided value is smaller than 0, the OTX runtime will set the value to 0. In case the provided value is higher than 100, the OTX runtime will set the value to 100.
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Progress | Numeric | Term | - | [1] | Represents the progress information as percentage to completion (0..100). Float values will be truncated. |
OTL Examples
/// Local Declarations
/// Flow
Job.SetProgressInfo(50);See also
SendFinalResult
SendIntermediateResult
SetJobInfo
AddElement
AddBranchByName
AddBranchByIndex
AddBranchByValue
AddEnvDataByDtc
