For/en: Porovnání verzí
(Založena nová stránka s textem „== Description ==“) |
(Založena nová stránka s textem „Current value.“) |
||
| (Není zobrazeno 23 mezilehlých verzí od stejného uživatele.) | |||
| Řádek 7: | Řádek 7: | ||
'''Alias: FOR''' | '''Alias: FOR''' | ||
| − | ''' | + | '''Loop with an adjustable number of steps.''' |
| − | + | First, it sets the value according to the [[#initialvalue-|InitialValue]] parameter. Unless the value is greater than [[#finalvalue-|FinalValue]], it starts the loop body and increases the value at the end by [[#increments-|Increments]]. The behavior of the command when an error occurs in the body of the loop is affected by the [[#continueonerror-|ContinueOnError]] parameter. The [[#flowname-|FlowName]] and [[#flowdescription-|FlowDescription]] parameters allow user names and descriptions of individual waveforms of the loop body that can be used in the report template. | |
| − | == | + | == Input parameters == |
<span id="flowname-"></span> | <span id="flowname-"></span> | ||
=== FlowName === | === FlowName === | ||
| − | + | Type [[Data types#String | String]] | |
| − | + | Specifies the name of individual waves of the loop body. | |
<span id="flowdescription-"></span> | <span id="flowdescription-"></span> | ||
=== FlowDescription === | === FlowDescription === | ||
| − | + | Type [[Data types#String | String]] | |
| − | + | Specifies the descriptions of individual waveforms of the loop body. | |
<span id="initialvalue-"></span> | <span id="initialvalue-"></span> | ||
=== InitialValue === | === InitialValue === | ||
| − | + | Type [[Special:MyLanguage/Data types#Number | Number]] | |
| − | + | Initial value. | |
<span id="finalvalue-"></span> | <span id="finalvalue-"></span> | ||
=== FinalValue === | === FinalValue === | ||
| − | + | Type [[Special:MyLanguage/Data types#Number | Number]] | |
| − | + | Final value. | |
<span id="increment-"></span> | <span id="increment-"></span> | ||
=== Increment === | === Increment === | ||
| − | + | Type [[Special:MyLanguage/Data types#Number | Number]] | |
| − | + | Increase in value after passing through the loop. | |
<span id="continueonerror-"></span> | <span id="continueonerror-"></span> | ||
=== ContinueOnError === | === ContinueOnError === | ||
| − | + | Type [[Special:MyLanguage/Data types#Number | Number]] | |
| − | + | Error response mode in the loop body (0=do not continue, 1=continue absorbing errors, 2=continue but fail). With a non-null value, the loop continues through another waveform, even if an error occurs in its body. Each error will be absorbed, with the exception of mode 2, where the last error will be passed on after the loop completes. | |
=== Enabled === | === Enabled === | ||
| − | + | Type [[Special:MyLanguage/Data types#Number | Number]] | |
| − | + | Enables or disables the command. If the value is 0, the command will not be executed. | |
=== PreWait === | === PreWait === | ||
| − | + | Type [[Special:MyLanguage/Data types#Number | Number]] | |
| − | + | Delay in milliseconds before executing the command. It has no effect if Enabled=0. | |
=== PostWait === | === PostWait === | ||
| − | + | Type [[Special:MyLanguage/Data types#Number | Number]] | |
| − | + | Delay in milliseconds before executing the command. It has no effect if Enabled=0. | |
| − | == | + | == Output parameters == |
=== Value === | === Value === | ||
| − | + | Type [[Special:MyLanguage/Data types#Number | Number]] | |
| − | + | Current value. | |
Aktuální verze z 28. 1. 2021, 20:41
Obsah
Description
Alias: FOR
Loop with an adjustable number of steps.
First, it sets the value according to the InitialValue parameter. Unless the value is greater than FinalValue, it starts the loop body and increases the value at the end by Increments. The behavior of the command when an error occurs in the body of the loop is affected by the ContinueOnError parameter. The FlowName and FlowDescription parameters allow user names and descriptions of individual waveforms of the loop body that can be used in the report template.
Input parameters
FlowName
Type String
Specifies the name of individual waves of the loop body.
FlowDescription
Type String
Specifies the descriptions of individual waveforms of the loop body.
InitialValue
Type Number
Initial value.
FinalValue
Type Number
Final value.
Increment
Type Number
Increase in value after passing through the loop.
ContinueOnError
Type Number
Error response mode in the loop body (0=do not continue, 1=continue absorbing errors, 2=continue but fail). With a non-null value, the loop continues through another waveform, even if an error occurs in its body. Each error will be absorbed, with the exception of mode 2, where the last error will be passed on after the loop completes.
Enabled
Type Number
Enables or disables the command. If the value is 0, the command will not be executed.
PreWait
Type Number
Delay in milliseconds before executing the command. It has no effect if Enabled=0.
PostWait
Type Number
Delay in milliseconds before executing the command. It has no effect if Enabled=0.
Output parameters
Value
Type Number
Current value.
