Difference between revisions of "Extensions.Job.SetProgressInfo"
Jump to navigation
Jump to search
| 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); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | '''SetProgressInfo''' | + | The '''SetProgressInfo''' shall send progress information in the form of an integer value to the tester. The value represents a percentage to completion and should be a number between 0 and 100. In case the provided value is smaller than 0, the OTX runtime shall set the value to 0. In case the provided value is higher than 100, the OTX runtime shall set the value to 100. |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{ | + | {{TableRowPropertie2| Info | [[Numeric]] | [[Term]] | - | [1] | Represents the progress information as percentage to completion (0..100). [[Core.DataTypes.SimpleDataType.Float|Float]] values shall be truncated.}} |
|} | |} | ||
Revision as of 03:29, 18 October 2018
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);Description
The SetProgressInfo shall send progress information in the form of an integer value to the tester. The value represents a percentage to completion and should be a number between 0 and 100. In case the provided value is smaller than 0, the OTX runtime shall set the value to 0. In case the provided value is higher than 100, the OTX runtime shall set the value to 100.
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Info | Numeric | Term | - | [1] | Represents the progress information as percentage to completion (0..100). Float values shall be truncated. |
OTL Examples
Job.SetProgressInfo(50);See also
SendFinalResult
SendIntermediateResult
SetJobInfo
AddElement
AddBranchByName
AddBranchByIndex
AddBranchByValue
AddEnvDataByDtc
