Differences

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

Link to this comparison view

select_string [2020/04/29 12:01]
argemiro created 		select_string [2026/08/28 03:33] (current)
hermann Sync from local documentation review
Line 1: Line 1:
-====== Select String ====== ​+====== Select String ======
  
 ===== Description ===== ===== Description =====
  
-Pick up a string ​from a series of strings.+This container picks a string ​out of a series of strings ​identified by [[Number String]] functors placed inside it, using an index to choose among them.
  
 ===== Inputs ===== ===== Inputs =====
Line 12: Line 12:
  
 ^ Name  ^ Type  ^ Description ​ ^ Default Value  ^ ^ Name  ^ Type  ^ Description ​ ^ Default Value  ^
-| Step | [[positive_integer_value_type|Positive Integer Value]] ​ | Current index, step or model iteration. |+| Step  | [[Positive Integer Value Type]]  | Current index, step, or model iteration, used to pick the string. When this functor is placed inside a loop container, this port connects to that container'​s current step automatically. ​ | Provided automatically  ​|
  
-===== Output ​=====+===== Outputs ​=====
  
 ^ Name  ^ Type  ^ Description ​ ^ ^ Name  ^ Type  ^ Description ​ ^
-| String| [[string_type|String]] ​ | String |+| String ​ | [[String ​Type]]  | String ​picked out of those present in the series.  ​|
  
 ===== Group ===== ===== Group =====
Line 25: Line 25:
 ===== Notes ===== ===== Notes =====
  
-None.+The string selected is the one identified with the greatest index that is still less than or equal to Step. 
 + 
 +Strings are identified using an index assigned by a [[Number String]] functor placed inside this container. 
 + 
 +This container must hold at least one [[Number String]] instance; otherwise the model raises an error. If Step is smaller than every index assigned inside the container, the model also raises an error.
  
 ===== Internal Name ===== ===== Internal Name =====
  
 SelectString SelectString
 +