#include <analysis/return_path.hpp>

Public Attributes
std::vector< std::string >	name_patterns
	Which nets: a signal is analysed if it matches any selector (default: none, the pass is off). Name patterns are KiCad wildcards.
std::vector< std::string >	net_classes
std::vector< std::pair< model::NetId, model::NetId > >	pair_nets
	differential pairs, resolved by the caller (route::named_pairs)
bool	diff_pairs = false
	analyse the halves of pair_nets
std::vector< std::pair< std::string, std::string > >	reference_layers
	"PATTERN=LAYER": the reference layer of the nets that match, instead of the adjacent layer with the most copper under the trace.
double	stitch_radius_mm = 5.0
	how far a stitching via or a capacitor may be from a layer change
double	sample_mm = 0.05
	spacing of the samples along a trace
double	min_void_mm = 0.1
	a stretch without copper shorter than this is a sampling artefact, not a void
double	warn_detour_mm = 2.0
	thresholds: warnings, not DRC errors
double	warn_separation_mm = 1.0
bool	refill = true
	zones without fills are refilled first (the engine's refill, not KiCad's)
bool	refill_always = false
	refill every zone: the fills in the file predate copper that was just routed

Detailed Description

Definition at line 28 of file return_path.hpp.

Member Data Documentation

◆ diff_pairs

bool tmk::analysis::ReturnPathOptions::diff_pairs = false

analyse the halves of pair_nets

Definition at line 33 of file return_path.hpp.

◆ min_void_mm

double tmk::analysis::ReturnPathOptions::min_void_mm = 0.1

a stretch without copper shorter than this is a sampling artefact, not a void

Definition at line 38 of file return_path.hpp.

◆ name_patterns

std::vector<std::string> tmk::analysis::ReturnPathOptions::name_patterns

Which nets: a signal is analysed if it matches any selector (default: none, the pass is off). Name patterns are KiCad wildcards.

Definition at line 30 of file return_path.hpp.

◆ net_classes

std::vector<std::string> tmk::analysis::ReturnPathOptions::net_classes

Definition at line 31 of file return_path.hpp.

◆ pair_nets

std::vector<std::pair<model::NetId, model::NetId> > tmk::analysis::ReturnPathOptions::pair_nets

differential pairs, resolved by the caller (route::named_pairs)

Definition at line 32 of file return_path.hpp.

◆ reference_layers

std::vector<std::pair<std::string, std::string> > tmk::analysis::ReturnPathOptions::reference_layers

"PATTERN=LAYER": the reference layer of the nets that match, instead of the adjacent layer with the most copper under the trace.

Definition at line 35 of file return_path.hpp.

◆ refill

bool tmk::analysis::ReturnPathOptions::refill = true

zones without fills are refilled first (the engine's refill, not KiCad's)

Definition at line 41 of file return_path.hpp.

◆ refill_always

bool tmk::analysis::ReturnPathOptions::refill_always = false

refill every zone: the fills in the file predate copper that was just routed

Definition at line 42 of file return_path.hpp.

◆ sample_mm

double tmk::analysis::ReturnPathOptions::sample_mm = 0.05

spacing of the samples along a trace

Definition at line 37 of file return_path.hpp.

◆ stitch_radius_mm

double tmk::analysis::ReturnPathOptions::stitch_radius_mm = 5.0

how far a stitching via or a capacitor may be from a layer change

Definition at line 36 of file return_path.hpp.

◆ warn_detour_mm

double tmk::analysis::ReturnPathOptions::warn_detour_mm = 2.0

thresholds: warnings, not DRC errors

Definition at line 39 of file return_path.hpp.

◆ warn_separation_mm

double tmk::analysis::ReturnPathOptions::warn_separation_mm = 1.0

Definition at line 40 of file return_path.hpp.

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

analysis/return_path.hpp

Public Attributes