Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
save_table [2013/08/12 18:32] admin created |
save_table [2026/08/28 03:32] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Save Table ====== | + | ====== Save Table ====== |
| ===== Description ===== | ===== Description ===== | ||
| - | This functor saves a table into a file. The file name and its path must be specified. | + | Saves a table to a file. The file format is determined automatically from the filename's extension. |
| - | ===== Inputs ===== | + | ===== Inputs ===== |
| + | |||
| + | ^ Name ^ Type ^ Description ^ | ||
| + | | Table | [[Table Type]] | Table that will be written to the file. | | ||
| + | | Filename | [[Table Filename Type]] | Name and path of the file where the table will be written. If no path is given, the file is located relative to the model script. Only CSV (comma-separated values) format is accepted. | | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | Table | [[Table Type|Table]] | The table to be saved. | | ||
| - | | Filename | [[Table Filename Type|Table Filename]] | Name of the file where the table will be saved. Dinamica automatically determines the file format from a selected file extension (only multi-column CSV - comma separated value format, is accepted). | | ||
| ===== Optional Inputs ===== | ===== Optional Inputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ Default Value ^ | + | ^ Name ^ Type ^ Description ^ Default Value ^ |
| - | | Suffix Digits | [[Non Negative Type|Non Negative]] | 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 Int Type|Non Negative Int]] | 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]] | 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]] | 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 | |
| ===== Outputs ===== | ===== Outputs ===== | ||
| + | |||
| + | None. | ||
| ===== Group ===== | ===== Group ===== | ||
| - | [[Functor List#Input/Output | Input/Output]] | + | [[Functor List#Input / Output | Input / Output]] |
| ===== Notes ===== | ===== Notes ===== | ||
| - | ===== Internal Name ===== | + | Only the CSV (comma-separated values) file format is supported. |
| + | |||
| + | If Step is .none, the saved filename has no numeric suffix. | ||
| + | |||
| + | ===== Internal Name ===== | ||
| SaveTable | SaveTable | ||