TraceMaker
C++ API of the engine
Loading...
Searching...
No Matches
tmk::route::RouterOptions::AdviceSet Struct Reference

Hints from an advice file (src/advice, doc 17). More...

#include <route/router.hpp>

Public Member Functions

bool active () const

Public Attributes

std::string source
 the advice file, for messages
std::vector< std::pair< std::string, std::string > > priority
 "REF.NUM" pairs routed first (as RouterOptions::priority)
std::vector< std::string > first_nets
 as RouterOptions::first_nets
model::LayerMask no_track_layers = 0
 added to RouterOptions::no_track_layers
std::vector< std::int32_t > layer_cost_pm
 per copper layer, per mille (1000 or more); replaces entries that are lower
std::vector< model::Zone > zones
 regions: rule areas (no keep-out flags) ...
std::vector< model::CustomRule > rules
 ... and the disallow rules that name them and their nets
int variants = 4
 advised variants added to the portfolio (at most the variants that run)

Detailed Description

Hints from an advice file (src/advice, doc 17).

They are not applied to the variants the portfolio would run anyway: route_portfolio adds variants extra variants that carry them (the next ones of its list, the variants a plain run with that many more would have added), so the winner of the total order can only be better than without advice, never worse (rule 4).

Definition at line 237 of file router.hpp.

Member Function Documentation

◆ active()

bool tmk::route::RouterOptions::AdviceSet::active ( ) const
inline

Definition at line 246 of file router.hpp.

Member Data Documentation

◆ first_nets

std::vector<std::string> tmk::route::RouterOptions::AdviceSet::first_nets

as RouterOptions::first_nets

Definition at line 240 of file router.hpp.

◆ layer_cost_pm

std::vector<std::int32_t> tmk::route::RouterOptions::AdviceSet::layer_cost_pm

per copper layer, per mille (1000 or more); replaces entries that are lower

Definition at line 242 of file router.hpp.

◆ no_track_layers

model::LayerMask tmk::route::RouterOptions::AdviceSet::no_track_layers = 0

added to RouterOptions::no_track_layers

Definition at line 241 of file router.hpp.

◆ priority

std::vector<std::pair<std::string, std::string> > tmk::route::RouterOptions::AdviceSet::priority

"REF.NUM" pairs routed first (as RouterOptions::priority)

Definition at line 239 of file router.hpp.

◆ rules

std::vector<model::CustomRule> tmk::route::RouterOptions::AdviceSet::rules

... and the disallow rules that name them and their nets

Definition at line 244 of file router.hpp.

◆ source

std::string tmk::route::RouterOptions::AdviceSet::source

the advice file, for messages

Definition at line 238 of file router.hpp.

◆ variants

int tmk::route::RouterOptions::AdviceSet::variants = 4

advised variants added to the portfolio (at most the variants that run)

Definition at line 245 of file router.hpp.

◆ zones

std::vector<model::Zone> tmk::route::RouterOptions::AdviceSet::zones

regions: rule areas (no keep-out flags) ...

Definition at line 243 of file router.hpp.


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