====== Sub Table ======

===== Description =====

Registers a table as the sub-table identified by a given chain of keys, within the named set of sub-tables managed by the enclosing [[Table Manager]].

===== Inputs =====

^ Name  ^ Type  ^ Description  ^
| Table Name  | [[Name Type]]  | Name of the set of sub-tables, within the table manager, that this sub-table belongs to.  |
| Sub Table  | [[Table Type]]  | The sub-table.  |
| Keys  | [[Tuple Type]]  | Chain of keys used to identify the sub-table.  |

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

^ Name  ^ Type  ^ Description  ^ Default Value  ^
| Empty Sub Table Is Allowed  | [[Boolean Value Type]]  | If true, an empty table can be passed as Sub Table without this functor reporting an error. This is an advanced port.  | True  |
| 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  ^
| Object  | [[Table Type]]  | The sub-table's value.  |

===== Group =====

[[Functor List#Table | Table]]

===== Notes =====

This functor must be placed inside a [[Table Manager]] container, which supplies the Table Manager port automatically.

Sub-tables registered under the same Table Name, distinguished by their Keys, are later combined into a single table by [[Merge Sub Tables]].

===== Internal Name =====

SubTable