Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
load_lookup_table [2011/07/31 18:12] hermann [Optional Inputs] |
load_lookup_table [2026/08/28 03:25] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Load Lookup Table ====== | + | ====== Load Lookup Table ====== |
| ===== Description ===== | ===== Description ===== | ||
| - | This functor loads a lookup table from a file. The file name and its path must be specified. | + | Loads a lookup table from a file. The file format is determined automatically from the filename's extension. |
| ===== Inputs ===== | ===== Inputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ | + | ^ Name ^ Type ^ Description ^ |
| - | | Filename | [[ Table Filename Type|Table Filename ]] | Name of the file that contains the lookup table to be loaded. Dinamica automatically determines the file format from a selected file extension (only two column CSV - comma separated value format, is accepted). | | + | | Filename | [[Lookup Table Filename Type]] | Name and path of the file to load. If no path is given, the file is located relative to the model script. Only two-column CSV (comma-separated values) format is accepted. | |
| ===== Optional Inputs ===== | ===== Optional Inputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ Default Value ^ | + | ^ Name ^ Type ^ Description ^ Default Value ^ |
| - | | Suffix Digits | [[Non Negative Int Type|Non Negative Int ]] | Number of digits used to represent the 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 Int Type|Non Negative Int ]] | 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]] | 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 ===== | ||
| - | ^ Name ^ Type ^ Description ^ | + | ^ Name ^ Type ^ Description ^ |
| - | | Table | [[ Lookup Table Type|Lookup Table ]] | The Lookup table loaded by the functor. | | + | | Table | [[Lookup Table Type]] | Lookup table loaded from the file. | |
| ===== 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 loaded filename has no numeric suffix. | ||
| + | |||
| + | It is possible to load lookup tables from [[wp>zip_(file_format)|Zip]] archives; Workdir may point directly to a Zip archive rather than a folder. See [[Useful Tips#loading_files_from_zip_files|this useful tip]] to know how to do it. | ||
| + | |||
| + | ===== Internal Name ===== | ||
| LoadLookupTable | LoadLookupTable | ||