# essim API reference

Auto-generated from Doxygen comments in `src/`. Regenerate with
`cmake --build build --target doc`. See [doc/README.md](../README.md)
for the toolchain.

- [Classes & Structs](classes/index.md) — 24 entries
- [Source Files](files/index.md) — 51 entries

## Curated reading order

Start with the domain model, then importers, then the TUI:

1. [`System`](classes/System.md) — owns Modules + Connections.
2. [`Module`](classes/Module.md) → [`Part`](classes/Part.md) → [`Pin`](classes/Pin.md) → [`Signal`](classes/Signal.md) — ownership chain.
3. [`Connection`](classes/Connection.md) — cross-module wiring with `pin_map`.
4. [`Transform`](classes/Transform.md) / [`IdentityTransform`](classes/IdentityTransform.md) — connector-pair → pin pairs.
5. [`ImportBase`](classes/ImportBase.md) → [`ImportMentor`](classes/ImportMentor.md), [`ImportAltium`](classes/ImportAltium.md), [`ImportOds`](classes/ImportOds.md) — netlist parsers.
6. [`Tui`](classes/Tui.md) — interactive shell + screen orchestration.