Inheritance diagram for DRC_TEST_PROVIDER_COPPER_CLEARANCE:

Classes
struct	checked

Public Member Functions
	DRC_TEST_PROVIDER_COPPER_CLEARANCE ()

virtual	~DRC_TEST_PROVIDER_COPPER_CLEARANCE ()

virtual bool	Run () override
	Run this provider against the given PCB with configured options (if any). More...

virtual const wxString	GetName () const override

virtual const wxString	GetDescription () const override

void	SetDRCEngine (DRC_ENGINE *engine)

bool	RunTests (EDA_UNITS aUnits)

EDA_UNITS	GetUserUnits () const

void	SetUserUnits (EDA_UNITS aUnits)

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)
	Converts aValue in internal units into a united string. More...

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

wxString	MessageTextFromValue (double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
	A lower-precision version of StringFromValue(). More...

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

int	ValueFromString (const wxString &aTextValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
	Converts aTextValue in aUnits to internal units used by the frame. More...

EDA_ANGLE	AngleValueFromString (const wxString &aTextValue)

Static Public Member Functions
static void	Init ()

Protected Member Functions
int	forEachGeometryItem (const std::vector< KICAD_T > &aTypes, LSET aLayers, const std::function< bool(BOARD_ITEM *)> &aFunc)

void	reportAux (const wxString &aMsg)

virtual void	reportAux (const wxChar *fmt,...)

virtual void	reportViolation (std::shared_ptr< DRC_ITEM > &item, const VECTOR2I &aMarkerPos, int aMarkerLayer)

virtual bool	reportProgress (int aCount, int aSize, int aDelta)

virtual bool	reportPhase (const wxString &aStageName)

virtual void	reportRuleStatistics ()

virtual void	accountCheck (const DRC_RULE *ruleToTest)

virtual void	accountCheck (const DRC_CONSTRAINT &constraintToTest)

bool	isInvisibleText (const BOARD_ITEM *aItem) const

wxString	formatMsg (const wxString &aFormatString, const wxString &aSource, int aConstraint, int aActual)

EDA_UNITS	userUnits () const

Protected Attributes
BOARD *	m_board

bool	m_boardOutlineValid

DRC_ENGINE *	m_drcEngine

std::unordered_map< const DRC_RULE *, int >	m_stats

bool	m_isRuleDriven = true

Static Protected Attributes
static std::vector< KICAD_T >	s_allBasicItems

static std::vector< KICAD_T >	s_allBasicItemsButZones

Private Types
typedef struct DRC_TEST_PROVIDER_COPPER_CLEARANCE::checked	layers_checked

Private Member Functions
bool	testTrackAgainstItem (PCB_TRACK track, SHAPE trackShape, PCB_LAYER_ID layer, BOARD_ITEM *other)
	Checks for track/via/hole <-> clearance. More...

void	testTrackClearances ()

bool	testPadAgainstItem (PAD pad, SHAPE padShape, PCB_LAYER_ID layer, BOARD_ITEM *other)

void	testPadClearances ()

void	testZonesToZones ()

void	testItemAgainstZone (BOARD_ITEM aItem, ZONE aZone, PCB_LAYER_ID aLayer)

Private Attributes
int	m_drcEpsilon

const EDA_IU_SCALE &	m_iuScale

EDA_UNITS	m_userUnits

Detailed Description

Definition at line 56 of file drc_test_provider_copper_clearance.cpp.

Member Typedef Documentation

◆ layers_checked

typedef struct DRC_TEST_PROVIDER_COPPER_CLEARANCE::checked DRC_TEST_PROVIDER_COPPER_CLEARANCE::layers_checked

private

Constructor & Destructor Documentation

◆ DRC_TEST_PROVIDER_COPPER_CLEARANCE()

DRC_TEST_PROVIDER_COPPER_CLEARANCE::DRC_TEST_PROVIDER_COPPER_CLEARANCE ( )

inline

Definition at line 59 of file drc_test_provider_copper_clearance.cpp.

◆ ~DRC_TEST_PROVIDER_COPPER_CLEARANCE()

virtual DRC_TEST_PROVIDER_COPPER_CLEARANCE::~DRC_TEST_PROVIDER_COPPER_CLEARANCE ( )

inlinevirtual

Definition at line 65 of file drc_test_provider_copper_clearance.cpp.

Member Function Documentation

◆ accountCheck() [1/2]

void DRC_TEST_PROVIDER::accountCheck ( const DRC_CONSTRAINT & constraintToTest )

protectedvirtualinherited

Definition at line 127 of file drc_test_provider.cpp.

References DRC_TEST_PROVIDER::accountCheck(), and DRC_CONSTRAINT::GetParentRule().

◆ accountCheck() [2/2]

void DRC_TEST_PROVIDER::accountCheck ( const DRC_RULE * ruleToTest )

protectedvirtualinherited

Definition at line 116 of file drc_test_provider.cpp.

References DRC_TEST_PROVIDER::m_stats.

Referenced by DRC_TEST_PROVIDER::accountCheck(), and DRC_TEST_PROVIDER::reportViolation().

◆ AngleValueFromString()

EDA_ANGLE UNITS_PROVIDER::AngleValueFromString ( const wxString & aTextValue )

inlineinherited

Definition at line 120 of file units_provider.h.

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

Referenced by FP_TEXT_GRID_TABLE::SetValue().

◆ forEachGeometryItem()

int DRC_TEST_PROVIDER::forEachGeometryItem	(	const std::vector< KICAD_T > &	aTypes,
		LSET	aLayers,
		const std::function< bool(BOARD_ITEM *)> &	aFunc
	)

protectedinherited

Definition at line 152 of file drc_test_provider.cpp.

References BaseType(), BOARD::Drawings(), BOARD::Footprints(), DRC_ENGINE::GetBoard(), DRC_TEST_PROVIDER::m_drcEngine, MAX_STRUCT_TYPE_ID, pad, PCB_ARC_T, PCB_DIMENSION_T, PCB_FOOTPRINT_T, PCB_PAD_T, PCB_SHAPE_T, PCB_TARGET_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, BOARD::Tracks(), and BOARD::Zones().

◆ formatMsg()

wxString DRC_TEST_PROVIDER::formatMsg	(	const wxString &	aFormatString,
		const wxString &	aSource,
		int	aConstraint,
		int	aActual
	)

protectedinherited

Definition at line 358 of file drc_test_provider.cpp.

References UNITS_PROVIDER::MessageTextFromValue(), and UNITS_PROVIDER::StringFromValue().

◆ GetDescription()

virtual const wxString DRC_TEST_PROVIDER_COPPER_CLEARANCE::GetDescription ( ) const

inlineoverridevirtual

Reimplemented from DRC_TEST_PROVIDER.

Definition at line 76 of file drc_test_provider_copper_clearance.cpp.

◆ GetIuScale()

const EDA_IU_SCALE & UNITS_PROVIDER::GetIuScale ( ) const

inlineinherited

Definition at line 45 of file units_provider.h.

References UNITS_PROVIDER::m_iuScale.

Referenced by UNITS_PROVIDER::AngleValueFromString(), GRID_MENU::BuildChoiceList(), UNITS_PROVIDER::MessageTextFromValue(), UNIT_BINDER::onUnitsChanged(), COMMON_TOOLS::Reset(), UNITS_PROVIDER::StringFromValue(), and UNITS_PROVIDER::ValueFromString().

◆ GetName()

virtual const wxString DRC_TEST_PROVIDER_COPPER_CLEARANCE::GetName ( ) const

inlineoverridevirtual

Reimplemented from DRC_TEST_PROVIDER.

Definition at line 71 of file drc_test_provider_copper_clearance.cpp.

◆ GetOriginTransforms()

virtual ORIGIN_TRANSFORMS & UNITS_PROVIDER::GetOriginTransforms ( )

inlinevirtualinherited

Reimplemented in EDA_BASE_FRAME, and PCB_BASE_FRAME.

Definition at line 48 of file units_provider.h.

◆ GetUserUnits()

EDA_UNITS UNITS_PROVIDER::GetUserUnits ( ) const

inlineinherited

Definition at line 42 of file units_provider.h.

References UNITS_PROVIDER::m_userUnits.

Referenced by DIALOG_BOOK_REPORTER::AddHTMLPage(), 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::drawShape(), DRAWING_TOOL::DrawSpecificationStackup(), EVT_GRID_CMD_CELL_CHANGED(), PROPERTIES_PANEL::extractValueAndWritability(), FP_TEXT_GRID_TABLE::FP_TEXT_GRID_TABLE(), GERBER_DRAW_ITEM::GetMsgPanelInfo(), EDA_DRAW_FRAME::GetUnitPair(), WX_GRID::GetUnitValue(), GetUserUnits(), UNIT_BINDER::init(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), UNITS_PROVIDER::MessageTextFromValue(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), WX_GRID::onCellEditorHidden(), PANEL_SETUP_BOARD_STACKUP::onExportToClipboard(), PANEL_PREVIEW_3D_MODEL::onUnitsChanged(), PANEL_SETUP_NETCLASSES::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), DIALOG_NET_INSPECTOR::onUnitsChanged(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PANEL_SETUP_NETCLASSES::PANEL_SETUP_NETCLASSES(), PG_UNIT_EDITOR::PG_UNIT_EDITOR(), PIN_TABLE_DATA_MODEL::PIN_TABLE_DATA_MODEL(), POSITION_RELATIVE_TOOL::PositionRelative(), PROPERTIES_PANEL::rebuildProperties(), DRC_TOOL::RunTests(), EDA_DRAW_FRAME::SaveSettings(), PCB_BASE_FRAME::SetBoard(), WX_GRID::SetUnitsProvider(), PIN_TABLE_DATA_MODEL::SetValue(), FP_TEXT_GRID_TABLE::SetValue(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), UNITS_PROVIDER::StringFromValue(), COMMON_TOOLS::ToggleUnits(), EDA_DRAW_FRAME::ToggleUserUnits(), PCB_BASE_FRAME::unitsChangeRefresh(), EDITOR_CONDITIONS::unitsFunc(), GERBVIEW_FRAME::updateDCodeSelectBox(), PG_UNIT_EDITOR::UpdateFrame(), PNS_TUNE_STATUS_POPUP::UpdateStatus(), PL_EDITOR_FRAME::UpdateStatusBar(), DRC_TOOL::userUnits(), and UNITS_PROVIDER::ValueFromString().

◆ Init()

void DRC_TEST_PROVIDER::Init ( )

staticinherited

Definition at line 53 of file drc_test_provider.cpp.

References MAX_STRUCT_TYPE_ID, PCB_FOOTPRINT_T, PCB_GROUP_T, PCB_ZONE_T, DRC_TEST_PROVIDER::s_allBasicItems, and DRC_TEST_PROVIDER::s_allBasicItemsButZones.

Referenced by DRC_ENGINE::RunTests().

◆ isInvisibleText()

bool DRC_TEST_PROVIDER::isInvisibleText ( const BOARD_ITEM * aItem ) const

protectedinherited

Definition at line 346 of file drc_test_provider.cpp.

References text.

Referenced by DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), and DRC_TEST_PROVIDER_SOLDER_MASK::testSilkToMaskClearance().

◆ MessageTextFromValue() [1/2]

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

inlineinherited

Definition at line 96 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`
	)

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 89 of file units_provider.h.

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

◆ reportAux() [1/2]

void DRC_TEST_PROVIDER::reportAux	(	const wxChar *	fmt,
			...
	)

protectedvirtualinherited

Definition at line 105 of file drc_test_provider.cpp.

References DRC_TEST_PROVIDER::m_drcEngine, and DRC_ENGINE::ReportAux().

◆ reportAux() [2/2]

void DRC_TEST_PROVIDER::reportAux ( const wxString & aMsg )

inlineprotectedinherited

Definition at line 108 of file drc_test_provider.h.

References DRC_TEST_PROVIDER::reportAux().

◆ reportPhase()

bool DRC_TEST_PROVIDER::reportPhase ( const wxString & aStageName )

protectedvirtualinherited

Definition at line 98 of file drc_test_provider.cpp.

References DRC_TEST_PROVIDER::m_drcEngine, DRC_TEST_PROVIDER::reportAux(), and DRC_ENGINE::ReportPhase().

◆ reportProgress()

bool DRC_TEST_PROVIDER::reportProgress	(	int	aCount,
		int	aSize,
		int	aDelta
	)

protectedvirtualinherited

Definition at line 86 of file drc_test_provider.cpp.

References DRC_TEST_PROVIDER::m_drcEngine, and DRC_ENGINE::ReportProgress().

◆ reportRuleStatistics()

void DRC_TEST_PROVIDER::reportRuleStatistics ( )

protectedvirtualinherited

Definition at line 133 of file drc_test_provider.cpp.

References DRC_TEST_PROVIDER::m_drcEngine, DRC_TEST_PROVIDER::m_isRuleDriven, DRC_TEST_PROVIDER::m_stats, and DRC_ENGINE::ReportAux().

Referenced by DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_HOLE_SIZE::Run(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::Run(), DRC_TEST_PROVIDER_SOLDER_MASK::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_VIA_DIAMETER::Run(), and DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal().

◆ reportViolation()

void DRC_TEST_PROVIDER::reportViolation	(	std::shared_ptr< DRC_ITEM > &	item,
		const VECTOR2I &	aMarkerPos,
		int	aMarkerLayer
	)

protectedvirtualinherited

Definition at line 75 of file drc_test_provider.cpp.

References DRC_TEST_PROVIDER::accountCheck(), DRC_TEST_PROVIDER::m_drcEngine, and DRC_ENGINE::ReportViolation().

◆ Run()

bool DRC_TEST_PROVIDER_COPPER_CLEARANCE::Run ( )

overridevirtual

Run this provider against the given PCB with configured options (if any).

Implements DRC_TEST_PROVIDER.

Definition at line 120 of file drc_test_provider_copper_clearance.cpp.

References _, DRCE_CLEARANCE, DRCE_HOLE_CLEARANCE, DRCE_SHORTING_ITEMS, DRCE_ZONES_INTERSECT, DRC_ENGINE::GetBoard(), BOARD::GetDesignSettings(), BOARD_DESIGN_SETTINGS::GetDRCEpsilon(), DRC_ENGINE::IsCancelled(), DRC_ENGINE::IsErrorLimitExceeded(), DRC_TEST_PROVIDER_CLEARANCE_BASE::m_board, DRC_TEST_PROVIDER::m_drcEngine, m_drcEpsilon, BOARD::m_DRCMaxClearance, DRC_TEST_PROVIDER::reportAux(), DRC_TEST_PROVIDER::reportPhase(), DRC_TEST_PROVIDER::reportRuleStatistics(), testPadClearances(), testTrackClearances(), and testZonesToZones().

◆ RunTests()

bool DRC_TEST_PROVIDER::RunTests ( EDA_UNITS aUnits )

inlineinherited

Definition at line 88 of file drc_test_provider.h.

References DRC_TEST_PROVIDER::Run(), and UNITS_PROVIDER::SetUserUnits().

◆ SetDRCEngine()

void DRC_TEST_PROVIDER::SetDRCEngine ( DRC_ENGINE * engine )

inlineinherited

Definition at line 82 of file drc_test_provider.h.

References DRC_TEST_PROVIDER::m_drcEngine, and DRC_TEST_PROVIDER::m_stats.

Referenced by DRC_INTERACTIVE_COURTYARD_CLEARANCE::DRC_INTERACTIVE_COURTYARD_CLEARANCE(), and DRC_ENGINE::RunTests().

◆ SetUserUnits()

void UNITS_PROVIDER::SetUserUnits ( EDA_UNITS aUnits )

inlineinherited

Definition at line 43 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(), EDA_DRAW_FRAME::LoadSettings(), DRC_TEST_PROVIDER::RunTests(), DRC_ENGINE::RunTests(), and EDA_DRAW_FRAME::ToggleUserUnits().

◆ StringFromValue() [1/2]

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

inlineinherited

Definition at line 76 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`
	)

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 69 of file units_provider.h.

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

