Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
do_while [2020/04/30 12:08]
argemiro 		do_while [2026/08/28 03:17] (current)
hermann Sync from local documentation review
Line 1: Line 1:
-====== Do while ======+====== Do While ======
  
 ===== Description ===== ===== Description =====
  
-This functor ​executes ​contained functor while "set while condition" ​is true.+This container ​executes ​the functors it contains at least once, and keeps executing them for as long as the condition ​set by a [[Set While Condition]] functor placed inside it is true. Each execution is called a step. While a step runs, the container makes the current step available to its contents through the internal output port Step.
  
 ===== Inputs ===== ===== Inputs =====
  
-Functor doesn'​t have any inputs ports+None. 
 + 
 +===== Optional Inputs ===== 
 + 
 +^ Name  ^ Type  ^ Description ​ ^ Default Value  ^ 
 +| Sequence Input  | [[None Type]] ​ | Ensures that the functor connected to this port finishes executing before this container starts. ​ | None  |
  
 ===== Outputs ===== ===== Outputs =====
  
-Functor doesn't have any outputs ports+^ Name  ^ Type  ^ Description ​ ^ 
 +| Sequence Output ​ | [[None Type]] ​ | Connect this port to another container's Sequence Input to make this container finish executing before that other container starts. ​ | 
 + 
 +===== Internal Outputs ===== 
 + 
 +^ Name  ^ Type  ^ Description ​ ^ 
 +| Step  | [[Non Negative Integer Value Type]] ​ | Current iteration step.  | 
 + 
 +===== Internal Inputs ===== 
 + 
 +^ Name  ^ Type  ^ Description ​ ^ 
 +| Condition ​ | [[Boolean Value Type]] ​ | Current value of the condition that keeps the loop running. ​ |
  
 ===== Group ===== ===== Group =====
  
 [[Functor List#​Control | Control]] [[Functor List#​Control | Control]]
 +
 +===== Notes =====
 +
 +This container has no condition port of its own. Place a [[Set While Condition]] functor inside it and connect its output to decide whether the loop keeps running.
 +
 +Because the content always executes at least once, a result it produces can be used directly outside the container, with no need for a junction.
  
 ===== Internal Name ===== ===== Internal Name =====
  
-doWhile+DoWhile