#include <model/rules.hpp>

Public Member Functions
const NetClass &	default_class () const
const NetClass &	class_for (const std::string &net_name) const
	Effective net class for a net name (explicit assignment, then the first matching pattern, else Default).
const NetClass *	find_class (const std::string &name) const
std::vector< std::string >	classes_of (const std::string &net_name) const
	Names of every class that applies to a net (explicit assignments, then matching patterns), and "Default", which KiCad 10.0.6 counts in every net's effective class: the constituents hasNetclass() searches.
const TuningProfile *	profile_of (const NetClass &c) const
	The tuning profile a class names, if the project has one of that name.

Public Attributes
BoardMinimums	minimums
std::vector< NetClass >	classes
	classes[0] is "Default"
std::vector< std::pair< std::string, std::string > >	patterns
	(net-name pattern, class name), in file order
std::map< std::string, std::vector< std::string > >	assignments
	explicit net → class names
std::vector< CustomRule >	custom
std::map< std::string, std::string >	severities
	KiCad violation type -> error \| warning \| ignore.
std::vector< TuningProfile >	tuning_profiles
	KiCad 10 tuning profiles, as the project lists them.
bool	use_height_for_length = true
	KiCad's "Include stackup height in track length calculations" (on unless the project turns it off): vias add the stackup height between the layers they join to a net's length (drc/length.hpp, via_heights).
std::vector< std::string >	warnings
	anything that could not be interpreted

Detailed Description

Definition at line 110 of file rules.hpp.

Member Function Documentation

◆ class_for()

const NetClass & tmk::model::DesignRules::class_for ( const std::string & net_name ) const

Effective net class for a net name (explicit assignment, then the first matching pattern, else Default).

◆ classes_of()

std::vector< std::string > tmk::model::DesignRules::classes_of ( const std::string & net_name ) const

Names of every class that applies to a net (explicit assignments, then matching patterns), and "Default", which KiCad 10.0.6 counts in every net's effective class: the constituents hasNetclass() searches.

◆ default_class()

const NetClass & tmk::model::DesignRules::default_class ( ) const

inline

Definition at line 123 of file rules.hpp.

◆ find_class()

const NetClass * tmk::model::DesignRules::find_class ( const std::string & name ) const

◆ profile_of()

const TuningProfile * tmk::model::DesignRules::profile_of ( const NetClass & c ) const

inline

The tuning profile a class names, if the project has one of that name.

Definition at line 131 of file rules.hpp.

Member Data Documentation

◆ assignments

std::map<std::string, std::vector<std::string> > tmk::model::DesignRules::assignments

explicit net → class names

Definition at line 114 of file rules.hpp.

◆ classes

std::vector<NetClass> tmk::model::DesignRules::classes

classes[0] is "Default"

Definition at line 112 of file rules.hpp.

◆ custom

std::vector<CustomRule> tmk::model::DesignRules::custom

Definition at line 115 of file rules.hpp.

◆ minimums

BoardMinimums tmk::model::DesignRules::minimums

Definition at line 111 of file rules.hpp.

◆ patterns

std::vector<std::pair<std::string, std::string> > tmk::model::DesignRules::patterns

(net-name pattern, class name), in file order

Definition at line 113 of file rules.hpp.

◆ severities

std::map<std::string, std::string> tmk::model::DesignRules::severities

KiCad violation type -> error | warning | ignore.

Definition at line 116 of file rules.hpp.

◆ tuning_profiles

std::vector<TuningProfile> tmk::model::DesignRules::tuning_profiles

KiCad 10 tuning profiles, as the project lists them.

Definition at line 117 of file rules.hpp.

◆ use_height_for_length

bool tmk::model::DesignRules::use_height_for_length = true

KiCad's "Include stackup height in track length calculations" (on unless the project turns it off): vias add the stackup height between the layers they join to a net's length (drc/length.hpp, via_heights).

Definition at line 120 of file rules.hpp.

◆ warnings

std::vector<std::string> tmk::model::DesignRules::warnings

anything that could not be interpreted

Definition at line 121 of file rules.hpp.

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

model/rules.hpp

Public Member Functions

Public Attributes