KiCad PCB EDA Suite
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages Concepts
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Member Functions | Private Attributes | List of all members
DRC_TEST_PROVIDER_COPPER_CLEARANCE Class Reference
Inheritance diagram for DRC_TEST_PROVIDER_COPPER_CLEARANCE:
DRC_TEST_PROVIDER_CLEARANCE_BASE DRC_TEST_PROVIDER UNITS_PROVIDER

Public Member Functions

 DRC_TEST_PROVIDER_COPPER_CLEARANCE ()
 
virtual ~DRC_TEST_PROVIDER_COPPER_CLEARANCE ()=default
 
virtual bool Run () override
 Run this provider against the given PCB with configured options (if any).
 
virtual const wxString GetName () const override
 
void SetDRCEngine (DRC_ENGINE *engine)
 
bool RunTests (EDA_UNITS aUnits)
 
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 void Init ()
 
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 Member Functions

void ReportAndShowPathCuToCu (std::shared_ptr< DRC_ITEM > &aDrce, const VECTOR2I &aMarkerPos, int aMarkerLayer, const BOARD_ITEM *aItem1, const BOARD_ITEM *aItem2, PCB_LAYER_ID layer, int aDistance)
 
DRC_CUSTOM_MARKER_HANDLER GetGraphicsHandler (const std::vector< PCB_SHAPE > &aShapes, const VECTOR2I &aStart, const VECTOR2I &aEnd, int aLength)
 
int forEachGeometryItem (const std::vector< KICAD_T > &aTypes, const LSET &aLayers, const std::function< bool(BOARD_ITEM *)> &aFunc)
 
REPORTER * getLogReporter () const
 
virtual void reportViolation (std::shared_ptr< DRC_ITEM > &item, const VECTOR2I &aMarkerPos, int aMarkerLayer, DRC_CUSTOM_MARKER_HANDLER *aCustomHandler=nullptr)
 
virtual bool reportProgress (size_t aCount, size_t aSize, size_t aDelta=1)
 
virtual bool reportPhase (const wxString &aStageName)
 
bool isInvisibleText (const BOARD_ITEM *aItem) const
 
wxString formatMsg (const wxString &aFormatString, const wxString &aSource, double aConstraint, double aActual, EDA_DATA_TYPE aDataType=EDA_DATA_TYPE::DISTANCE)
 
wxString formatMsg (const wxString &aFormatString, const wxString &aSource, const EDA_ANGLE &aConstraint, const EDA_ANGLE &aActual)
 

Protected Attributes

BOARD * m_board
 
bool m_boardOutlineValid
 
DRC_ENGINE * m_drcEngine
 
bool m_isRuleDriven = true
 

Static Protected Attributes

static std::vector< KICAD_T > s_allBasicItems
 
static std::vector< KICAD_T > s_allBasicItemsButZones
 

Private Member Functions

bool testSingleLayerItemAgainstItem (BOARD_ITEM *item, SHAPE *itemShape, PCB_LAYER_ID layer, BOARD_ITEM *other)
 Checks for track/via/hole <-> clearance.
 
void testTrackClearances ()
 
bool testPadAgainstItem (PAD *pad, SHAPE *padShape, PCB_LAYER_ID layer, BOARD_ITEM *other)
 
void testPadClearances ()
 
void testGraphicClearances ()
 
void testZonesToZones ()
 
void testItemAgainstZone (BOARD_ITEM *aItem, ZONE *aZone, PCB_LAYER_ID aLayer)
 
void testKnockoutTextAgainstZone (BOARD_ITEM *aText, NETINFO_ITEM **aInheritedNet, ZONE *aZone)
 

Private Attributes

int m_drcEpsilon
 
const EDA_IU_SCALE & m_iuScale
 
EDA_UNITS m_userUnits
 

Detailed Description

Definition at line 60 of file drc_test_provider_copper_clearance.cpp.

Constructor & Destructor Documentation

◆ DRC_TEST_PROVIDER_COPPER_CLEARANCE()

