DRC_ENGINE Class Reference

Design Rule Checker object that performs all the DRC tests. More...

#include <drc_engine.h>

Inheritance diagram for DRC_ENGINE:

Classes
struct	DRC_ENGINE_CONSTRAINT

Public Member Functions
	DRC_ENGINE (BOARD *aBoard=nullptr, BOARD_DESIGN_SETTINGS *aSettings=nullptr)
virtual	~DRC_ENGINE ()
	DRC_ENGINE (const DRC_ENGINE &)=delete
DRC_ENGINE &	operator= (const DRC_ENGINE &)=delete
void	SetBoard (BOARD *aBoard)
BOARD *	GetBoard () const
void	SetDesignSettings (BOARD_DESIGN_SETTINGS *aSettings)
BOARD_DESIGN_SETTINGS *	GetDesignSettings () const
void	SetSchematicNetlist (NETLIST *aNetlist)
NETLIST *	GetSchematicNetlist () const
void	SetDrawingSheet (DS_PROXY_VIEW_ITEM *aDrawingSheet)
DS_PROXY_VIEW_ITEM *	GetDrawingSheet () const
void	SetDebugOverlay (std::shared_ptr< KIGFX::VIEW_OVERLAY > aOverlay)
std::shared_ptr< KIGFX::VIEW_OVERLAY >	GetDebugOverlay () const
void	SetViolationHandler (DRC_VIOLATION_HANDLER aHandler)
	Set an optional DRC violation handler (receives DRC_ITEMs and positions).
void	ClearViolationHandler ()
void	SetProgressReporter (PROGRESS_REPORTER *aProgRep)
	Set an optional reporter for user-level progress info.
PROGRESS_REPORTER *	GetProgressReporter () const
void	SetLogReporter (REPORTER *aReporter)
void	InitEngine (const wxFileName &aRulePath)
	Initialize the DRC engine.
void	RunTests (EDA_UNITS aUnits, bool aReportAllTrackErrors, bool aTestFootprints, BOARD_COMMIT *aCommit=nullptr)
	Run the DRC tests.
bool	IsErrorLimitExceeded (int error_code)
DRC_CONSTRAINT	EvalRules (DRC_CONSTRAINT_T aConstraintType, const BOARD_ITEM *a, const BOARD_ITEM *b, PCB_LAYER_ID aLayer, REPORTER *aReporter=nullptr)
DRC_CONSTRAINT	EvalZoneConnection (const BOARD_ITEM *a, const BOARD_ITEM *b, PCB_LAYER_ID aLayer, REPORTER *aReporter=nullptr)
void	ProcessAssertions (const BOARD_ITEM *a, std::function< void(const DRC_CONSTRAINT *)> aFailureHandler, REPORTER *aReporter=nullptr)
bool	HasRulesForConstraintType (DRC_CONSTRAINT_T constraintID)
bool	GetReportAllTrackErrors () const
bool	GetTestFootprints () const
bool	RulesValid ()
void	ReportViolation (const std::shared_ptr< DRC_ITEM > &aItem, const VECTOR2I &aPos, int aMarkerLayer, DRC_CUSTOM_MARKER_HANDLER *aCustomHandler=nullptr)
bool	KeepRefreshing (bool aWait=false)
void	AdvanceProgress ()
void	SetMaxProgress (int aSize)
bool	ReportProgress (double aProgress)
bool	ReportPhase (const wxString &aMessage)
bool	IsCancelled () const
REPORTER *	GetLogReporter () const
bool	QueryWorstConstraint (DRC_CONSTRAINT_T aRuleId, DRC_CONSTRAINT &aConstraint)
std::set< int >	QueryDistinctConstraints (DRC_CONSTRAINT_T aConstraintId)
std::vector< DRC_TEST_PROVIDER * >	GetTestProviders () const
DRC_TEST_PROVIDER *	GetTestProvider (const wxString &name) const
std::vector< BOARD_ITEM * >	GetItemsMatchingCondition (const wxString &aExpression, DRC_CONSTRAINT_T aConstraint=ASSERTION_CONSTRAINT, REPORTER *aReporter=nullptr)
	Evaluate a DRC condition against all board items and return matches.
bool	IsNetTieExclusion (int aTrackNetCode, PCB_LAYER_ID aTrackLayer, const VECTOR2I &aCollisionPos, BOARD_ITEM *aCollidingItem)
	Check if the given collision between a track and another item occurs during the track's entry into a net-tie pad.
