Variable Condition Loop End

In combination with a Generic Loop Start node, this node lets you execute the body of the loop until a certain condition on one of the flow variables is met. In the dialog you can choose one of the available flow variables and which condition should cause the loop to finish.

Options

Available variables
In the list you can select one of the available flow variables. Below the list, you can choose, when the loop's execution should be finished, i.e. when the selected variable is, equal, greater, greater or equal, smaller, or smaller or equal than the given value. For string variables only the check for equality is possible.
Collect rows from last iteration
The default is to collect the rows from all the loop's iterations, including the last one after which the loop is stopped. If you de-select this option, the rows from the last iteration are not added to the output table.
Collect rows from last iteration only
If only the rows from the very last iteration should be collected, you have to enable this option.
Add iteration column
Allows you to add a column containing the iteration number to the output table.
Propagate modified loop variables
If checked, variables whose values are modified within the loop are exported by this node. These variables must be declared outside the loop, i.e. injected into the loop from a side-branch or be available upstream of the corresponding loop start node. For the latter, any modification of a variable is passed back to the start node in subsequent iterations (e.g. moving sum calculation). Note that variables defined by the loop start node itself are excluded as these usually represent loop controls (e.g. "currentIteration").

Input Ports

Icon
Any datatable

Output Ports

Icon
Collected results from the loop body
Icon
The selected flow variable's values in each iteration

Views

This node has no views

Workflows

Further Links

Developers

You want to see the source code for this node? Click the following button and we’ll use our super-powers to find it for you.