Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
save_text_file [2017/01/30 14:50] francisco |
save_text_file [2026/08/28 03:32] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 3: | Line 3: | ||
| ===== Description ===== | ===== Description ===== | ||
| - | This functor saves a text into a file. The file name and its path must be specified. | + | Saves text to a file. |
| ===== Inputs ===== | ===== Inputs ===== | ||
| ^ Name ^ Type ^ Description ^ | ^ Name ^ Type ^ Description ^ | ||
| - | | Text | [[String Type]] | Strings to be saved. | | + | | Text | [[String Type]] | Text to be saved. | |
| - | | Filename | [[Generic Filename Type]] | Name of the file where the text will be saved. Dinamica automatically determines the file format from a selected file extension. | | + | | Filename | [[Generic Filename Type]] | Name and path of the file the text is saved to. | |
| ===== 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 in the file name suffix to represent a model step. If the number of digits is not sufficient to represent the current step, the functor automatically adds more digits. If the number of digits is equal to zero, Dinamica does not include a suffix in the file name. | 2 | | + | | 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. | 2 | |
| - | | Step | [[Non Negative Integer Value Type]] | Model step that produced the file. This port is automatically associated to a compatible port of a container that wraps this functor. | None | | + | | Step | [[Non Negative Integer Value Type]] | Model step that produced the file, 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 ===== |
| None. | None. | ||
| Line 24: | Line 24: | ||
| ===== Group ===== | ===== Group ===== | ||
| - | [[Functor List#Input/Output | Input/Output]] | + | [[Functor List#Input / Output | Input / Output]] |
| ===== Notes ===== | ===== Notes ===== | ||
| - | None. | + | If Step is .none, the saved filename has no numeric suffix. |
| ===== Internal Name ===== | ===== Internal Name ===== | ||
| SaveTextFile | SaveTextFile | ||
| + | |||