Differences

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

Link to this comparison view

Both sides previous revision Previous revision
save_lookup_table [2015/10/13 01:50]
admin
save_lookup_table [2026/08/28 03:32] (current)
hermann Sync from local documentation review
Line 1: Line 1:
-====== Save Lookup Table ====== ​+====== Save Lookup Table ======
  
 ===== Description ===== ===== Description =====
  
-This functor saves a lookup table into a file. The file name and its path must be specified.+Saves a lookup table to a file. The file format is determined automatically from the filename'​s extension.
  
- ===== Inputs =====+===== Inputs =====
  
 ^ Name  ^ Type  ^ Description ​ ^ ^ Name  ^ Type  ^ Description ​ ^
-| Table  | [[Lookup Table Type]] ​ | The lookup ​table to be saved.  | +| Table  | [[Lookup Table Type]] ​ | Lookup ​table that will be written to the file.  | 
-| Filename ​ | [[Lookup Table Filename Type]] ​ | Name of the file where the lookup table will be savedDinamica automatically determines ​the file format from a selected file extension (only two column ​CSV comma separated ​value formatis accepted).  |+| Filename ​ | [[Lookup Table Filename Type]] ​ | Name and path of the file where the lookup table will be writtenIf no path is given, ​the file is located relative to the model script. Only 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 Integer Value Type]] ​ | Number of digits used in the file name suffix ​to represent ​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 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]] ​ | 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  |
  
 ===== Outputs ===== ===== Outputs =====
Line 24: Line 24:
 ===== Group ===== ===== Group =====
  
-[[Functor List#​Input/​Output | Input/​Output]]+[[Functor List#Input / Output | Input / Output]]
  
 ===== Notes ===== ===== Notes =====
  
-None.+Only the CSV (comma-separated values) file format is supported. 
 + 
 +If Step is .none, the saved filename has no numeric suffix.
  
-===== Internal Name ===== +===== Internal Name =====
  
 SaveLookupTable SaveLookupTable