Differences

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

Link to this comparison view

Next revision 		Previous revision
step [2011/07/31 21:30]
hermann created 		step [2026/08/28 03:35] (current)
hermann Sync from local documentation review
Line 1: Line 1:
-====== Step ====== ​+====== Step ======
  
 ===== Description ===== ===== Description =====
  
-This functor receives ​and passes on the current ​model step or iteration.+Receives ​and passes on the current step or iteration ​of the innermost loop container holding this functor.
  
 ===== Inputs ===== ===== Inputs =====
 +
 +None.
  
 ===== Optional Inputs ===== ===== Optional Inputs =====
  
-^ Name ^ Type ^ Description ^ Default Value ^ +^ Name  ^ Type  ^ Description ​ ^ Default Value  ^ 
-| Step  | [[Non Negative Int Type|Non Negative Int]]  | Current step or model iteration. ​ | 0  |+| Step  | [[Real Value Type]] ​ | Current step or model iteration. When this functor is placed inside a loop container, this port connects to that container'​s current step automatically.  | Provided automatically ​ |
  
 ===== Outputs ===== ===== Outputs =====
  
-^ Name ^ Type ^ Description ^ +^ Name  ^ Type  ^ Description ​ ^ 
-| Step  | [[Non Negative Int Type|Non Negative Int]]  | Current step or model iteration. ​ |+| Step  | [[Real Value Type]] ​ | Current step or model iteration. ​ |
  
 ===== Group ===== ===== Group =====
Line 21: Line 23:
 [[Functor List#​Control | Control]] [[Functor List#​Control | Control]]
  
-===== Notes ===== +===== Notes =====
  
-If not connected this functor ​is auto-associable ​to its wrapping ​container+This functor ​should be placed directly or indirectly inside a loop container. Placing it outside any loop container, connecting Step to a functor that is not a loop container, or setting Step to a fixed constant, all report a warning.
  
-===== Internal Name ===== +===== Internal Name =====
  
 Step Step