TraceMaker
C++ API of the engine
Loading...
Searching...
No Matches
inspect.hpp
Go to the documentation of this file.
1// SPDX-License-Identifier: GPL-3.0-or-later
2#pragma once
3#include <string>
4
5#include "model/board.hpp"
6#include "model/rules.hpp"
7
8namespace tmk::app {
9// Prints a human-readable board summary.
10void print_summary(const model::Board& b, const std::string& path);
11// Writes the board in the same JSON schema as scripts/kicad_truth.py, for comparison with KiCad.
12void write_truth_json(const model::Board& b, const std::string& out_path, const model::DesignRules* rules = nullptr);
13} // namespace tmk::app
board.hpp
The board model (design doc 02 §3): every object TraceMaker reads from a .kicad_pcb,...
tmk::app::print_summary
void print_summary(const model::Board &b, const std::string &path)
Prints a human-readable board summary.
tmk::app::write_truth_json
void write_truth_json(const model::Board &b, const std::string &out_path, const model::DesignRules *rules=nullptr)
Writes the board in the same JSON schema as scripts/kicad_truth.py, for comparison with KiCad.
rules.hpp
Design rules as KiCad defines them (design doc 08 §3–4): board minimums and net classes from the ....