TraceMaker
C++ API of the engine
Loading...
Searching...
No Matches
tmk::advice::StuckInput Struct Reference

#include <advice/stuck_report.hpp>

Public Attributes

const model::Board * board = nullptr
const model::DesignRules * rules = nullptr
const route::RouteResult * result = nullptr
std::string board_name
 the file name, no path
double seconds = 0
 wall time of the run that produced the result
nlohmann::json variants
 rows {"variant", "name", "routed", "seconds"} of that run; null = none
nlohmann::json previous_advice
 the report of advice already tried (Applied::report) with its outcome; null = none
bool redact = false
 aliases for net and part names; no part values or library ids
int max_unrouted = 40
 the longest unrouted list sent (the rest are counted)
double region_margin_mm = 1.5
 around the two pads of a connection: the region whose crowding is described
bool escape_analysis = true
 Escape analysis of the dense packages (route/escape.hpp, the escape command): which pins cannot leave their package at all under the board's rules, and the analysis's own hint.
bool soft_zones = false
double vias_off_pads_below_mm = 0

Detailed Description

Definition at line 21 of file stuck_report.hpp.

Member Data Documentation

◆ board

const model::Board* tmk::advice::StuckInput::board = nullptr

Definition at line 22 of file stuck_report.hpp.

◆ board_name

std::string tmk::advice::StuckInput::board_name

the file name, no path

Definition at line 25 of file stuck_report.hpp.

◆ escape_analysis

bool tmk::advice::StuckInput::escape_analysis = true

Escape analysis of the dense packages (route/escape.hpp, the escape command): which pins cannot leave their package at all under the board's rules, and the analysis's own hint.

Cheap (0.2 s on a 163-ball array). Run with the same obstacle options as the route.

Definition at line 34 of file stuck_report.hpp.

◆ max_unrouted

int tmk::advice::StuckInput::max_unrouted = 40

the longest unrouted list sent (the rest are counted)

Definition at line 30 of file stuck_report.hpp.

◆ previous_advice

nlohmann::json tmk::advice::StuckInput::previous_advice

the report of advice already tried (Applied::report) with its outcome; null = none

Definition at line 28 of file stuck_report.hpp.

◆ redact

bool tmk::advice::StuckInput::redact = false

aliases for net and part names; no part values or library ids

Definition at line 29 of file stuck_report.hpp.

◆ region_margin_mm

double tmk::advice::StuckInput::region_margin_mm = 1.5

around the two pads of a connection: the region whose crowding is described

Definition at line 31 of file stuck_report.hpp.

◆ result

const route::RouteResult* tmk::advice::StuckInput::result = nullptr

Definition at line 24 of file stuck_report.hpp.

◆ rules

const model::DesignRules* tmk::advice::StuckInput::rules = nullptr

Definition at line 23 of file stuck_report.hpp.

◆ seconds

double tmk::advice::StuckInput::seconds = 0

wall time of the run that produced the result

Definition at line 26 of file stuck_report.hpp.

◆ soft_zones

bool tmk::advice::StuckInput::soft_zones = false

Definition at line 35 of file stuck_report.hpp.

◆ variants

nlohmann::json tmk::advice::StuckInput::variants

rows {"variant", "name", "routed", "seconds"} of that run; null = none

Definition at line 27 of file stuck_report.hpp.

◆ vias_off_pads_below_mm

double tmk::advice::StuckInput::vias_off_pads_below_mm = 0

Definition at line 36 of file stuck_report.hpp.


The documentation for this struct was generated from the following file: