ores.cpp.convention-family
Table of Contents
This page is the node for the ores.cpp.convention-family facet of the
codegen template library, part of the ores.cpp technical space. Each archetype
below is documented, and holds its mustache source, in its own
linked page.
1. Summary
A convention family is an entity model that declares #+convention_family:.
This facet renders, for each such entity that opts in, one translation unit
holding that family's two functions: the apply of one staged payload and the
read of its live rows as payloads. The unit decodes and serialises the
family's own type and no other, so no translation unit of the conventions
service instantiates the serialisation of two families. That is the budget the
check_translation_unit_budget gate holds.
The facet is opt-in per entity, with
:ores.cpp.convention-family.enabled: true in the model's property drawer. The
family facts the template reads are the registry's, so the unit agrees with
the registry header and the dispatch by construction.
2. Mustache incantations
The archetype reads one context, convention_unit, which the generator builds
only for this facet's template. It carries the family's key, entity,
domain_type and the is_party, is_by_id and is_world flags of its write
mode.
3. Archetypes
| Archetype | Description |
|---|---|
| ores.cpp.convention-family.unit | The apply and payload-read functions of one convention family, in a translation unit of their own. |
4. See also
- ores.cpp — the parent technical space's generated facet/archetype catalogue and shared Mustache conventions.
- ores.cpp.convention-registry — the component-level registry, units header and dispatch.