Differences

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

Link to this comparison view

merge_sub_tables [2020/04/29 14:09]
argemiro created 		merge_sub_tables [2026/08/28 03:27] (current)
hermann Sync from local documentation review
Line 1: Line 1:
-====== Merge Sub tables ​====== ​+====== Merge Sub Tables ​======
  
 ===== Description ===== ===== Description =====
  
-This functor merges ​sub tables ​into a single table.+Combines all sub-tables ​registered under a given name, within the enclosing [[Table Manager]], into Base Table.
  
 ===== Inputs ===== ===== Inputs =====
  
 ^ Name  ^ Type  ^ Description ​ ^ ^ Name  ^ Type  ^ Description ​ ^
-| Base Table| [[table_type|Table]] ​ | Table where the resulting ​combined ​sub-tables will be stored. | +| Base Table  | [[Table ​Type]]  | Table where the resulting ​combination of the sub-tables will be stored. ​ | 
-| Table Name| [[generic_name| ​Name]] ​ | Table name. |+| Table Name  | [[Name ​Type]]  | Name of the set of sub-tables, registered via [[Sub Table]], that will be combined.  |
  
 ===== Optional Inputs ===== ===== Optional Inputs =====
  
-^ Name  ^ Type  ^ Description ​ ^ +^ Name  ^ Type  ^ Description ​ ^ Default Value  ^ 
-| Allow Empty Sub tables| [[boolean_value_type|Boolean Value]] ​ | If false, ​Merge Sub Tables will report ​an error if no subtables ​are defined using given name. | +| Allow Names With No Associated ​Sub Tables  ​| [[Boolean Value Type]]  | If false, ​this functor reports ​an error when there are no sub-tables registered under Table Name. This is an advanced port.  | False  ​| 
-| Table Manager|  Table Manager ​ | This is internally linked by TableManager. | +| Table Manager  ​| [[Table Manager ​Type]] ​ ​| ​Table manager where the fragments and sub-tables ​corresponding to complete tables are kept. Automatically bound to the innermost enclosing ​[[Table Manager]] container. This is an advanced port.  | —  ​|
-| Allow Empty Sub tables| [[boolean_value_type|Boolean Value]]  | If false, Merge Sub Tables will report ​an error if no subtables are defined using given name. |+
  
-===== Output ​=====+===== Outputs ​=====
  
 ^ Name  ^ Type  ^ Description ​ ^ ^ Name  ^ Type  ^ Description ​ ^
-| Table| [[table_type|Table]] ​ | Table result ​|+| Table  | [[Table ​Type]]  | Table resulting from combining the registered sub-tables into Base Table.  ​|
  
 ===== Group ===== ===== Group =====
Line 29: Line 28:
 ===== Notes ===== ===== Notes =====
  
-None.+This functor must be placed inside a [[Table Manager]] container, which supplies the Table Manager port automatically. 
 + 
 +Each sub-table combined into the result must have been previously registered under the same Table Name by a [[Sub Table]] functor connected to the same table manager.
  
 ===== Internal Name ===== ===== Internal Name =====
  
-MergeSubtables+MergeSubTables