EDA_UNITS	GetUserUnits () const
void	SetUserUnits (EDA_UNITS aUnits)
virtual void	GetUnitPair (EDA_UNITS &aPrimaryUnit, EDA_UNITS &aSecondaryUnits)
const EDA_IU_SCALE &	GetIuScale () const
virtual ORIGIN_TRANSFORMS &	GetOriginTransforms ()
wxString	StringFromValue (double aValue, bool aAddUnitLabel=false, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
	Converts aValue in internal units into a united string.
wxString	StringFromValue (const EDA_ANGLE &aValue, bool aAddUnitLabel=false) const
wxString	StringFromOptionalValue (std::optional< int > aValue, bool aAddUnitLabel=false, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
	Converts an optional aValue in internal units into a united string.
wxString	MessageTextFromValue (double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
	A lower-precision version of StringFromValue().
wxString	MessageTextFromValue (const EDA_ANGLE &aValue, bool aAddUnitLabel=true) const
wxString	MessageTextFromMinOptMax (const MINOPTMAX< int > &aValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
int	ValueFromString (const wxString &aTextValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
	Converts aTextValue in aUnits to internal units used by the frame.
std::optional< int >	OptionalValueFromString (const wxString &aTextValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
	Converts aTextValue in aUnits to internal units used by the frame.
EDA_ANGLE	AngleValueFromString (const wxString &aTextValue) const
EDA_UNITS	GetUnitsFromType (EDA_DATA_TYPE aType) const
	Gets the units to use in the conversion based on the underlying user units.

Static Public Member Functions
static bool	IsNetADiffPair (BOARD *aBoard, NETINFO_ITEM *aNet, int &aNetP, int &aNetN)
static int	MatchDpSuffix (const wxString &aNetName, wxString &aComplementNet, wxString &aBaseDpName)
	Check if the given net is a diff pair, returning its polarity and complement if so.
static EDA_DATA_TYPE	GetTypeFromUnits (const EDA_UNITS aUnits)
	Gets the inferred type from the given units.

Static Public Attributes
static const wxString	NullUiString = ""
	The string that is used in the UI to represent a null value.

Protected Attributes
BOARD_DESIGN_SETTINGS *	m_designSettings
BOARD *	m_board
DS_PROXY_VIEW_ITEM *	m_drawingSheet
NETLIST *	m_schematicNetlist
std::vector< std::shared_ptr< DRC_RULE > >	m_rules
bool	m_rulesValid
std::vector< DRC_TEST_PROVIDER * >	m_testProviders
std::vector< int >	m_errorLimits
bool	m_reportAllTrackErrors
bool	m_testFootprints
std::map< DRC_CONSTRAINT_T, std::vector< DRC_ENGINE_CONSTRAINT * > * >	m_constraintMap
DRC_VIOLATION_HANDLER	m_violationHandler
REPORTER *	m_logReporter
PROGRESS_REPORTER *	m_progressReporter
std::shared_ptr< KIGFX::VIEW_OVERLAY >	m_debugOverlay

Private Member Functions
void	addRule (std::shared_ptr< DRC_RULE > &rule)
void	loadRules (const wxFileName &aPath)
	Load and parse a rule set from an sexpr text file.
void	compileRules ()
void	loadImplicitRules ()
std::shared_ptr< DRC_RULE >	createImplicitRule (const wxString &name)

Private Attributes
const EDA_IU_SCALE &	m_iuScale
EDA_UNITS	m_userUnits

Friends
class	DRC_TEST_PROVIDER_CLEARANCE_BASE
class	DRC_TEST_PROVIDER_CREEPAGE

Detailed Description

Design Rule Checker object that performs all the DRC tests.

Optionally reports violations via a DRC_VIOLATION_HANDLER, user-level progress via a PROGRESS_REPORTER and rule parse errors via a REPORTER, all set through various setter calls.

Note that EvalRules() has yet another optional REPORTER for reporting resolution info to the user.

Definition at line 84 of file drc_engine.h.

Constructor & Destructor Documentation

DRC_ENGINE() [1/2]

DRC_ENGINE::DRC_ENGINE	(	BOARD *	aBoard = nullptr,
		BOARD_DESIGN_SETTINGS *	aSettings = nullptr
	)

Definition at line 79 of file drc_engine.cpp.

References DRCE_FIRST, DRCE_LAST, ERROR_LIMIT, and m_errorLimits.

~DRC_ENGINE()

DRC_ENGINE::~DRC_ENGINE ( )

virtual

Definition at line 98 of file drc_engine.cpp.

References m_constraintMap, and m_rules.

DRC_ENGINE() [2/2]

DRC_ENGINE::DRC_ENGINE ( const DRC_ENGINE &  )

delete

Member Function Documentation

addRule()

void DRC_ENGINE::addRule ( std::shared_ptr< DRC_RULE > &  rule )

inlineprivate

Definition at line 229 of file drc_engine.h.

References m_rules.

Referenced by createImplicitRule(), and loadImplicitRules().

AdvanceProgress()

void DRC_ENGINE::AdvanceProgress

(

)

Definition at line 1828 of file drc_engine.cpp.

References PROGRESS_REPORTER::AdvanceProgress(), and m_progressReporter.

AngleValueFromString()

EDA_ANGLE UNITS_PROVIDER::AngleValueFromString ( const wxString &  aTextValue ) const

inlineinherited

Definition at line 186 of file units_provider.h.

References DEGREES_T, EDA_UNIT_UTILS::UI::DoubleValueFromString(), and UNITS_PROVIDER::GetIuScale().

Referenced by PROPERTIES_FRAME::CopyPrmsFromPanelToItem(), and PCB_FIELDS_GRID_TABLE::SetValue().

ClearViolationHandler()

void DRC_ENGINE::ClearViolationHandler ( )

inline

Definition at line 126 of file drc_engine.h.

References m_violationHandler.

compileRules()

void DRC_ENGINE::compileRules ( )

private

Definition at line 527 of file drc_engine.cpp.

References DRC_RULE_CONDITION::Compile(), DRC_ENGINE::DRC_ENGINE_CONSTRAINT::condition, DRC_ENGINE::DRC_ENGINE_CONSTRAINT::constraint, DRC_ENGINE::DRC_ENGINE_CONSTRAINT::layerTest, m_constraintMap, m_logReporter, m_rules, DRC_CONSTRAINT::m_Type, DRC_ENGINE::DRC_ENGINE_CONSTRAINT::parentRule, and REPORTER::Report().

Referenced by InitEngine().

createImplicitRule()

std::shared_ptr< DRC_RULE > DRC_ENGINE::createImplicitRule ( const wxString &  name )

private

Definition at line 141 of file drc_engine.cpp.

References addRule(), and name.

Referenced by loadImplicitRules().

EvalRules()

DRC_CONSTRAINT DRC_ENGINE::EvalRules	(	DRC_CONSTRAINT_T	aConstraintType,
		const BOARD_ITEM *	a,
		const BOARD_ITEM *	b,
		PCB_LAYER_ID	aLayer,
		REPORTER *	aReporter = nullptr
	)

Definition at line 706 of file drc_engine.cpp.

References _, ANNULAR_WIDTH_CONSTRAINT, ASSERTION_CONSTRAINT, B_CrtYd, LSET::BackMask(), clearance, CLEARANCE_CONSTRAINT, CONNECTION_WIDTH_CONSTRAINT, COURTYARD_CLEARANCE_CONSTRAINT, CREEPAGE_CONSTRAINT, DIFF_PAIR_GAP_CONSTRAINT, DISALLOW_CONSTRAINT, DRC_DISALLOW_BB_VIAS, DRC_DISALLOW_FOOTPRINTS, DRC_DISALLOW_GRAPHICS, DRC_DISALLOW_HOLES, DRC_DISALLOW_MICRO_VIAS, DRC_DISALLOW_PADS, DRC_DISALLOW_TEXTS, DRC_DISALLOW_TRACKS, DRC_DISALLOW_VIAS, DRC_DISALLOW_ZONES, EDGE_CLEARANCE_CONSTRAINT, EscapeHTML(), F_CrtYd, LSET::FrontMask(), BOARD_CONNECTED_ITEM::GetClearanceOverrides(), FOOTPRINT::GetCourtyard(), BOARD::GetEnabledLayers(), EDA_ITEM::GetFlags(), EDA_ITEM::GetItemDescription(), FOOTPRINT::GetItemDescription(), ZONE::GetItemDescription(), BOARD_ITEM::GetLayerSet(), BOARD_CONNECTED_ITEM::GetLocalClearance(), PCB_SHAPE::GetLocalSolderMaskMargin(), FOOTPRINT::GetLocalZoneConnection(), ZONE::GetMinThickness(), FOOTPRINT::GetNetTieCache(), ZONE::GetPadConnection(), BOARD_ITEM::GetParentFootprint(), DRC_CONSTRAINT::GetParentRule(), ZONE::GetThermalReliefGap(), ZONE::GetThermalReliefSpokeWidth(), BOARD_ITEM::HasDrilledHole(), HOLE_CLEARANCE_CONSTRAINT, HOLE_PROXY, HOLE_SIZE_CONSTRAINT, HOLE_TO_HOLE_CONSTRAINT, BOARD_ITEM::IsConnected(), SHAPE_POLY_SET::IsEmpty(), isKeepoutZone(), BOARD_ITEM::IsOnCopperLayer(), KiROUND(), LENGTH_CONSTRAINT, m_board, m_constraintMap, m_designSettings, DRC_CONSTRAINT::m_DisallowFlags, BOARD_DESIGN_SETTINGS::m_HoleClearance, DRC_RULE::m_Implicit, DRC_CONSTRAINT::m_ImplicitMin, BOARD_DESIGN_SETTINGS::m_MinClearance, BOARD_DESIGN_SETTINGS::m_SolderMaskExpansion, BOARD_DESIGN_SETTINGS::m_SolderPasteMargin, BOARD_DESIGN_SETTINGS::m_SolderPasteMarginRatio, DRC_CONSTRAINT::m_Type, DRC_CONSTRAINT::m_Value, DRC_CONSTRAINT::m_ZoneConnection, MAX_UNCOUPLED_CONSTRAINT, MAXIMUM_CLEARANCE, EDA_UNIT_UTILS::UI::MessageTextFromValue(), UNITS_PROVIDER::MessageTextFromValue(), MINOPTMAX< T >::Min(), MIN_RESOLVED_SPOKES_CONSTRAINT, NULL_CONSTRAINT, pad, PCB_ARC_T, PCB_FIELD_T, PCB_FOOTPRINT_T, PCB_LOCATE_HOLE_T, PCB_PAD_T, PCB_SHAPE_T, PCB_TABLE_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, PHYSICAL_CLEARANCE_CONSTRAINT, PHYSICAL_HOLE_CLEARANCE_CONSTRAINT, PrintZoneConnection(), REPORT, MINOPTMAX< T >::SetMin(), DRC_CONSTRAINT::SetName(), MINOPTMAX< T >::SetOpt(), DRC_CONSTRAINT::SetOptionsFromOther(), DRC_CONSTRAINT::SetParentRule(), SILK_CLEARANCE_CONSTRAINT, SKEW_CONSTRAINT, SOLDER_MASK_EXPANSION_CONSTRAINT, SOLDER_PASTE_ABS_MARGIN_CONSTRAINT, SOLDER_PASTE_REL_MARGIN_CONSTRAINT, TEXT_HEIGHT_CONSTRAINT, TEXT_THICKNESS_CONSTRAINT, THERMAL_RELIEF_GAP_CONSTRAINT, THERMAL_SPOKE_WIDTH_CONSTRAINT, TRACK_WIDTH_CONSTRAINT, EDA_ITEM::Type(), UNDEFINED_LAYER, unityScale, VIA_DIAMETER_CONSTRAINT, and ZONE_CONNECTION_CONSTRAINT.

Referenced by DRC_TEST_PROVIDER_HOLE_SIZE::checkPadHole(), DRC_TEST_PROVIDER_HOLE_SIZE::checkViaHole(), EvalZoneConnection(), DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), DRC_TEST_PROVIDER_TRACK_ANGLE::Run(), DRC_TEST_PROVIDER_TRACK_SEGMENT_LENGTH::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_VIA_DIAMETER::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_CREEPAGE::testCreepage(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::testHoleAgainstHole(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testKnockoutTextAgainstZone(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_SOLDER_MASK::testSilkToMaskClearance(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testSingleLayerItemAgainstItem(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones().

EvalZoneConnection()

DRC_CONSTRAINT DRC_ENGINE::EvalZoneConnection	(	const BOARD_ITEM *	a,
		const BOARD_ITEM *	b,
		PCB_LAYER_ID	aLayer,
		REPORTER *	aReporter = nullptr
	)

Definition at line 672 of file drc_engine.cpp.

References _, EscapeHTML(), EvalRules(), DRC_CONSTRAINT::m_ZoneConnection, pad, PCB_PAD_T, PrintZoneConnection(), REPORT, EDA_ITEM::Type(), and ZONE_CONNECTION_CONSTRAINT.

GetBoard()

BOARD * DRC_ENGINE::GetBoard ( ) const

inline

Definition at line 100 of file drc_engine.h.

References m_board.

Referenced by DRC_TEST_PROVIDER::forEachGeometryItem(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::layerDesc(), DRC_TEST_PROVIDER_SLIVER_CHECKER::layerDesc(), DRC_CACHE_GENERATOR::Run(), DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::Run(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::Run(), DRC_TEST_PROVIDER_CREEPAGE::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_FOOTPRINT_CHECKS::Run(), DRC_TEST_PROVIDER_HOLE_SIZE::Run(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::Run(), DRC_TEST_PROVIDER_LIBRARY_PARITY::Run(), DRC_TEST_PROVIDER_MISC::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_SLIVER_CHECKER::Run(), DRC_TEST_PROVIDER_SOLDER_MASK::Run(), DRC_TEST_PROVIDER_TEXT_MIRRORING::Run(), DRC_TEST_PROVIDER_TRACK_ANGLE::Run(), DRC_TEST_PROVIDER_TRACK_SEGMENT_LENGTH::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_VIA_DIAMETER::Run(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), and DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer().

GetDebugOverlay()

std::shared_ptr< KIGFX::VIEW_OVERLAY > DRC_ENGINE::GetDebugOverlay ( ) const

inline

Definition at line 116 of file drc_engine.h.

References m_debugOverlay.

Referenced by test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run().

GetDesignSettings()

BOARD_DESIGN_SETTINGS * DRC_ENGINE::GetDesignSettings ( ) const

inline

Definition at line 103 of file drc_engine.h.

References m_designSettings.

Referenced by IsNetTieExclusion().

GetDrawingSheet()

DS_PROXY_VIEW_ITEM * DRC_ENGINE::GetDrawingSheet ( ) const

inline

Definition at line 109 of file drc_engine.h.

References m_drawingSheet.

Referenced by DRC_TEST_PROVIDER_MISC::testTextVars().

GetItemsMatchingCondition()

std::vector< BOARD_ITEM * > DRC_ENGINE::GetItemsMatchingCondition	(	const wxString &	aExpression,
		DRC_CONSTRAINT_T	aConstraint = ASSERTION_CONSTRAINT,
		REPORTER *	aReporter = nullptr
	)

Evaluate a DRC condition against all board items and return matches.

Parameters

aExpression	Expression to evaluate
aConstraint	Constraint context for expression evaluation
aReporter	Reporter for compile or evaluation errors

Definition at line 2038 of file drc_engine.cpp.

References DRC_RULE_CONDITION::Compile(), DRC_RULE_CONDITION::EvaluateFor(), BOARD::GetItemByIdCache(), BOARD::GetItemSet(), m_board, and m_logReporter.

GetIuScale()

const EDA_IU_SCALE & UNITS_PROVIDER::GetIuScale ( ) const

inlineinherited

Definition at line 55 of file units_provider.h.

References UNITS_PROVIDER::m_iuScale.

Referenced by UNITS_PROVIDER::AngleValueFromString(), GRID_MENU::BuildChoiceList(), RC_ITEM::GetJsonViolation(), UNITS_PROVIDER::MessageTextFromMinOptMax(), UNITS_PROVIDER::MessageTextFromValue(), UNIT_BINDER::onUnitsChanged(), PANEL_SETUP_BOARD_STACKUP::onUnitsChanged(), UNITS_PROVIDER::OptionalValueFromString(), PANEL_GRID_SETTINGS::RebuildGridSizes(), COMMON_TOOLS::Reset(), UNITS_PROVIDER::StringFromOptionalValue(), UNITS_PROVIDER::StringFromValue(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), GRID::UserUnitsMessageText(), and UNITS_PROVIDER::ValueFromString().

GetLogReporter()

REPORTER * DRC_ENGINE::GetLogReporter ( ) const

inline

Definition at line 189 of file drc_engine.h.

References m_logReporter.

Referenced by DRC_TEST_PROVIDER::getLogReporter().

GetOriginTransforms()

virtual ORIGIN_TRANSFORMS & UNITS_PROVIDER::GetOriginTransforms ( )

inlinevirtualinherited

Reimplemented in EDA_BASE_FRAME, and PCB_BASE_FRAME.

Definition at line 58 of file units_provider.h.

GetProgressReporter()

PROGRESS_REPORTER * DRC_ENGINE::GetProgressReporter ( ) const

inline

Definition at line 135 of file drc_engine.h.

References m_progressReporter.

Referenced by DRC_CACHE_GENERATOR::Run(), and DRC_TEST_PROVIDER_SLIVER_CHECKER::Run().

GetReportAllTrackErrors()

bool DRC_ENGINE::GetReportAllTrackErrors ( ) const

inline

Definition at line 174 of file drc_engine.h.

References m_reportAllTrackErrors.

Referenced by DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testSingleLayerItemAgainstItem(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackClearances().

GetSchematicNetlist()

NETLIST * DRC_ENGINE::GetSchematicNetlist ( ) const

inline

Definition at line 106 of file drc_engine.h.

References m_schematicNetlist.

Referenced by DRC_TEST_PROVIDER_SCHEMATIC_PARITY::Run().

GetTestFootprints()

bool DRC_ENGINE::GetTestFootprints ( ) const

inline

Definition at line 175 of file drc_engine.h.

References m_testFootprints.

Referenced by DRC_TEST_PROVIDER_SCHEMATIC_PARITY::Run().

GetTestProvider()

DRC_TEST_PROVIDER * DRC_ENGINE::GetTestProvider

(

const wxString &

name

)

const

Definition at line 2026 of file drc_engine.cpp.

References m_testProviders, and name.

GetTestProviders()

std::vector< DRC_TEST_PROVIDER * > DRC_ENGINE::GetTestProviders ( ) const

inline

Definition at line 194 of file drc_engine.h.

References m_testProviders.

GetTypeFromUnits()

static EDA_DATA_TYPE UNITS_PROVIDER::GetTypeFromUnits ( const EDA_UNITS  aUnits )

inlinestaticinherited

Gets the inferred type from the given units.

Note: will always return the most simple type (e.g. a DISTANCE rather than AREA or VOLUME for a measurement unit).

Definition at line 219 of file units_provider.h.

Referenced by DRC_RULES_PARSER::parseConstraint(), and WX_GRID::SetAutoEvalColUnits().

GetUnitPair()

virtual void UNITS_PROVIDER::GetUnitPair ( EDA_UNITS &  aPrimaryUnit, EDA_UNITS &  aSecondaryUnits  )

inlinevirtualinherited

Reimplemented in EDA_DRAW_FRAME.

Definition at line 48 of file units_provider.h.

References UNITS_PROVIDER::GetUserUnits(), and EDA_UNIT_UTILS::IsImperialUnit().

Referenced by PANEL_GRID_SETTINGS::RebuildGridSizes().

GetUnitsFromType()

EDA_UNITS UNITS_PROVIDER::GetUnitsFromType ( EDA_DATA_TYPE  aType ) const

inlineinherited

Gets the units to use in the conversion based on the underlying user units.

Definition at line 197 of file units_provider.h.

References UNITS_PROVIDER::GetUserUnits(), and EDA_UNIT_UTILS::IsMetricUnit().

Referenced by UNITS_PROVIDER::MessageTextFromMinOptMax(), UNITS_PROVIDER::MessageTextFromValue(), UNITS_PROVIDER::OptionalValueFromString(), UNITS_PROVIDER::StringFromOptionalValue(), UNITS_PROVIDER::StringFromValue(), and UNITS_PROVIDER::ValueFromString().

GetUserUnits()

EDA_UNITS UNITS_PROVIDER::GetUserUnits ( ) const

inlineinherited

Definition at line 45 of file units_provider.h.

References UNITS_PROVIDER::m_userUnits.

Referenced by DIALOG_BOOK_REPORTER::AddHTMLPage(), PANEL_SYMBOL_CHOOSER::constructRightPanel(), PG_UNIT_EDITOR::CreateControls(), PCB::IFACE::CreateKiWindow(), DIALOG_SHIM::DIALOG_SHIM(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PL_EDITOR_FRAME::DisplayGridMsg(), EDA_DRAW_FRAME::DisplayUnitsMsg(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::drawOneBezier(), DRAWING_TOOL::drawShape(), EVT_GRID_CMD_CELL_CHANGED(), FOOTPRINT_PREVIEW_PANEL::FOOTPRINT_PREVIEW_PANEL(), PCB_NET_INSPECTOR_PANEL::generateReport(), BOARD_EDITOR_CONTROL::GenFootprintsReport(), WX_GRID::getColumnUnits(), RC_ITEM::GetJsonViolation(), GERBER_DRAW_ITEM::GetMsgPanelInfo(), UNITS_PROVIDER::GetUnitPair(), EDA_DRAW_FRAME::GetUnitPair(), UNITS_PROVIDER::GetUnitsFromType(), GetUserUnits(), IfaceOrAddress(), FIELDS_GRID_TABLE::initGrid(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), PANEL_SETUP_BOARD_STACKUP::onExportToClipboard(), DIALOG_ERC::OnSaveReport(), PANEL_PREVIEW_3D_MODEL::onUnitsChanged(), PANEL_SETUP_NETCLASSES::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), PANEL_SETUP_BOARD_STACKUP::onUnitsChanged(), DIALOG_GENERATORS::onUnitsChanged(), PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PANEL_SETUP_NETCLASSES::PANEL_SETUP_NETCLASSES(), PANEL_SETUP_TIME_DOMAIN_PARAMETERS::PANEL_SETUP_TIME_DOMAIN_PARAMETERS(), PCB_FIELDS_GRID_TABLE::PCB_FIELDS_GRID_TABLE(), PG_UNIT_EDITOR::PG_UNIT_EDITOR(), PIN_TABLE_DATA_MODEL::PIN_TABLE_DATA_MODEL(), POSITION_RELATIVE_TOOL::PositionRelative(), DRC_TOOL::RunTests(), SaveFileAs(), EDA_DRAW_FRAME::SaveSettings(), PCB_BASE_FRAME::SetBoard(), WX_GRID::SetUnitsProvider(), PIN_TABLE_DATA_MODEL::SetValue(), FIELDS_GRID_TABLE::SetValue(), PCB_FIELDS_GRID_TABLE::SetValue(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), COMMON_TOOLS::ToggleUnits(), EDA_DRAW_FRAME::ToggleUserUnits(), PCB_BASE_FRAME::unitsChangeRefresh(), EDITOR_CONDITIONS::unitsFunc(), GERBVIEW_FRAME::updateDCodeSelectBox(), PG_UNIT_EDITOR::UpdateFrame(), PL_EDITOR_FRAME::UpdateStatusBar(), DRC_TOOL::userUnits(), and GRID::UserUnitsMessageText().

HasRulesForConstraintType()

bool DRC_ENGINE::HasRulesForConstraintType

(

DRC_CONSTRAINT_T

constraintID

)

Definition at line 1870 of file drc_engine.cpp.

References m_constraintMap.

Referenced by DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), DRC_TEST_PROVIDER_TRACK_ANGLE::Run(), DRC_TEST_PROVIDER_TRACK_SEGMENT_LENGTH::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), and DRC_TEST_PROVIDER_VIA_DIAMETER::Run().

InitEngine()

void DRC_ENGINE::InitEngine

(

const wxFileName &

aRulePath

)

Initialize the DRC engine.

Exceptions

PARSE_ERROR

if the rules file contains errors

Definition at line 562 of file drc_engine.cpp.

References compileRules(), DRCE_FIRST, DRCE_LAST, ERROR_LIMIT, DRC_TEST_PROVIDER_REGISTRY::GetTestProviders(), BOARD::IncrementTimeStamp(), DRC_TEST_PROVIDER_REGISTRY::Instance(), loadImplicitRules(), loadRules(), m_board, m_constraintMap, m_errorLimits, m_logReporter, m_rules, m_rulesValid, m_testProviders, and REPORTER::Report().

Referenced by DoCourtyardInvalidTest(), and DoCourtyardOverlapTest().

IsCancelled()

bool DRC_ENGINE::IsCancelled

(

)

const

Definition at line 1864 of file drc_engine.cpp.

References PROGRESS_REPORTER::IsCancelled(), and m_progressReporter.

Referenced by DRC_CACHE_GENERATOR::Run(), DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::Run(), DRC_TEST_PROVIDER_CREEPAGE::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_FOOTPRINT_CHECKS::Run(), DRC_TEST_PROVIDER_HOLE_SIZE::Run(), DRC_TEST_PROVIDER_MISC::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::Run(), DRC_TEST_PROVIDER_SLIVER_CHECKER::Run(), DRC_TEST_PROVIDER_SOLDER_MASK::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), DRC_TEST_PROVIDER_TEXT_MIRRORING::Run(), DRC_TEST_PROVIDER_TRACK_ANGLE::Run(), DRC_TEST_PROVIDER_TRACK_SEGMENT_LENGTH::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_VIA_DIAMETER::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testFootprintCourtyardDefinitions(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testGraphicClearances(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::testHoleAgainstHole(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadClearances(), DRC_TEST_PROVIDER_MISC::testTextVars(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackClearances(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testZoneLayer(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones().

IsErrorLimitExceeded()

bool DRC_ENGINE::IsErrorLimitExceeded

(

int

error_code

)

Definition at line 1776 of file drc_engine.cpp.

References DRCE_LAST, and m_errorLimits.

Referenced by DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::Run(), DRC_TEST_PROVIDER_CREEPAGE::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_FOOTPRINT_CHECKS::Run(), DRC_TEST_PROVIDER_HOLE_SIZE::Run(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::Run(), DRC_TEST_PROVIDER_LIBRARY_PARITY::Run(), DRC_TEST_PROVIDER_MISC::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_SLIVER_CHECKER::Run(), DRC_TEST_PROVIDER_SOLDER_MASK::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), DRC_TEST_PROVIDER_TEXT_MIRRORING::Run(), DRC_TEST_PROVIDER_TRACK_ANGLE::Run(), DRC_TEST_PROVIDER_TRACK_SEGMENT_LENGTH::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_VIA_DIAMETER::Run(), DRC_TEST_PROVIDER_MISC::testAssertions(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_MISC::testDisabledLayers(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testFootprintCourtyardDefinitions(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::testHoleAgainstHole(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testKnockoutTextAgainstZone(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), DRC_TEST_PROVIDER_MISC::testOutline(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_SOLDER_MASK::testSilkToMaskClearance(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testSingleLayerItemAgainstItem(), DRC_TEST_PROVIDER_MISC::testTextVars(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones().

IsNetADiffPair()

bool DRC_ENGINE::IsNetADiffPair ( BOARD *  aBoard, NETINFO_ITEM *  aNet, int &  aNetP, int &  aNetN  )

static

Definition at line 1968 of file drc_engine.cpp.

References dummy, BOARD::FindNet(), NETINFO_ITEM::GetNetCode(), NETINFO_ITEM::GetNetname(), and MatchDpSuffix().

Referenced by test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run().

IsNetTieExclusion()

bool DRC_ENGINE::IsNetTieExclusion	(	int	aTrackNetCode,
		PCB_LAYER_ID	aTrackLayer,
		const VECTOR2I &	aCollisionPos,
		BOARD_ITEM *	aCollidingItem
	)

Check if the given collision between a track and another item occurs during the track's entry into a net-tie pad.

Definition at line 2002 of file drc_engine.cpp.

References epsilon, GetDesignSettings(), BOARD_DESIGN_SETTINGS::GetDRCEpsilon(), BOARD_ITEM::GetParentFootprint(), FOOTPRINT::IsNetTie(), FOOTPRINT::MapPadNumbersToNetTieGroups(), pad, and FOOTPRINT::Pads().

Referenced by DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testSingleLayerItemAgainstItem().

KeepRefreshing()

bool DRC_ENGINE::KeepRefreshing

(

bool

aWait = false

)

Definition at line 1819 of file drc_engine.cpp.

References PROGRESS_REPORTER::KeepRefreshing(), and m_progressReporter.

loadImplicitRules()

void DRC_ENGINE::loadImplicitRules ( )

private

Definition at line 154 of file drc_engine.cpp.

References _, addRule(), ANNULAR_WIDTH_CONSTRAINT, B_SilkS, CLEARANCE_CONSTRAINT, CONNECTION_WIDTH_CONSTRAINT, COURTYARD_CLEARANCE_CONSTRAINT, createImplicitRule(), DIFF_PAIR_GAP_CONSTRAINT, DISALLOW_CONSTRAINT, DRC_DISALLOW_FOOTPRINTS, DRC_DISALLOW_PADS, DRC_DISALLOW_TRACKS, DRC_DISALLOW_VIAS, DRC_DISALLOW_ZONES, EDGE_CLEARANCE_CONSTRAINT, F_SilkS, BOARD::Footprints(), BOARD::GetDesignSettings(), HOLE_CLEARANCE_CONSTRAINT, HOLE_SIZE_CONSTRAINT, HOLE_TO_HOLE_CONSTRAINT, isKeepoutZone(), m_board, BOARD_DESIGN_SETTINGS::m_CopperEdgeClearance, DRC_CONSTRAINT::m_DisallowFlags, BOARD_DESIGN_SETTINGS::m_HoleClearance, BOARD_DESIGN_SETTINGS::m_HoleToHoleMin, BOARD_DESIGN_SETTINGS::m_MicroViasMinDrill, BOARD_DESIGN_SETTINGS::m_MicroViasMinSize, BOARD_DESIGN_SETTINGS::m_MinClearance, BOARD_DESIGN_SETTINGS::m_MinConn, BOARD_DESIGN_SETTINGS::m_MinResolvedSpokes, BOARD_DESIGN_SETTINGS::m_MinSilkTextHeight, BOARD_DESIGN_SETTINGS::m_MinSilkTextThickness, BOARD_DESIGN_SETTINGS::m_MinThroughDrill, BOARD_DESIGN_SETTINGS::m_NetSettings, BOARD_DESIGN_SETTINGS::m_SilkClearance, BOARD_DESIGN_SETTINGS::m_TrackMinWidth, BOARD_DESIGN_SETTINGS::m_ViasMinAnnularWidth, BOARD_DESIGN_SETTINGS::m_ViasMinSize, MIN_RESOLVED_SPOKES_CONSTRAINT, name, MINOPTMAX< T >::SetMin(), MINOPTMAX< T >::SetOpt(), SILK_CLEARANCE_CONSTRAINT, BOARD::SynchronizeNetsAndNetClasses(), TEXT_HEIGHT_CONSTRAINT, TEXT_THICKNESS_CONSTRAINT, TRACK_WIDTH_CONSTRAINT, DRC_CONSTRAINT::Value(), VIA_DIAMETER_CONSTRAINT, and BOARD::Zones().

Referenced by InitEngine().

loadRules()

void DRC_ENGINE::loadRules ( const wxFileName &  aPath )

private

Load and parse a rule set from an sexpr text file.

Exceptions

PARSE_ERROR

Definition at line 491 of file drc_engine.cpp.

References ExpandTextVars(), BOARD::GetProject(), m_board, m_logReporter, m_rules, DRC_RULES_PARSER::Parse(), FILE_LINE_READER::ReadLine(), resolver, and PROJECT::TextVarResolver().

Referenced by InitEngine().

MatchDpSuffix()

int DRC_ENGINE::MatchDpSuffix ( const wxString &  aNetName, wxString &  aComplementNet, wxString &  aBaseDpName  )

static

Check if the given net is a diff pair, returning its polarity and complement if so.

Parameters

aNetName	is the input net name, like DIFF_P
aComplementNet	will be filled with the complement, like DIFF_N
aBaseDpName	will be filled with the base name, like DIFF

Returns

1 if aNetName is the positive half of a pair, -1 if negative, 0 if not a diff pair

Definition at line 1918 of file drc_engine.cpp.

Referenced by inDiffPairFunc(), BOARD_INSPECTION_TOOL::InspectClearance(), isCoupledDiffPairFunc(), and IsNetADiffPair().

MessageTextFromMinOptMax()

wxString UNITS_PROVIDER::MessageTextFromMinOptMax ( const MINOPTMAX< int > &  aValue, EDA_DATA_TYPE  aType = EDA_DATA_TYPE::DISTANCE  ) const

inlineinherited

Definition at line 137 of file units_provider.h.

References UNITS_PROVIDER::GetIuScale(), UNITS_PROVIDER::GetUnitsFromType(), and EDA_UNIT_UTILS::UI::MessageTextFromMinOptMax().

Referenced by PCB_TUNING_PATTERN::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), and PCB_CONTROL::UpdateMessagePanel().

MessageTextFromValue() [1/2]

wxString UNITS_PROVIDER::MessageTextFromValue ( const EDA_ANGLE &  aValue, bool  aAddUnitLabel = true  ) const

inlineinherited

Definition at line 130 of file units_provider.h.

References EDA_ANGLE::AsDegrees(), EDA_UNIT_UTILS::UI::MessageTextFromValue(), and unityScale.

MessageTextFromValue() [2/2]

wxString UNITS_PROVIDER::MessageTextFromValue ( double  aValue, bool  aAddUnitLabel = true, EDA_DATA_TYPE  aType = EDA_DATA_TYPE::DISTANCE  ) const

inlineinherited

A lower-precision version of StringFromValue().

Should ONLY be used for status text and messages. Not suitable for dialogs, files, etc. where the loss of precision matters.

Definition at line 123 of file units_provider.h.

References UNITS_PROVIDER::GetIuScale(), UNITS_PROVIDER::GetUnitsFromType(), and EDA_UNIT_UTILS::UI::MessageTextFromValue().

Referenced by CheckDuplicatePins(), CheckLibSymbol(), CheckLibSymbolGraphics(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkSkews(), DIALOG_BOARD_REANNOTATE::CoordTowxString(), GERBVIEW_FRAME::DisplayGridMsg(), GERBER_FILE_IMAGE::DisplayImageInfo(), EvalRules(), PCB_NET_INSPECTOR_PANEL::formatDelay(), PCB_NET_INSPECTOR_PANEL::formatLength(), DRC_TEST_PROVIDER::formatMsg(), SCH_LINE::GetItemDescription(), SCH_SHAPE::GetItemDescription(), DS_DRAW_ITEM_LINE::GetItemDescription(), DS_DRAW_ITEM_RECT::GetItemDescription(), PCB_TRACK::GetItemDescription(), SCH_BITMAP::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), SCH_JUNCTION::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_PIN::GetMsgPanelInfo(), SCH_TABLECELL::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), DS_DRAW_ITEM_BASE::GetMsgPanelInfo(), PCB_TUNING_PATTERN::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_DIM_ALIGNED::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), PCB_REFERENCE_IMAGE::GetMsgPanelInfo(), PCB_TABLECELL::GetMsgPanelInfo(), PCB_TARGET::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), PCB_VIA::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), STROKE_PARAMS::GetMsgPanelInfo(), GetNetNavigatorItemText(), ZONE_SEARCH_HANDLER::getResultCell(), SYMBOL_SEARCH_HANDLER::getResultCell(), POWER_SEARCH_HANDLER::getResultCell(), TEXT_SEARCH_HANDLER::getResultCell(), LABEL_SEARCH_HANDLER::getResultCell(), GROUP_SEARCH_HANDLER::getResultCell(), PCB_BASE_FRAME::MessageTextFromCoord(), PCB_CONTROL::PlaceCharacteristics(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), DIALOG_BOARD_STATISTICS::saveReportClicked(), TUNING_STATUS_VIEW_ITEM::SetCurrent(), TUNING_STATUS_VIEW_ITEM::SetMinMax(), EDA_SHAPE::ShapeGetMsgPanelInfo(), showCoord(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), VIA_SIZE_MENU::update(), DIALOG_POSITION_RELATIVE::updateAnchorInfo(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), DIALOG_BOARD_STATISTICS::updateDrillGrid(), PCB_CONTROL::UpdateMessagePanel(), PL_EDITOR_FRAME::UpdateMsgPanelInfo(), SCH_BASE_FRAME::UpdateStatusBar(), GERBVIEW_FRAME::UpdateStatusBar(), PCB_BASE_FRAME::UpdateStatusBar(), and DIALOG_BOARD_STATISTICS::updateWidets().

operator=()

DRC_ENGINE & DRC_ENGINE::operator= ( const DRC_ENGINE &  )

delete

OptionalValueFromString()

std::optional< int > UNITS_PROVIDER::OptionalValueFromString ( const wxString &  aTextValue, EDA_DATA_TYPE  aType = EDA_DATA_TYPE::DISTANCE  ) const

inlineinherited

Converts aTextValue in aUnits to internal units used by the frame.

Allows the return of an empty optional if the string represents a null value (currently empty string)

Warning

This utilizes the current locale and will break if decimal formats differ

Parameters

aType	is the type of this value, and controls the way the string is converted to a value
aTextValue	A reference to a wxString object containing the string to convert.

Returns

internal units value

Definition at line 173 of file units_provider.h.

References EDA_UNIT_UTILS::UI::DoubleValueFromString(), UNITS_PROVIDER::GetIuScale(), UNITS_PROVIDER::GetUnitsFromType(), and UNITS_PROVIDER::NullUiString.

Referenced by WX_GRID::GetOptionalUnitValue(), and WX_GRID::onCellEditorHidden().

ProcessAssertions()

void DRC_ENGINE::ProcessAssertions	(	const BOARD_ITEM *	a,
		std::function< void(const DRC_CONSTRAINT *)>	aFailureHandler,
		REPORTER *	aReporter = nullptr
	)

Definition at line 1701 of file drc_engine.cpp.

References _, ASSERTION_CONSTRAINT, EscapeHTML(), BOARD_ITEM::GetLayer(), BOARD_ITEM::GetLayerSet(), m_constraintMap, and REPORT.

Referenced by DRC_TEST_PROVIDER_MISC::testAssertions().

QueryDistinctConstraints()

std::set< int > DRC_ENGINE::QueryDistinctConstraints

(

DRC_CONSTRAINT_T

aConstraintId

)

Definition at line 1903 of file drc_engine.cpp.

References m_constraintMap.

Referenced by DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run().

QueryWorstConstraint()

bool DRC_ENGINE::QueryWorstConstraint	(	DRC_CONSTRAINT_T	aRuleId,
		DRC_CONSTRAINT &	aConstraint
	)

Definition at line 1881 of file drc_engine.cpp.

References m_constraintMap.

Referenced by DRC_CACHE_GENERATOR::Run(), DRC_INTERACTIVE_COURTYARD_CLEARANCE::Run(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), and DRC_TEST_PROVIDER_SOLDER_MASK::Run().

ReportPhase()

bool DRC_ENGINE::ReportPhase

(

const wxString &

aMessage

)

Definition at line 1852 of file drc_engine.cpp.

References PROGRESS_REPORTER::AdvancePhase(), PROGRESS_REPORTER::KeepRefreshing(), and m_progressReporter.

Referenced by DRC_TEST_PROVIDER::reportPhase().

ReportProgress()

bool DRC_ENGINE::ReportProgress

(

double

aProgress

)

Definition at line 1842 of file drc_engine.cpp.

References PROGRESS_REPORTER::KeepRefreshing(), m_progressReporter, and PROGRESS_REPORTER::SetCurrentProgress().

Referenced by DRC_TEST_PROVIDER::reportProgress().

ReportViolation()

void DRC_ENGINE::ReportViolation	(	const std::shared_ptr< DRC_ITEM > &	aItem,
		const VECTOR2I &	aPos,
		int	aMarkerLayer,
		DRC_CUSTOM_MARKER_HANDLER *	aCustomHandler = nullptr
	)

Definition at line 1783 of file drc_engine.cpp.

References m_errorLimits, m_logReporter, DRC_RULE::m_Name, m_violationHandler, REPORTER::Report(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by DRC_TEST_PROVIDER::reportViolation().

RulesValid()

bool DRC_ENGINE::RulesValid ( )

inline

Definition at line 177 of file drc_engine.h.

References m_rulesValid.

RunTests()

void DRC_ENGINE::RunTests	(	EDA_UNITS	aUnits,
		bool	aReportAllTrackErrors,
		bool	aTestFootprints,
		BOARD_COMMIT *	aCommit = nullptr
	)

Run the DRC tests.

Definition at line 617 of file drc_engine.cpp.

References DRCE_CLEARANCE, DRCE_FIRST, DRCE_LAST, DRCE_UNCONNECTED_ITEMS, ERROR_LIMIT, EXTENDED_ERROR_LIMIT, COMPONENT_CLASS_MANAGER::ForceComponentClassRecalculation(), BOARD::GetComponentClassManager(), BOARD::GetTimeStamp(), BOARD_DESIGN_SETTINGS::Ignore(), BOARD::IncrementTimeStamp(), DRC_TEST_PROVIDER::Init(), m_board, m_designSettings, m_errorLimits, m_logReporter, m_reportAllTrackErrors, m_testFootprints, m_testProviders, PROF_TIMER::msecs(), REPORTER::Report(), DRC_CACHE_GENERATOR::Run(), DRC_TEST_PROVIDER::SetDRCEngine(), UNITS_PROVIDER::SetUserUnits(), PROF_TIMER::Stop(), and traceDrcProfile.

Referenced by DoCourtyardInvalidTest(), and DoCourtyardOverlapTest().

SetBoard()

void DRC_ENGINE::SetBoard ( BOARD *  aBoard )

inline

Definition at line 99 of file drc_engine.h.

References m_board.

SetDebugOverlay()

void DRC_ENGINE::SetDebugOverlay ( std::shared_ptr< KIGFX::VIEW_OVERLAY >  aOverlay )

inline

Definition at line 111 of file drc_engine.h.

References m_debugOverlay.

SetDesignSettings()

void DRC_ENGINE::SetDesignSettings ( BOARD_DESIGN_SETTINGS *  aSettings )

inline

Definition at line 102 of file drc_engine.h.

References m_designSettings.

SetDrawingSheet()

void DRC_ENGINE::SetDrawingSheet ( DS_PROXY_VIEW_ITEM *  aDrawingSheet )

inline

Definition at line 108 of file drc_engine.h.

References m_drawingSheet.

SetLogReporter()

void DRC_ENGINE::SetLogReporter ( REPORTER *  aReporter )

inline

Definition at line 144 of file drc_engine.h.

References m_logReporter.

SetMaxProgress()

void DRC_ENGINE::SetMaxProgress

(

int

aSize

)

Definition at line 1835 of file drc_engine.cpp.

References m_progressReporter, and PROGRESS_REPORTER::SetMaxProgress().

SetProgressReporter()

void DRC_ENGINE::SetProgressReporter ( PROGRESS_REPORTER *  aProgRep )

inline

Set an optional reporter for user-level progress info.

Definition at line 134 of file drc_engine.h.

References m_progressReporter.

SetSchematicNetlist()

void DRC_ENGINE::SetSchematicNetlist ( NETLIST *  aNetlist )

inline

Definition at line 105 of file drc_engine.h.

References m_schematicNetlist.

SetUserUnits()

void UNITS_PROVIDER::SetUserUnits ( EDA_UNITS  aUnits )

inlineinherited

Definition at line 46 of file units_provider.h.

References UNITS_PROVIDER::m_userUnits.

Referenced by EDA_BASE_FRAME::ChangeUserUnits(), PCB::IFACE::CreateKiWindow(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_DIM_ALIGNED::GetMsgPanelInfo(), IfaceOrAddress(), EDA_DRAW_FRAME::LoadSettings(), DRC_TEST_PROVIDER::RunTests(), RunTests(), SaveFileAs(), and EDA_DRAW_FRAME::ToggleUserUnits().

SetViolationHandler()

void DRC_ENGINE::SetViolationHandler ( DRC_VIOLATION_HANDLER  aHandler )

inline

Set an optional DRC violation handler (receives DRC_ITEMs and positions).

Definition at line 121 of file drc_engine.h.

References m_violationHandler.

Referenced by DoCourtyardInvalidTest(), and DoCourtyardOverlapTest().

StringFromOptionalValue()

wxString UNITS_PROVIDER::StringFromOptionalValue ( std::optional< int >  aValue, bool  aAddUnitLabel = false, EDA_DATA_TYPE  aType = EDA_DATA_TYPE::DISTANCE  ) const

inlineinherited

Converts an optional aValue in internal units into a united string.

For readability, trailing 0s are removed if the mantissa has 3 or more digits. This function should be used to display values in dialogs because a value entered in mm (for instance 2.0 mm) could need up to 8 digits mantissa if displayed in inch to avoid truncation or rounding made just by the printf function.

Parameters

aValue	= optional value in internal units
aAddUnitLabel	= true to add symbol unit to the string value
aType	is the type of this value, and controls the way the value is converted to a string, and the suitable unit

Returns

A wxString object containing value and optionally the symbol unit (like 2.000 mm)

Definition at line 100 of file units_provider.h.

References UNITS_PROVIDER::GetIuScale(), UNITS_PROVIDER::GetUnitsFromType(), UNITS_PROVIDER::NullUiString, and EDA_UNIT_UTILS::UI::StringFromValue().

Referenced by WX_GRID::onCellEditorHidden().

StringFromValue() [1/2]

wxString UNITS_PROVIDER::StringFromValue ( const EDA_ANGLE &  aValue, bool  aAddUnitLabel = false  ) const

inlineinherited

Definition at line 110 of file units_provider.h.

References EDA_ANGLE::AsDegrees(), EDA_UNIT_UTILS::UI::StringFromValue(), and unityScale.

StringFromValue() [2/2]

wxString UNITS_PROVIDER::StringFromValue ( double  aValue, bool  aAddUnitLabel = false, EDA_DATA_TYPE  aType = EDA_DATA_TYPE::DISTANCE  ) const

inlineinherited

Converts aValue in internal units into a united string.

For readability, trailing 0s are removed if the mantissa has 3 or more digits. This function should be used to display values in dialogs because a value entered in mm (for instance 2.0 mm) could need up to 8 digits mantissa if displayed in inch to avoid truncation or rounding made just by the printf function.

Parameters

aValue	= value in internal units
aAddUnitLabel	= true to add symbol unit to the string value
aType	is the type of this value, and controls the way the value is converted to a string, and the suitable unit

Returns

A wxString object containing value and optionally the symbol unit (like 2.000 mm)

Definition at line 79 of file units_provider.h.

References UNITS_PROVIDER::GetIuScale(), UNITS_PROVIDER::GetUnitsFromType(), and EDA_UNIT_UTILS::UI::StringFromValue().

Referenced by DIALOG_PLOT::applyPlotSettings(), PANEL_SETUP_BOARD_STACKUP::computeBoardThickness(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PAD::doCheckPad(), PIN_INFO_FORMATTER::Format(), VALIDATION_ERROR_TOO_LARGE< T >::Format(), VALIDATION_ERROR_TOO_SMALL< T >::Format(), formatBBox(), DRC_TEST_PROVIDER::formatMsg(), FIELDS_GRID_TABLE::GetValue(), PCB_FIELDS_GRID_TABLE::GetValue(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectDRCError(), PANEL_SETUP_BOARD_STACKUP::lazyBuildRowUI(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), WX_GRID::onCellEditorHidden(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), PCB_CONTROL::PlaceStackup(), reportMax(), reportMin(), reportOpt(), PANEL_SETUP_BOARD_STACKUP::setDefaultLayerWidths(), PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard(), PANEL_FP_EDITOR_GRAPHICS_DEFAULTS::TransferDataFromWindow(), PANEL_SETUP_TEXT_AND_GRAPHICS::TransferDataFromWindow(), PANEL_SETUP_CONSTRAINTS::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::Validate(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Validate(), and PANEL_SETUP_NETCLASSES::validateNetclassClearance().

ValueFromString()

int UNITS_PROVIDER::ValueFromString ( const wxString &  aTextValue, EDA_DATA_TYPE  aType = EDA_DATA_TYPE::DISTANCE  ) const

inlineinherited

Converts aTextValue in aUnits to internal units used by the frame.

Warning

This utilizes the current locale and will break if decimal formats differ

Parameters

aType	is the type of this value, and controls the way the string is converted to a value
aTextValue	A reference to a wxString object containing the string to convert.

Returns

internal units value

Definition at line 152 of file units_provider.h.

References EDA_UNIT_UTILS::UI::DoubleValueFromString(), UNITS_PROVIDER::GetIuScale(), and UNITS_PROVIDER::GetUnitsFromType().

Referenced by PIN_TABLE_DATA_MODEL::compare(), PANEL_SETUP_BOARD_STACKUP::computeBoardThickness(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), WX_GRID::GetUnitValue(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), WX_GRID::onCellEditorHidden(), PANEL_SETUP_BOARD_STACKUP::onCopperLayersSelCount(), PANEL_SETUP_TRACKS_AND_VIAS::OnSortDiffPairsClick(), PANEL_SETUP_TRACKS_AND_VIAS::OnSortTrackWidthsClick(), PANEL_SETUP_TRACKS_AND_VIAS::OnSortViaSizesClick(), PANEL_SETUP_BOARD_STACKUP::onThicknessChange(), PANEL_SETUP_BOARD_STACKUP::setDefaultLayerWidths(), FIELDS_GRID_TABLE::SetValue(), PCB_FIELDS_GRID_TABLE::SetValue(), PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup(), PIN_INFO_FORMATTER::UpdatePin(), and DIALOG_FOOTPRINT_PROPERTIES::Validate().

Friends And Related Function Documentation

DRC_TEST_PROVIDER_CLEARANCE_BASE

friend class DRC_TEST_PROVIDER_CLEARANCE_BASE

friend

Definition at line 87 of file drc_engine.h.

DRC_TEST_PROVIDER_CREEPAGE

friend class DRC_TEST_PROVIDER_CREEPAGE

friend

Definition at line 88 of file drc_engine.h.

Member Data Documentation

m_board

BOARD* DRC_ENGINE::m_board

protected

Definition at line 256 of file drc_engine.h.

Referenced by EvalRules(), GetBoard(), GetItemsMatchingCondition(), InitEngine(), loadImplicitRules(), loadRules(), RunTests(), and SetBoard().

m_constraintMap

std::map<DRC_CONSTRAINT_T, std::vector<DRC_ENGINE_CONSTRAINT*>*> DRC_ENGINE::m_constraintMap

protected

Definition at line 269 of file drc_engine.h.

Referenced by compileRules(), EvalRules(), HasRulesForConstraintType(), InitEngine(), ProcessAssertions(), QueryDistinctConstraints(), QueryWorstConstraint(), and ~DRC_ENGINE().

m_debugOverlay

std::shared_ptr<KIGFX::VIEW_OVERLAY> DRC_ENGINE::m_debugOverlay

protected

Definition at line 275 of file drc_engine.h.

Referenced by GetDebugOverlay(), and SetDebugOverlay().

m_designSettings

BOARD_DESIGN_SETTINGS* DRC_ENGINE::m_designSettings

protected

Definition at line 255 of file drc_engine.h.

Referenced by EvalRules(), GetDesignSettings(), RunTests(), and SetDesignSettings().

m_drawingSheet

DS_PROXY_VIEW_ITEM* DRC_ENGINE::m_drawingSheet

protected

Definition at line 257 of file drc_engine.h.

Referenced by GetDrawingSheet(), and SetDrawingSheet().

m_errorLimits

std::vector<int> DRC_ENGINE::m_errorLimits

protected

Definition at line 264 of file drc_engine.h.

Referenced by DRC_ENGINE(), InitEngine(), IsErrorLimitExceeded(), ReportViolation(), and RunTests().

m_iuScale

const EDA_IU_SCALE& UNITS_PROVIDER::m_iuScale

privateinherited

Definition at line 251 of file units_provider.h.

Referenced by UNITS_PROVIDER::GetIuScale().

m_logReporter

REPORTER* DRC_ENGINE::m_logReporter

protected

Definition at line 272 of file drc_engine.h.

Referenced by compileRules(), GetItemsMatchingCondition(), GetLogReporter(), InitEngine(), loadRules(), ReportViolation(), RunTests(), and SetLogReporter().

m_progressReporter

PROGRESS_REPORTER* DRC_ENGINE::m_progressReporter

protected

Definition at line 273 of file drc_engine.h.

Referenced by AdvanceProgress(), GetProgressReporter(), IsCancelled(), KeepRefreshing(), ReportPhase(), ReportProgress(), SetMaxProgress(), and SetProgressReporter().

m_reportAllTrackErrors

bool DRC_ENGINE::m_reportAllTrackErrors

protected

Definition at line 265 of file drc_engine.h.

Referenced by GetReportAllTrackErrors(), and RunTests().

m_rules

std::vector<std::shared_ptr<DRC_RULE> > DRC_ENGINE::m_rules

protected

Definition at line 260 of file drc_engine.h.

Referenced by addRule(), compileRules(), InitEngine(), loadRules(), and ~DRC_ENGINE().

m_rulesValid

bool DRC_ENGINE::m_rulesValid

protected

Definition at line 261 of file drc_engine.h.

Referenced by InitEngine(), and RulesValid().

m_schematicNetlist

NETLIST* DRC_ENGINE::m_schematicNetlist

protected

Definition at line 258 of file drc_engine.h.

Referenced by GetSchematicNetlist(), and SetSchematicNetlist().

m_testFootprints

bool DRC_ENGINE::m_testFootprints

protected

Definition at line 266 of file drc_engine.h.

Referenced by GetTestFootprints(), and RunTests().

m_testProviders

std::vector<DRC_TEST_PROVIDER*> DRC_ENGINE::m_testProviders

protected

Definition at line 262 of file drc_engine.h.

Referenced by GetTestProvider(), GetTestProviders(), InitEngine(), and RunTests().

m_userUnits

EDA_UNITS UNITS_PROVIDER::m_userUnits

privateinherited

Definition at line 252 of file units_provider.h.

Referenced by UNITS_PROVIDER::GetUserUnits(), and UNITS_PROVIDER::SetUserUnits().

m_violationHandler

DRC_VIOLATION_HANDLER DRC_ENGINE::m_violationHandler

protected

Definition at line 271 of file drc_engine.h.

Referenced by ClearViolationHandler(), ReportViolation(), and SetViolationHandler().

NullUiString

const wxString UNITS_PROVIDER::NullUiString = ""

inlinestaticinherited

The string that is used in the UI to represent a null value.

Definition at line 248 of file units_provider.h.

Referenced by WX_GRID::GetOptionalUnitValue(), WX_GRID::onCellEditorHidden(), UNITS_PROVIDER::OptionalValueFromString(), and UNITS_PROVIDER::StringFromOptionalValue().

---

The documentation for this class was generated from the following files:

• drc_engine.h
• drc_engine.cpp