====== Merge Sub Tables ======

===== Description =====

Combines all sub-tables registered under a given name, within the enclosing [[Table Manager]], into Base Table.

===== Inputs =====

^ Name  ^ Type  ^ Description  ^
| Base Table  | [[Table Type]]  | Table where the resulting combination of the sub-tables will be stored.  |
| Table Name  | [[Name Type]]  | Name of the set of sub-tables, registered via [[Sub Table]], that will be combined.  |

===== Optional Inputs =====

^ Name  ^ Type  ^ Description  ^ Default Value  ^
| 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 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.  | —  |

===== Outputs =====

^ Name  ^ Type  ^ Description  ^
| Table  | [[Table Type]]  | Table resulting from combining the registered sub-tables into Base Table.  |

===== Group =====

[[Functor List#Table | Table]]

===== Notes =====

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 =====

MergeSubTables