DRC_TEST_PROVIDER_COPPER_CLEARANCE::DRC_TEST_PROVIDER_COPPER_CLEARANCE ( )
inline

Definition at line 63 of file drc_test_provider_copper_clearance.cpp.

◆ ~DRC_TEST_PROVIDER_COPPER_CLEARANCE()

virtual DRC_TEST_PROVIDER_COPPER_CLEARANCE::~DRC_TEST_PROVIDER_COPPER_CLEARANCE ( )
virtualdefault

Member Function Documentation

◆ 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().

◆ forEachGeometryItem()

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

Definition at line 102 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_FIELD_T, PCB_FOOTPRINT_T, PCB_PAD_T, PCB_SHAPE_T, PCB_TABLE_T, PCB_TABLECELL_T, PCB_TARGET_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, BOARD::Tracks(), and BOARD::Zones().

Referenced by DRC_TEST_PROVIDER_SOLDER_MASK::buildRTrees(), DRC_CACHE_GENERATOR::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_SLIVER_CHECKER::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), DRC_TEST_PROVIDER_TEXT_MIRRORING::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), DRC_TEST_PROVIDER_MISC::testAssertions(), DRC_TEST_PROVIDER_MISC::testDisabledLayers(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskBridges(), DRC_TEST_PROVIDER_SOLDER_MASK::testSilkToMaskClearance(), and DRC_TEST_PROVIDER_MISC::testTextVars().

◆ formatMsg() [1/2]

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

Definition at line 340 of file drc_test_provider.cpp.

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

◆ formatMsg() [2/2]

wxString DRC_TEST_PROVIDER::formatMsg ( const wxString &  aFormatString,
const wxString &  aSource,
double  aConstraint,
double  aActual,
EDA_DATA_TYPE  aDataType = EDA_DATA_TYPE::DISTANCE 
)
protectedinherited

Definition at line 324 of file drc_test_provider.cpp.

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

Referenced by DRC_TEST_PROVIDER_MATCHED_LENGTH::checkLengths(), DRC_TEST_PROVIDER_HOLE_SIZE::checkPadHole(), DRC_TEST_PROVIDER_HOLE_SIZE::checkViaHole(), DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::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_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(), testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), testKnockoutTextAgainstZone(), testPadAgainstItem(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), testSingleLayerItemAgainstItem(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testZoneLayer(), and testZonesToZones().

◆ GetGraphicsHandler()

DRC_CUSTOM_MARKER_HANDLER DRC_TEST_PROVIDER_CLEARANCE_BASE::GetGraphicsHandler ( const std::vector< PCB_SHAPE > &  aShapes,
const VECTOR2I &  aStart,
const VECTOR2I &  aEnd,
int  aLength 
)
protectedinherited

Definition at line 31 of file drc_test_provider_clearance_base.cpp.

References DEFAULT_THEME, COLOR_SETTINGS::GetColor(), GetColorSettings(), LAYER_DRC_ERROR, VECTOR2< T >::Perpendicular(), PgmOrNull(), RED, VECTOR2< T >::Resize(), EDA_SHAPE::SetEnd(), EDA_SHAPE::SetFilled(), EDA_SHAPE::SetLineColor(), EDA_SHAPE::SetStart(), EDA_SHAPE::SetWidth(), WHITE, and KIGFX::COLOR4D::WithAlpha().

Referenced by DRC_TEST_PROVIDER_CLEARANCE_BASE::ReportAndShowPathCuToCu(), and DRC_TEST_PROVIDER_CREEPAGE::testCreepage().

◆ 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_TEST_PROVIDER::getLogReporter ( ) const
inlineprotectedinherited

Definition at line 105 of file drc_test_provider.h.

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

Referenced by DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal().

◆ GetName()

virtual const wxString DRC_TEST_PROVIDER_COPPER_CLEARANCE::GetName ( ) const
inlineoverridevirtual

Reimplemented from DRC_TEST_PROVIDER.

Definition at line 72 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 58 of file units_provider.h.

◆ 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(), UNIT_BINDER::init(), 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().

◆ 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 312 of file drc_test_provider.cpp.

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

◆ 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(), DRC_ENGINE::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().

◆ 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
aTypeis the type of this value, and controls the way the string is converted to a value
aTextValueA 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().

◆ ReportAndShowPathCuToCu()

void DRC_TEST_PROVIDER_CLEARANCE_BASE::ReportAndShowPathCuToCu ( std::shared_ptr< DRC_ITEM > &  aDrce,
const VECTOR2I &  aMarkerPos,
int  aMarkerLayer,
const BOARD_ITEM *  aItem1,
const BOARD_ITEM *  aItem2,
PCB_LAYER_ID  layer,
int  aDistance 
)
protectedinherited

Definition at line 97 of file drc_test_provider_clearance_base.cpp.

References BOARD_ITEM::GetEffectiveShape(), DRC_TEST_PROVIDER_CLEARANCE_BASE::GetGraphicsHandler(), DRC_TEST_PROVIDER::reportViolation(), EDA_SHAPE::SetEnd(), and EDA_SHAPE::SetStart().

Referenced by testItemAgainstZone(), testKnockoutTextAgainstZone(), testPadAgainstItem(), testSingleLayerItemAgainstItem(), and testZonesToZones().

◆ reportPhase()

bool DRC_TEST_PROVIDER::reportPhase ( const wxString &  aStageName)
protectedvirtualinherited

Definition at line 95 of file drc_test_provider.cpp.

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

Referenced by DRC_CACHE_GENERATOR::Run(), DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), 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_SCHEMATIC_PARITY::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_ZONE_CONNECTIONS::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), and DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testFootprintCourtyardDefinitions().