Referenced by DIALOG_PLOT::applyPlotSettings(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildNetclassesGrid(), PANEL_SETUP_BOARD_STACKUP::computeBoardThickness(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DRAWING_TOOL::DrawSpecificationStackup(), VALIDATION_ERROR_TOO_LARGE< T >::Format(), VALIDATION_ERROR_TOO_SMALL< T >::Format(), DRC_TEST_PROVIDER::formatMsg(), PIN_TABLE_DATA_MODEL::GetValue(), FP_TEXT_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(), reportMax(), reportMin(), reportOpt(), PANEL_SETUP_BOARD_STACKUP::setDefaultLayerWidths(), WX_GRID::SetUnitValue(), PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), PANEL_SETUP_CONSTRAINTS::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::Validate(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Validate().

◆ testItemAgainstZone()

void DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone	(	BOARD_ITEM *	aItem,
		ZONE *	aZone,
		PCB_LAYER_ID	aLayer
	)

private

Definition at line 341 of file drc_test_provider_copper_clearance.cpp.

References _, CLEARANCE_CONSTRAINT, LSET::Contains(), DRC_ITEM::Create(), DRCE_CLEARANCE, DRCE_HOLE_CLEARANCE, DRC_ENGINE::EvalRules(), DRC_TEST_PROVIDER::formatMsg(), EDA_ITEM::GetBoundingBox(), ZONE::GetBoundingBox(), BOARD_ITEM::GetEffectiveHoleShape(), BOARD_ITEM::GetEffectiveShape(), BOARD_ITEM::GetLayerSet(), ZONE::GetLayerSet(), DRC_CONSTRAINT::GetName(), BOARD_CONNECTED_ITEM::GetNetCode(), DRC_CONSTRAINT::GetParentRule(), DRC_CONSTRAINT::GetSeverity(), DRC_CONSTRAINT::GetValue(), BOARD_ITEM::HasHole(), HOLE_CLEARANCE_CONSTRAINT, BOX2< Vec >::Inflate(), BOX2< Vec >::Intersects(), BOARD_ITEM::IsConnected(), DRC_ENGINE::IsErrorLimitExceeded(), DRC_TEST_PROVIDER_CLEARANCE_BASE::m_board, BOARD::m_CopperZoneRTreeCache, DRC_TEST_PROVIDER::m_drcEngine, m_drcEpsilon, BOARD::m_DRCMaxClearance, MINOPTMAX< T >::Min(), pad, PCB_PAD_T, PCB_VIA_T, DRC_RTREE::QueryColliding(), DRC_TEST_PROVIDER::reportViolation(), RPT_SEVERITY_IGNORE, and EDA_ITEM::Type().

Referenced by testPadClearances(), and testTrackClearances().

◆ testPadAgainstItem()

bool DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem	(	PAD *	pad,
		SHAPE *	padShape,
		PCB_LAYER_ID	layer,
		BOARD_ITEM *	other
	)

private

Definition at line 566 of file drc_test_provider_copper_clearance.cpp.

References _, CLEARANCE_CONSTRAINT, SHAPE::Collide(), DRC_ITEM::Create(), DRCE_CLEARANCE, DRCE_HOLE_CLEARANCE, DRCE_SHORTING_ITEMS, DRC_ENGINE::EvalRules(), PAD::FlashLayer(), DRC_TEST_PROVIDER::formatMsg(), PAD::GetAttribute(), PCB_VIA::GetDrill(), PAD::GetDrillSize(), PAD::GetEffectiveHoleShape(), PCB_VIA::GetEffectiveHoleShape(), BOARD_ITEM::GetEffectiveShape(), DRC_CONSTRAINT::GetName(), BOARD_CONNECTED_ITEM::GetNetCode(), BOARD_CONNECTED_ITEM::GetNetname(), PAD::GetNumber(), BOARD_ITEM::GetParent(), DRC_CONSTRAINT::GetParentRule(), PAD::GetPosition(), DRC_CONSTRAINT::GetSeverity(), DRC_CONSTRAINT::GetValue(), PAD::HasHole(), HOLE_CLEARANCE_CONSTRAINT, DRC_ENGINE::IsCancelled(), IsCopperLayer(), DRC_ENGINE::IsErrorLimitExceeded(), DRC_ENGINE::IsNetTieExclusion(), PCB_VIA::IsOnLayer(), DRC_TEST_PROVIDER::m_drcEngine, m_drcEpsilon, FOOTPRINT::MapPadNumbersToNetTieGroups(), MINOPTMAX< T >::Min(), pad, PCB_PAD_T, PCB_SHAPE_T, PCB_VIA_T, DRC_TEST_PROVIDER::reportViolation(), RPT_SEVERITY_IGNORE, EDA_ITEM::Type(), and VECTOR2< T >::x.

Referenced by testPadClearances().

◆ testPadClearances()

void DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadClearances ( )

private

Definition at line 797 of file drc_test_provider_copper_clearance.cpp.

References LSET::AllCuMask(), BOARD::Footprints(), BOARD::GetCopperLayerCount(), DRC_ENGINE::IsCancelled(), DRC_TEST_PROVIDER_CLEARANCE_BASE::m_board, BOARD::m_CopperItemRTreeCache, BOARD::m_DRCCopperZones, DRC_TEST_PROVIDER::m_drcEngine, BOARD::m_DRCMaxClearance, pad, DRC_TEST_PROVIDER::reportAux(), DRC_TEST_PROVIDER::reportProgress(), LSET::Seq(), testItemAgainstZone(), and testPadAgainstItem().

Referenced by Run().

◆ testTrackAgainstItem()

bool DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem	(	PCB_TRACK *	track,
		SHAPE *	trackShape,
		PCB_LAYER_ID	layer,
		BOARD_ITEM *	other
	)

private

Checks for track/via/hole <-> clearance.

Parameters

track	Track to text
trackShape	Primitive track shape
layer	Which layer to test (in case of vias this can be multiple
other	item against which to test the track item

Returns: false if there is a clearance violation reported, true if there is none

Definition at line 184 of file drc_test_provider_copper_clearance.cpp.

References _, CLEARANCE_CONSTRAINT, Collide(), SHAPE::Collide(), DRC_ITEM::Create(), DRCE_CLEARANCE, DRCE_HOLE_CLEARANCE, DRCE_SHORTING_ITEMS, DRCE_TRACKS_CROSSING, DRC_ENGINE::EvalRules(), DRC_TEST_PROVIDER::formatMsg(), BOARD_ITEM::GetEffectiveShape(), PCB_TRACK::GetEnd(), DRC_CONSTRAINT::GetName(), BOARD_CONNECTED_ITEM::GetNetCode(), BOARD_CONNECTED_ITEM::GetNetname(), DRC_CONSTRAINT::GetParentRule(), DRC_ENGINE::GetReportAllTrackErrors(), DRC_CONSTRAINT::GetSeverity(), PCB_TRACK::GetStart(), DRC_CONSTRAINT::GetValue(), BOARD_ITEM::HasHole(), HOLE_CLEARANCE_CONSTRAINT, SEG::Intersect(), DRC_ENGINE::IsErrorLimitExceeded(), DRC_ENGINE::IsNetTieExclusion(), DRC_TEST_PROVIDER::m_drcEngine, m_drcEpsilon, MINOPTMAX< T >::Min(), pad, PCB_PAD_T, PCB_TRACE_T, PCB_VIA_T, DRC_TEST_PROVIDER::reportViolation(), RPT_SEVERITY_IGNORE, and EDA_ITEM::Type().

Referenced by testTrackClearances().

◆ testTrackClearances()

void DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackClearances ( )

private

◆ testZonesToZones()

void DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones ( )

private

Definition at line 868 of file drc_test_provider_copper_clearance.cpp.

References _, SEG::A, SEG::B, B_Cu, CLEARANCE_CONSTRAINT, DRC_ITEM::Create(), DRCE_CLEARANCE, DRCE_ZONES_INTERSECT, DRC_ENGINE::EvalRules(), F_Cu, DRC_TEST_PROVIDER::formatMsg(), ZONE::GetAssignedPriority(), BOARD::GetBoardPolygonOutlines(), ZONE::GetIsRuleArea(), DRC_CONSTRAINT::GetName(), BOARD_CONNECTED_ITEM::GetNetCode(), DRC_CONSTRAINT::GetParentRule(), DRC_CONSTRAINT::GetSeverity(), DRC_CONSTRAINT::GetValue(), DRC_ENGINE::IsCancelled(), DRC_ENGINE::IsErrorLimitExceeded(), BOARD::IsLayerEnabled(), ZONE::IsOnLayer(), DRC_TEST_PROVIDER_CLEARANCE_BASE::m_board, BOARD::m_DRCCopperZones, DRC_TEST_PROVIDER::m_drcEngine, MINOPTMAX< T >::Min(), DRC_TEST_PROVIDER::reportProgress(), DRC_TEST_PROVIDER::reportViolation(), RPT_SEVERITY_IGNORE, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Run().

◆ userUnits()

EDA_UNITS DRC_TEST_PROVIDER::userUnits ( ) const

protectedinherited

◆ ValueFromString()

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

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 112 of file units_provider.h.

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

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(), PIN_TABLE_DATA_MODEL::SetValue(), FP_TEXT_GRID_TABLE::SetValue(), PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), and DIALOG_FOOTPRINT_PROPERTIES::Validate().

Member Data Documentation

◆ m_board

BOARD* DRC_TEST_PROVIDER_CLEARANCE_BASE::m_board

protectedinherited

Definition at line 50 of file drc_test_provider_clearance_base.h.

Referenced by DRC_INTERACTIVE_COURTYARD_CLEARANCE::Init(), DRC_CACHE_GENERATOR::Run(), Run(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), DRC_INTERACTIVE_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testFootprintCourtyardDefinitions(), testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), testPadClearances(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), testTrackClearances(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testZoneLayer(), and testZonesToZones().

◆ m_boardOutlineValid

bool DRC_TEST_PROVIDER_CLEARANCE_BASE::m_boardOutlineValid

protectedinherited

Definition at line 51 of file drc_test_provider_clearance_base.h.

◆ m_drcEngine

DRC_ENGINE* DRC_TEST_PROVIDER::m_drcEngine

protectedinherited

Definition at line 132 of file drc_test_provider.h.

◆ m_drcEpsilon

int DRC_TEST_PROVIDER_COPPER_CLEARANCE::m_drcEpsilon

private

Definition at line 116 of file drc_test_provider_copper_clearance.cpp.

Referenced by Run(), testItemAgainstZone(), testPadAgainstItem(), and testTrackAgainstItem().

◆ m_isRuleDriven

bool DRC_TEST_PROVIDER::m_isRuleDriven = true

protectedinherited

Definition at line 134 of file drc_test_provider.h.

Referenced by DRC_INTERACTIVE_COURTYARD_CLEARANCE::DRC_INTERACTIVE_COURTYARD_CLEARANCE(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::DRC_TEST_PROVIDER_COURTYARD_CLEARANCE(), DRC_TEST_PROVIDER_FOOTPRINT_CHECKS::DRC_TEST_PROVIDER_FOOTPRINT_CHECKS(), DRC_TEST_PROVIDER_LIBRARY_PARITY::DRC_TEST_PROVIDER_LIBRARY_PARITY(), DRC_TEST_PROVIDER_MISC::DRC_TEST_PROVIDER_MISC(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::DRC_TEST_PROVIDER_SCHEMATIC_PARITY(), and DRC_TEST_PROVIDER::reportRuleStatistics().

◆ m_iuScale

const EDA_IU_SCALE& UNITS_PROVIDER::m_iuScale

privateinherited

Definition at line 129 of file units_provider.h.

Referenced by UNITS_PROVIDER::GetIuScale().

◆ m_stats

std::unordered_map<const DRC_RULE*, int> DRC_TEST_PROVIDER::m_stats

protectedinherited

Definition at line 133 of file drc_test_provider.h.

Referenced by DRC_TEST_PROVIDER::accountCheck(), DRC_TEST_PROVIDER::reportRuleStatistics(), and DRC_TEST_PROVIDER::SetDRCEngine().

◆ m_userUnits

EDA_UNITS UNITS_PROVIDER::m_userUnits

privateinherited

Definition at line 130 of file units_provider.h.

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

◆ s_allBasicItems

std::vector< KICAD_T > DRC_TEST_PROVIDER::s_allBasicItems

staticprotectedinherited

Definition at line 126 of file drc_test_provider.h.

Referenced by DRC_TEST_PROVIDER_SOLDER_MASK::buildRTrees(), DRC_TEST_PROVIDER::Init(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_SLIVER_CHECKER::Run(), DRC_TEST_PROVIDER_MISC::testDisabledLayers(), and DRC_TEST_PROVIDER_SOLDER_MASK::testSilkToMaskClearance().

◆ s_allBasicItemsButZones

std::vector< KICAD_T > DRC_TEST_PROVIDER::s_allBasicItemsButZones

staticprotectedinherited

Definition at line 127 of file drc_test_provider.h.

Referenced by DRC_TEST_PROVIDER::Init(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), and DRC_TEST_PROVIDER_SOLDER_MASK::testMaskBridges().

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

drc_test_provider_copper_clearance.cpp

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ layers_checked

Constructor & Destructor Documentation

◆ DRC_TEST_PROVIDER_COPPER_CLEARANCE()

◆ ~DRC_TEST_PROVIDER_COPPER_CLEARANCE()

Member Function Documentation

◆ accountCheck() [1/2]

◆ accountCheck() [2/2]

◆ AngleValueFromString()

◆ forEachGeometryItem()

◆ formatMsg()

◆ GetDescription()

◆ GetIuScale()

◆ GetName()

◆ GetOriginTransforms()

◆ GetUserUnits()

◆ Init()

◆ isInvisibleText()

◆ MessageTextFromValue() [1/2]

◆ MessageTextFromValue() [2/2]

◆ reportAux() [1/2]

◆ reportAux() [2/2]

◆ reportPhase()

◆ reportProgress()

◆ reportRuleStatistics()

◆ reportViolation()

◆ Run()

◆ RunTests()

◆ SetDRCEngine()

◆ SetUserUnits()

◆ StringFromValue() [1/2]

◆ StringFromValue() [2/2]

◆ testItemAgainstZone()

◆ testPadAgainstItem()

◆ testPadClearances()

◆ testTrackAgainstItem()

◆ testTrackClearances()

◆ testZonesToZones()

◆ userUnits()

◆ ValueFromString()

Member Data Documentation

◆ m_board

◆ m_boardOutlineValid

◆ m_drcEngine

◆ m_drcEpsilon

◆ m_isRuleDriven

◆ m_iuScale

◆ m_stats

◆ m_userUnits

◆ s_allBasicItems

◆ s_allBasicItemsButZones