Difference between revisions of "Extensions.Job.SetProgressInfo"
Jump to navigation
Jump to search
m (Hb moved page SetProgressInfo to Extensions.Job.SetProgressInfo: #3153) |
|||
| Line 1: | Line 1: | ||
| + | {{DISPLAYTITLE: '''SetProgressInfo '''}} | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | SetProgressInfo | Sends progress information | [[Action]] | [[Job|OTX Job extension]] | [[Job related actions]] | [[InvalidStateException]] | - }} | + | {{ClassificationActivity | SetProgressInfo | Sends progress information | [[Action]] | [[Extensions.Job|OTX Job extension]] | [[Job related actions]] | [[Extensions.DiagCom.InvalidStateException|InvalidStateException]] | - }} |
== OTL Syntax == | == OTL Syntax == | ||
| Line 13: | Line 14: | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| Info | [[Integer]] | [[Term]] | - | [1] | The progress information as a percentage of completion.}} | + | {{TableRowPropertie1| Info | [[Core.DataTypes.SimpleDataType.Integer|Integer]] | [[Term]] | - | [1] | The progress information as a percentage of completion.}} |
|} | |} | ||
| Line 22: | Line 23: | ||
== See also == | == See also == | ||
| − | [[SendFinalResult]]<br/> | + | [[Extensions.Job.SendFinalResult|SendFinalResult]]<br/> |
| − | [[SendIntermediateResult]]<br/> | + | [[Extensions.Job.SendIntermediateResult|SendIntermediateResult]]<br/> |
| − | [[SetJobInfo]]<br/> | + | [[Extensions.Job.SetJobInfo|SetJobInfo]]<br/> |
| − | [[AddElement]]<br/> | + | [[Extensions.Job.AddElement|AddElement]]<br/> |
| − | [[AddBranchByName]]<br/> | + | [[Extensions.Job.AddBranchByName|AddBranchByName]]<br/> |
| − | [[AddBranchByIndex]]<br/> | + | [[Extensions.Job.AddBranchByIndex|AddBranchByIndex]]<br/> |
| − | [[AddBranchByValue]]<br/> | + | [[Extensions.Job.AddBranchByValue|AddBranchByValue]]<br/> |
| − | [[AddEnvDataByDtc]] | + | [[Extensions.Job.AddEnvDataByDtc|AddEnvDataByDtc]] |
Revision as of 10:32, 15 February 2016
Classification
| Name | SetProgressInfo |
| Short Description | Sends progress information |
| Class | Action |
| Extension | OTX Job extension |
| Group | Job related actions |
| Exceptions | InvalidStateException |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
Job.SetProgressInfo(IntegerTerm);Description
SetProgressInfo sends progress information in the form of an integer value to the tester. The value corresponds to a percentage of completion and should be a number between 0 and 100. In the case of the value provided is less than 0, the OTX term is the value set to 0. If the value specified is greater than 100, the OTX runtime is set the value to 100.
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Info | Integer | Term | - | [1] | The progress information as a percentage of completion. |
OTL Examples
Job.SetProgressInfo(50);See also
SendFinalResult
SendIntermediateResult
SetJobInfo
AddElement
AddBranchByName
AddBranchByIndex
AddBranchByValue
AddEnvDataByDtc
