|
TraceMaker
C++ API of the engine
|
Files | |
| catalogue.hpp | |
| Component-rule catalogue (design doc 15 §6.1): categories of components with their detectors, roles and layout rules. | |
| critical.hpp | |
| Critical nets, from what the board's parts are (issue #24, docs/05-routing.md §44, D117). | |
| detect.hpp | |
| Category detection and role binding (design doc 15 §3): each footprint is scored against every category's detectors (integer weights, confidence = min(100, sum)); a category instance is the anchor footprint plus the parts, pads and nets that play each role. | |
| engine.hpp | |
| From detected instances to effective rules and engine inputs (design doc 15 §3.5, §5.5, §7): evaluate -> every catalogue rule of every instance, tagged applied / satisfied-by-board / not-applied(reason) / advisory, with a measured value where TraceMaker can measure it; compile -> placement pseudo-nets (pad pairs), keep-out rule areas for the router and DRC, and a sidecar .kicad_dru with the generated custom rules; report -> the text and JSON the user sees. | |
| impedance.hpp | |
| Closed-form transmission-line impedance for PCB traces (design doc 15 §5.3) and the IPC-2221 width for current (§5.4). | |
| impedance_rules.hpp | |
| Impedance and current rules on a real board (design doc 15 §5.3-5.4, P4): the board stackup gives, per routing layer, the line structure and the dielectric to the nearest reference layer; the closed forms of impedance.hpp turn a rule's target (z0_ohm / zdiff_ohm) into a width and gap. | |
| names.hpp | |
| Name conventions used to recognise parts and nets (doc 15 §3.1): reference letters, power and ground net names, natural sort of references, component values. | |
| overrides.hpp | |
| The user override file (design doc 15 §3.5 level 1, §6.3): the user disables rules, forces or forbids a category on a part, or changes a rule parameter. | |
| topology.hpp | |
| Netlist views of a board for component recognition (doc 15 §3.1 "Topology", §8.0 topology detectors): pads per net, nets per footprint, part kinds from reference letters, and the decoupling-capacitor ties of decision D25. | |