Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
load_text_file [2017/01/30 14:54] francisco |
load_text_file [2026/08/28 03:25] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 3: | Line 3: | ||
| ===== Description ===== | ===== Description ===== | ||
| - | This functor loads a text from a file. The file name and its path must be specified. | + | Loads text from a file. |
| ===== Inputs ===== | ===== Inputs ===== | ||
| ^ Name ^ Type ^ Description ^ | ^ Name ^ Type ^ Description ^ | ||
| - | | Filename | [[Generic Filename Type]] | Name of the file that contains the strings to be loaded. Dinamica automatically determines the file format from a selected file extension. | | + | | Filename | [[Generic Filename Type]] | Name and path of the file to load. If no path is given, the file is located relative to the model script. | |
| ===== Optional Inputs ===== | ===== Optional Inputs ===== | ||
| ^ Name ^ Type ^ Description ^ Default Value ^ | ^ Name ^ Type ^ Description ^ Default Value ^ | ||
| - | | Suffix Digits | [[Non Negative Integer Value Type]] | Number of digits used to represent the image file name suffix. | 0 | | + | | Suffix Digits | [[Non Negative Integer Value Type]] | Number of digits used to render Step as a filename suffix. If Step needs more digits than this, it is used unmodified. If zero, no suffix is added. This is an advanced port. | 0 | |
| - | | Step | [[Non Negative Integer Value Type]] | Current step or model iteration. Files with the same name and numbered suffixes will be loaded sequentially according to the model step. | None | | + | | Step | [[Non Negative Integer Value Type]] | Current step or model iteration, appended to Filename as a numeric suffix; automatically bound to the innermost compatible container. This is an advanced port. | .none | |
| - | | Workdir | [[Workdir Type]] | Workdir folder path. | None | | + | | Workdir | [[Workdir Type]] | Work directory Filename is relative to; may be a folder or a Zip archive. When not bound, the directory containing the script is used. This is an advanced port. | .none | |
| - | ===== Output ===== | + | ===== Outputs ===== |
| ^ Name ^ Type ^ Description ^ | ^ Name ^ Type ^ Description ^ | ||
| - | | Text | [[String Type]] | The text loaded by the functor. | | + | | Text | [[String Type]] | Text loaded from the file. | |
| ===== Group ===== | ===== Group ===== | ||
| - | [[Functor List#Input/Output | Input/Output]] | + | [[Functor List#Input / Output | Input / Output]] |
| ===== Notes ===== | ===== Notes ===== | ||
| - | None. | + | If Step is .none, the loaded filename has no numeric suffix. |
| ===== Internal Name ===== | ===== Internal Name ===== | ||
| LoadTextFile | LoadTextFile | ||
| + | |||