KiCad PCB EDA Suite
Loading...
Searching...
No Matches
ERC_TESTER Class Reference

#include <erc.h>

Public Member Functions

 ERC_TESTER (SCHEMATIC *aSchematic)
 
int TestDuplicateSheetNames (bool aCreateMarker)
 Inside a given sheet, one cannot have sheets with duplicate names (file names can be duplicated).
 
void TestTextVars (DS_PROXY_VIEW_ITEM *aDrawingSheet)
 Check for any unresolved text variable references.
 
int TestConflictingBusAliases ()
 Check that there are no conflicting bus alias definitions in the schematic.
 
int TestMultiunitFootprints ()
 Test if all units of each multiunit symbol have the same footprint assigned.
 
int TestNoConnectPins ()
 In KiCad 5 and earlier, you could connect stuff up to pins with NC electrical type.
 
int TestPinToPin ()
 Checks the full netlist against the pin-to-pin connectivity requirements.
 
int TestMultUnitPinConflicts ()
 Checks if shared pins on multi-unit symbols have been connected to different nets.
 
int TestSimilarLabels ()
 Checks for labels that differ only in capitalization.
 
int TestFourWayJunction ()
 Test to see if there are potentially confusing 4-way junctions in the schematic.
 
int TestLabelMultipleWires ()
 Test to see if there are labels that are connected to more than one wire.
 
int TestLibSymbolIssues ()
 Test symbols for changed library symbols and broken symbol library links.
 
int TestFootprintLinkIssues (KIFACE *aCvPcb, PROJECT *aProject)
 Test footprint links against the current footprint libraries.
 
int TestOffGridEndpoints ()
 Test pins and wire ends for being off grid.
 
int TestSimModelIssues ()
 Test SPICE models for various issues.
 
int TestMissingUnits ()
 Test for uninstantiated units of multi unit symbols.
 
int TestMissingNetclasses ()
 Tests for netclasses that are referenced but not defined.
 
int RunRuleAreaERC ()
 Tests for rule area ERC issues.
 
int TestRuleAreaOverlappingRuleAreasERC (std::map< SCH_SCREEN *, std::vector< SCH_RULE_AREA * > > &allScreenRuleAreas)
 Runs ERC to check for overlapping rule areas.
 
void RunTests (DS_PROXY_VIEW_ITEM *aDrawingSheet, SCH_EDIT_FRAME *aEditFrame, KIFACE *aCvPcb, PROJECT *aProject, PROGRESS_REPORTER *aProgressReporter)
 

Private Attributes

SCHEMATICm_schematic
 
ERC_SETTINGSm_settings
 
SCH_SHEET_LIST m_sheetList
 
SCH_SCREENS m_screens
 
SCH_MULTI_UNIT_REFERENCE_MAP m_refMap
 
const NET_MAPm_nets
 

Detailed Description

Definition at line 51 of file erc.h.

Constructor & Destructor Documentation

◆ ERC_TESTER()

ERC_TESTER::ERC_TESTER ( SCHEMATIC aSchematic)
inline

Definition at line 55 of file erc.h.

References SCH_SHEET_LIST::GetMultiUnitSymbols(), m_refMap, and m_sheetList.

Member Function Documentation

◆ RunRuleAreaERC()

int ERC_TESTER::RunRuleAreaERC ( )

◆ RunTests()

void ERC_TESTER::RunTests ( DS_PROXY_VIEW_ITEM aDrawingSheet,
SCH_EDIT_FRAME aEditFrame,
KIFACE aCvPcb,
PROJECT aProject,
PROGRESS_REPORTER aProgressReporter 
)

◆ TestConflictingBusAliases()

int ERC_TESTER::TestConflictingBusAliases ( )

Check that there are no conflicting bus alias definitions in the schematic.

(for example, two hierarchical sub-sheets contain different definitions for the same bus alias)

Returns
the error count

Definition at line 410 of file erc.cpp.

References _, ERC_ITEM::Create(), ERCE_BUS_ALIAS_CONFLICT, SCH_SCREENS::GetFirst(), SCH_SCREENS::GetNext(), and m_screens.

Referenced by BOOST_FIXTURE_TEST_CASE(), and RunTests().

◆ TestDuplicateSheetNames()

int ERC_TESTER::TestDuplicateSheetNames ( bool  aCreateMarker)

Inside a given sheet, one cannot have sheets with duplicate names (file names can be duplicated).

Returns
the error count
Parameters
aCreateMarkertrue = create error markers in schematic, false = calculate error count only

Definition at line 138 of file erc.cpp.

References ERC_ITEM::Create(), ERCE_DUPLICATE_SHEET_NAME, SCH_SCREENS::GetFirst(), SCH_SCREENS::GetNext(), SCH_SHEET::GetPosition(), SCH_SHEET::GetShownName(), m_screens, and SCH_SHEET_T.

Referenced by RunTests().

◆ TestFootprintLinkIssues()

◆ TestFourWayJunction()

int ERC_TESTER::TestFourWayJunction ( )

Test to see if there are potentially confusing 4-way junctions in the schematic.

Definition at line 759 of file erc.cpp.

References _, ERC_ITEM::Create(), ERCE_FOUR_WAY_JUNCTION, SCH_LINE::GetConnectionPoints(), SCH_SYMBOL::GetPins(), SCH_LINE::IsGraphicLine(), SCH_SCREEN::Items(), m_sheetList, EE_RTREE::OfType(), pin, SCH_LINE_T, and SCH_SYMBOL_T.

Referenced by BOOST_FIXTURE_TEST_CASE(), and RunTests().

◆ TestLabelMultipleWires()

int ERC_TESTER::TestLabelMultipleWires ( )

Test to see if there are labels that are connected to more than one wire.

Definition at line 704 of file erc.cpp.

References _, ERC_ITEM::Create(), ERCE_LABEL_MULTIPLE_WIRES, SCH_LABEL_BASE::GetConnectionPoints(), SCH_LINE::IsEndPoint(), SCH_LINE::IsGraphicLine(), m_sheetList, SCH_LABEL_T, and SCH_LINE_T.

Referenced by BOOST_FIXTURE_TEST_CASE(), and RunTests().

◆ TestLibSymbolIssues()

◆ TestMissingNetclasses()

int ERC_TESTER::TestMissingNetclasses ( )

◆ TestMissingUnits()

◆ TestMultiunitFootprints()

int ERC_TESTER::TestMultiunitFootprints ( )

◆ TestMultUnitPinConflicts()

int ERC_TESTER::TestMultUnitPinConflicts ( )

Checks if shared pins on multi-unit symbols have been connected to different nets.

Returns
the error count

Definition at line 1028 of file erc.cpp.

References _, SCH_SCREEN::Append(), ERC_ITEM::Create(), ERCE_DIFFERENT_UNIT_NET, CONNECTION_SUBGRAPH::GetItems(), CONNECTION_SUBGRAPH::GetSheet(), SCH_SHEET_PATH::LastScreen(), m_nets, name, pin, and SCH_PIN_T.

Referenced by BOOST_FIXTURE_TEST_CASE(), and RunTests().

◆ TestNoConnectPins()

int ERC_TESTER::TestNoConnectPins ( )

In KiCad 5 and earlier, you could connect stuff up to pins with NC electrical type.

In KiCad 6, this no longer results in those pins joining the net, so we need to warn about it

Returns
the error count

Definition at line 813 of file erc.cpp.

References _, ERC_ITEM::Create(), ERCE_NOCONNECT_CONNECTED, SCH_SYMBOL::GetPins(), m_sheetList, pin, and SCH_SYMBOL_T.

Referenced by BOOST_FIXTURE_TEST_CASE(), and RunTests().

◆ TestOffGridEndpoints()

◆ TestPinToPin()

◆ TestRuleAreaOverlappingRuleAreasERC()

int ERC_TESTER::TestRuleAreaOverlappingRuleAreasERC ( std::map< SCH_SCREEN *, std::vector< SCH_RULE_AREA * > > &  allScreenRuleAreas)

Runs ERC to check for overlapping rule areas.

Definition at line 1530 of file erc.cpp.

References SCH_SCREEN::Append(), SHAPE_POLY_SET::Collide(), ERC_ITEM::Create(), ERCE_OVERLAPPING_RULE_AREAS, and SCH_SCREEN::GetClientSheetPaths().

Referenced by RunRuleAreaERC().

◆ TestSimilarLabels()

int ERC_TESTER::TestSimilarLabels ( )

◆ TestSimModelIssues()

int ERC_TESTER::TestSimModelIssues ( )

◆ TestTextVars()

Member Data Documentation

◆ m_nets

const NET_MAP& ERC_TESTER::m_nets
private

Definition at line 185 of file erc.h.

Referenced by TestMultUnitPinConflicts(), TestPinToPin(), and TestSimilarLabels().

◆ m_refMap

SCH_MULTI_UNIT_REFERENCE_MAP ERC_TESTER::m_refMap
private

Definition at line 184 of file erc.h.

Referenced by ERC_TESTER(), TestMissingUnits(), and TestMultiunitFootprints().

◆ m_schematic

◆ m_screens

SCH_SCREENS ERC_TESTER::m_screens
private

◆ m_settings

ERC_SETTINGS& ERC_TESTER::m_settings
private

Definition at line 181 of file erc.h.

Referenced by RunRuleAreaERC(), RunTests(), TestLibSymbolIssues(), TestMissingUnits(), and TestPinToPin().

◆ m_sheetList


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