◆ reportProgress()

bool DRC_TEST_PROVIDER::reportProgress ( size_t  aCount,
size_t  aSize,
size_t  aDelta = 1 
)
protectedvirtualinherited

Definition at line 83 of file drc_test_provider.cpp.

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

Referenced by DRC_TEST_PROVIDER_SOLDER_MASK::buildRTrees(), DRC_CACHE_GENERATOR::Run(), DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::Run(), DRC_TEST_PROVIDER_LIBRARY_PARITY::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_SLIVER_CHECKER::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_MISC::testAssertions(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_MISC::testDisabledLayers(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testFootprintCourtyardDefinitions(), testGraphicClearances(), testPadClearances(), DRC_TEST_PROVIDER_SOLDER_MASK::testSilkToMaskClearance(), DRC_TEST_PROVIDER_MISC::testTextVars(), testTrackClearances(), and testZonesToZones().

◆ reportViolation()

void DRC_TEST_PROVIDER::reportViolation ( std::shared_ptr< DRC_ITEM > &  item,
const VECTOR2I &  aMarkerPos,
int  aMarkerLayer,
DRC_CUSTOM_MARKER_HANDLER *  aCustomHandler = nullptr 
)
protectedvirtualinherited

Definition at line 74 of file drc_test_provider.cpp.

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

Referenced by DRC_TEST_PROVIDER_MATCHED_LENGTH::checkLengths(), DRC_TEST_PROVIDER_HOLE_SIZE::checkPadHole(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkSkews(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkViaCounts(), DRC_TEST_PROVIDER_HOLE_SIZE::checkViaHole(), DRC_TEST_PROVIDER_CLEARANCE_BASE::ReportAndShowPathCuToCu(), DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_FOOTPRINT_CHECKS::Run(), DRC_TEST_PROVIDER_LIBRARY_PARITY::Run(), DRC_TEST_PROVIDER_SLIVER_CHECKER::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_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_MISC::testAssertions(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_CREEPAGE::testCreepage(), 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_SOLDER_MASK::testItemAgainstItems(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), DRC_TEST_PROVIDER_MISC::testOutline(), testPadAgainstItem(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), DRC_TEST_PROVIDER_SOLDER_MASK::testSilkToMaskClearance(), testSingleLayerItemAgainstItem(), DRC_TEST_PROVIDER_MISC::testTextVars(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testZoneLayer(), and testZonesToZones().

◆ 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 105 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, REPORT_AUX, DRC_TEST_PROVIDER::reportPhase(), testGraphicClearances(), 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 83 of file drc_test_provider.h.

References DRC_TEST_PROVIDER::m_drcEngine.

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

◆ 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(), DRC_ENGINE::RunTests(), SaveFileAs(), and EDA_DRAW_FRAME::ToggleUserUnits().

◆ 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
aTypeis 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
aTypeis 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().

◆ testGraphicClearances()

void DRC_TEST_PROVIDER_COPPER_CLEARANCE::testGraphicClearances ( )
private

Definition at line 1056 of file drc_test_provider_copper_clearance.cpp.

References BOARD::Drawings(), BOARD::Footprints(), GetKiCadThreadPool(), ZONE::GetLayer(), DRC_ENGINE::IsCancelled(), IsCopperLayer(), DRC_TEST_PROVIDER_CLEARANCE_BASE::m_board, BOARD::m_CopperItemRTreeCache, BOARD::m_DRCCopperZones, DRC_TEST_PROVIDER::m_drcEngine, BOARD::m_DRCMaxClearance, PCB_ARC_T, PCB_PAD_T, PCB_REFERENCE_IMAGE_T, PCB_SHAPE_T, PCB_TEXT_T, PCB_TRACE_T, PCB_VIA_T, REPORT_AUX, DRC_TEST_PROVIDER::reportProgress(), testItemAgainstZone(), testKnockoutTextAgainstZone(), testSingleLayerItemAgainstItem(), tp, and EDA_ITEM::Type().

Referenced by Run().

◆ testItemAgainstZone()

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

Definition at line 351 of file drc_test_provider_copper_clearance.cpp.

References _, actual, clearance, 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(), FOOTPRINT::GetNetTiePads(), BOARD_ITEM::GetParentFootprint(), 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(), FOOTPRINT::IsNetTie(), DRC_TEST_PROVIDER_CLEARANCE_BASE::m_board, BOARD::m_CopperZoneRTreeCache, DRC_TEST_PROVIDER::m_drcEngine, m_drcEpsilon, BOARD::m_DRCMaxClearance, MINOPTMAX< T >::Min(), pad, FOOTPRINT::Pads(), PCB_PAD_T, PCB_VIA_T, DRC_RTREE::QueryColliding(), DRC_TEST_PROVIDER_CLEARANCE_BASE::ReportAndShowPathCuToCu(), RPT_SEVERITY_IGNORE, and EDA_ITEM::Type().

Referenced by testGraphicClearances(), testPadClearances(), and testTrackClearances().

◆ testKnockoutTextAgainstZone()

void DRC_TEST_PROVIDER_COPPER_CLEARANCE::testKnockoutTextAgainstZone ( BOARD_ITEM *  aText,
NETINFO_ITEM **  aInheritedNet,
ZONE *  aZone 
)
private

Definition at line 507 of file drc_test_provider_copper_clearance.cpp.

References _, actual, clearance, CLEARANCE_CONSTRAINT, DRC_ITEM::Create(), DRCE_CLEARANCE, DRCE_SHORTING_ITEMS, DRC_ENGINE::EvalRules(), DRC_TEST_PROVIDER::formatMsg(), EDA_ITEM::GetBoundingBox(), ZONE::GetBoundingBox(), BOARD_ITEM::GetEffectiveShape(), BOARD_ITEM::GetLayer(), ZONE::GetLayerSet(), DRC_CONSTRAINT::GetName(), BOARD_CONNECTED_ITEM::GetNet(), BOARD_CONNECTED_ITEM::GetNetname(), DRC_CONSTRAINT::GetParentRule(), DRC_CONSTRAINT::GetSeverity(), DRC_CONSTRAINT::GetValue(), BOX2< Vec >::Inflate(), BOX2< Vec >::Intersects(), 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(), DRC_RTREE::QueryColliding(), DRC_TEST_PROVIDER_CLEARANCE_BASE::ReportAndShowPathCuToCu(), and RPT_SEVERITY_IGNORE.

Referenced by testGraphicClearances().

◆ testPadAgainstItem()

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

Definition at line 722 of file drc_test_provider_copper_clearance.cpp.

References _, actual, clearance, 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(), BOARD_CONNECTED_ITEM::GetShortNetname(), DRC_CONSTRAINT::GetValue(), PAD::HasHole(), HOLE_CLEARANCE_CONSTRAINT, 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_CLEARANCE_BASE::ReportAndShowPathCuToCu(), 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 960 of file drc_test_provider_copper_clearance.cpp.

References LSET::AllCuMask(), BOARD::Footprints(), BOARD::GetCopperLayerCount(), GetKiCadThreadPool(), 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, FOOTPRINT::Pads(), DRC_TEST_PROVIDER::reportProgress(), testItemAgainstZone(), testPadAgainstItem(), and tp.

Referenced by Run().

◆ testSingleLayerItemAgainstItem()

bool DRC_TEST_PROVIDER_COPPER_CLEARANCE::testSingleLayerItemAgainstItem ( BOARD_ITEM *  item,
SHAPE *  itemShape,
PCB_LAYER_ID  layer,
BOARD_ITEM *  other 
)
private

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

Parameters
itemTrack to text
itemShapePrimitive track shape
layerWhich layer to test (in case of vias this can be multiple
otheritem against which to test the track item
Returns
false if there is a clearance violation reported, true if there is none

Definition at line 175 of file drc_test_provider_copper_clearance.cpp.

References _, actual, clearance, 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(), NETINFO_ITEM::GetNetCode(), NETINFO_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, EDA_ITEM::m_Uuid, MINOPTMAX< T >::Min(), pad, PCB_PAD_T, PCB_TRACE_T, PCB_VIA_T, DRC_TEST_PROVIDER_CLEARANCE_BASE::ReportAndShowPathCuToCu(), DRC_TEST_PROVIDER::reportViolation(), RPT_SEVERITY_IGNORE, and EDA_ITEM::Type().

Referenced by testGraphicClearances(), and testTrackClearances().

◆ testTrackClearances()

void DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackClearances ( )
private

Definition at line 584 of file drc_test_provider_copper_clearance.cpp.

References LSET::AllCuMask(), BOARD::GetCopperLayerCount(), BOARD_ITEM::GetEffectiveShape(), PCB_TRACK::GetEffectiveShape(), GetKiCadThreadPool(), PCB_TRACK::GetLayerSet(), BOARD_CONNECTED_ITEM::GetNetCode(), DRC_ENGINE::GetReportAllTrackErrors(), DRC_ENGINE::IsCancelled(), DRC_TEST_PROVIDER_CLEARANCE_BASE::m_board, BOARD::m_CopperItemRTreeCache, BOARD::m_DRCCopperZones, DRC_TEST_PROVIDER::m_drcEngine, BOARD::m_DRCMaxClearance, PCB_PAD_T, REPORT_AUX, DRC_TEST_PROVIDER::reportProgress(), testItemAgainstZone(), testSingleLayerItemAgainstItem(), tp, BOARD::Tracks(), and EDA_ITEM::Type().

Referenced by Run().

◆ testZonesToZones()

void DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones ( )
private

Definition at line 1195 of file drc_test_provider_copper_clearance.cpp.

References _, SEG::A, actual, SEG::B, B_Cu, SHAPE_POLY_SET::BBoxFromCaches(), clearance, CLEARANCE_CONSTRAINT, SHAPE_POLY_SET::Collide(), DRC_ITEM::Create(), DRCE_CLEARANCE, DRCE_ZONES_INTERSECT, DRC_ENGINE::EvalRules(), F_Cu, DRC_TEST_PROVIDER::formatMsg(), ZONE::GetAssignedPriority(), BOARD::GetCopperLayerCount(), ZONE::GetFill(), ZONE::GetIsRuleArea(), GetKiCadThreadPool(), ZONE::GetLayerSet(), BOARD_CONNECTED_ITEM::GetNetCode(), DRC_CONSTRAINT::GetSeverity(), DRC_CONSTRAINT::GetValue(), BOX2< Vec >::Intersects(), DRC_ENGINE::IsCancelled(), IsCopperLayer(), DRC_ENGINE::IsErrorLimitExceeded(), BOARD::IsLayerEnabled(), DRC_TEST_PROVIDER_CLEARANCE_BASE::m_board, BOARD::m_DRCCopperZones, DRC_TEST_PROVIDER::m_drcEngine, MINOPTMAX< T >::Min(), ZONE::Outline(), DRC_TEST_PROVIDER_CLEARANCE_BASE::ReportAndShowPathCuToCu(), DRC_TEST_PROVIDER::reportProgress(), DRC_TEST_PROVIDER::reportViolation(), SEG::Reverse(), RPT_SEVERITY_IGNORE, tp, and VECTOR2< T >::x.

Referenced by Run().

◆ 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
aTypeis the type of this value, and controls the way the string is converted to a value
aTextValueA 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().

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_TEST_PROVIDER_CREEPAGE::CollectBoardEdges(), DRC_TEST_PROVIDER_CREEPAGE::CollectNetCodes(), DRC_TEST_PROVIDER_CREEPAGE::GetMaxConstraint(), DRC_INTERACTIVE_COURTYARD_CLEARANCE::Init(), DRC_CACHE_GENERATOR::Run(), Run(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::Run(), DRC_TEST_PROVIDER_CREEPAGE::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_CREEPAGE::testCreepage(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testFootprintCourtyardDefinitions(), testGraphicClearances(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), testKnockoutTextAgainstZone(), 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 127 of file drc_test_provider.h.

Referenced by DRC_TEST_PROVIDER_HOLE_SIZE::checkPadHole(), DRC_TEST_PROVIDER_HOLE_SIZE::checkViaHole(), DRC_TEST_PROVIDER::forEachGeometryItem(), DRC_TEST_PROVIDER::getLogReporter(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::layerDesc(), DRC_TEST_PROVIDER_SLIVER_CHECKER::layerDesc(), DRC_TEST_PROVIDER::reportPhase(), DRC_TEST_PROVIDER::reportProgress(), DRC_TEST_PROVIDER::reportViolation(), DRC_CACHE_GENERATOR::Run(), DRC_INTERACTIVE_COURTYARD_CLEARANCE::Run(), DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), 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_SCHEMATIC_PARITY::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_ZONE_CONNECTIONS::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), DRC_TEST_PROVIDER::SetDRCEngine(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_MISC::testAssertions(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_CREEPAGE::testCreepage(), DRC_TEST_PROVIDER_MISC::testDisabledLayers(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testFootprintCourtyardDefinitions(), testGraphicClearances(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::testHoleAgainstHole(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), testKnockoutTextAgainstZone(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), DRC_TEST_PROVIDER_MISC::testOutline(), testPadAgainstItem(), testPadClearances(), DRC_TEST_PROVIDER_SOLDER_MASK::testSilkToMaskClearance(), testSingleLayerItemAgainstItem(), DRC_TEST_PROVIDER_MISC::testTextVars(), testTrackClearances(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testZoneLayer(), and testZonesToZones().

◆ m_drcEpsilon

int DRC_TEST_PROVIDER_COPPER_CLEARANCE::m_drcEpsilon
private

Definition at line 101 of file drc_test_provider_copper_clearance.cpp.

Referenced by Run(), testItemAgainstZone(), testKnockoutTextAgainstZone(), testPadAgainstItem(), and testSingleLayerItemAgainstItem().

◆ m_isRuleDriven

bool DRC_TEST_PROVIDER::m_isRuleDriven = true
protectedinherited

Definition at line 128 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(), and DRC_TEST_PROVIDER_SCHEMATIC_PARITY::DRC_TEST_PROVIDER_SCHEMATIC_PARITY().

◆ 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_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().

◆ 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().

◆ s_allBasicItems

std::vector< KICAD_T > DRC_TEST_PROVIDER::s_allBasicItems
staticprotectedinherited

Definition at line 123 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 124 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: