[ Up: Operation Reference ]

The WhileLoop operation, similar to the CountedLoop operation, provides Workspace with a mechanism of repeatedly executing a "loop" of sub-components of a workflow. As long as the "Keep looping" input condition is true, the operation will repeatedly execute the "loop" of downstream operations. The "loop" is the set of operations between the Iteration dependency output and the Iteration dependency input. See also: Executing a loop

Default label: "While loop"
Member of plug-in: Built-in
Catalogue path: Builtin/Loops
Polymorphic: WhileLoop is a Polymorphic Operation. One or more of its inputs and outputs are not listed below because they are created dynamically whenever the operation changes its data type, and when it is first created.

Inputs:
Enable loop	bool	If enabled, the loop will repeatedly execute downstream operations that are between its "Iteration dependency" output and its "Iteration dependency" input. If not enabled, the loop will not execute any of these operations.
Keep looping	bool	While this condition is true, the "loop" will continue to execute.
Iteration dependency	CSIRO::DataExecution::Dependency	Special dependency input that marks the end of the loop. The last downstream operation that is to be executed as part of the loop must be connected to this input.
Outputs:
Iteration dependency	CSIRO::DataExecution::Dependency	The first operation inside the loop should be connected to this output.
First iteration?	bool	Returns true if this is the first iteration of the loop; false otherwise.