DRC_TEST_PROVIDER_HOLE_TO_HOLE Class Reference

Inheritance diagram for DRC_TEST_PROVIDER_HOLE_TO_HOLE:

Public Member Functions
	DRC_TEST_PROVIDER_HOLE_TO_HOLE ()
virtual	~DRC_TEST_PROVIDER_HOLE_TO_HOLE ()
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
virtual std::set< DRC_CONSTRAINT_T >	GetConstraintTypes () const override
int	GetNumPhases () const override
void	SetDRCEngine (DRC_ENGINE *engine)
virtual bool	IsRuleDriven () const
bool	IsEnabled () const
void	Enable (bool aEnable)

Protected Member Functions
int	forEachGeometryItem (const std::vector< KICAD_T > &aTypes, LSET aLayers, const std::function< bool(BOARD_ITEM *)> &aFunc)
virtual void	reportAux (wxString fmt,...)
virtual void	reportViolation (std::shared_ptr< DRC_ITEM > &item, const wxPoint &aMarkerPos)
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
EDA_UNITS	userUnits () const

Protected Attributes
int	m_largestClearance
bool	m_boardOutlineValid
DRC_ENGINE *	m_drcEngine
std::unordered_map< const DRC_RULE *, int >	m_stats
bool	m_isRuleDriven = true
bool	m_enabled = true
wxString	m_msg

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

Private Member Functions
bool	testHoleAgainstHole (BOARD_ITEM *aItem, SHAPE_CIRCLE *aHole, BOARD_ITEM *aOther)

Private Attributes
BOARD *	m_board
DRC_RTREE	m_holeTree

Detailed Description

Definition at line 46 of file drc_test_provider_hole_to_hole.cpp.

Constructor & Destructor Documentation

DRC_TEST_PROVIDER_HOLE_TO_HOLE()

DRC_TEST_PROVIDER_HOLE_TO_HOLE::DRC_TEST_PROVIDER_HOLE_TO_HOLE ( )

inline

Definition at line 49 of file drc_test_provider_hole_to_hole.cpp.

 :
 DRC_TEST_PROVIDER_CLEARANCE_BASE(),
 m_board( nullptr )
 {
 }

~DRC_TEST_PROVIDER_HOLE_TO_HOLE()

virtual DRC_TEST_PROVIDER_HOLE_TO_HOLE::~DRC_TEST_PROVIDER_HOLE_TO_HOLE ( )

inlinevirtual

Definition at line 55 of file drc_test_provider_hole_to_hole.cpp.

 {
 }

Member Function Documentation

accountCheck() [1/2]

void DRC_TEST_PROVIDER::accountCheck ( const DRC_RULE *  ruleToTest )

protectedvirtualinherited

Definition at line 103 of file drc_test_provider.cpp.

{
 auto it = m_stats.find( ruleToTest );

 if( it == m_stats.end() )
 m_stats[ ruleToTest ] = 1;
 else
 m_stats[ ruleToTest ] += 1;
}

References DRC_TEST_PROVIDER::m_stats.

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

accountCheck() [2/2]

void DRC_TEST_PROVIDER::accountCheck ( const DRC_CONSTRAINT &  constraintToTest )

protectedvirtualinherited

Definition at line 114 of file drc_test_provider.cpp.

{
 accountCheck( constraintToTest.GetParentRule() );
}

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

Enable()

void DRC_TEST_PROVIDER::Enable ( bool  aEnable )

inlineinherited

Definition at line 106 of file drc_test_provider.h.

 {
 m_enabled = aEnable;
 }

References DRC_TEST_PROVIDER::m_enabled.

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

{
 BOARD *brd = m_drcEngine->GetBoard();
 std::bitset<MAX_STRUCT_TYPE_ID> typeMask;
 int n = 0;

 if( s_allBasicItems.size() == 0 )
 {
 for( int i = 0; i < MAX_STRUCT_TYPE_ID; i++ )
 {
 if( i != PCB_FOOTPRINT_T && i != PCB_GROUP_T )
 {
 s_allBasicItems.push_back( (KICAD_T) i );

 if( i != PCB_ZONE_T && i != PCB_FP_ZONE_T )
 s_allBasicItemsButZones.push_back( (KICAD_T) i );
 }
 }
 }

 if( aTypes.size() == 0 )
 {
 for( int i = 0; i < MAX_STRUCT_TYPE_ID; i++ )
 typeMask[ i ] = true;
 }
 else
 {
 for( KICAD_T aType : aTypes )
 typeMask[ aType ] = true;
 }

 for( PCB_TRACK* item : brd->Tracks() )
 {
 if( (item->GetLayerSet() & aLayers).any() )
 {
 if( typeMask[ PCB_TRACE_T ] && item->Type() == PCB_TRACE_T )
 {
 aFunc( item );
 n++;
 }
 else if( typeMask[ PCB_VIA_T ] && item->Type() == PCB_VIA_T )
 {
 aFunc( item );
 n++;
 }
 else if( typeMask[ PCB_ARC_T ] && item->Type() == PCB_ARC_T )
 {
 aFunc( item );
 n++;
 }
 }
 }

 for( BOARD_ITEM* item : brd->Drawings() )
 {
 if( (item->GetLayerSet() & aLayers).any() )
 {
 if( typeMask[PCB_DIMENSION_T] && BaseType( item->Type() ) == PCB_DIMENSION_T )
 {
 if( !aFunc( item ) )
 return n;

 n++;
 }
 else if( typeMask[ PCB_SHAPE_T ] && item->Type() == PCB_SHAPE_T )
 {
 if( !aFunc( item ) )
 return n;

 n++;
 }
 else if( typeMask[ PCB_TEXT_T ] && item->Type() == PCB_TEXT_T )
 {
 if( !aFunc( item ) )
 return n;

 n++;
 }
 else if( typeMask[ PCB_TARGET_T ] && item->Type() == PCB_TARGET_T )
 {
 if( !aFunc( item ) )
 return n;

 n++;
 }
 }
 }

 if( typeMask[ PCB_ZONE_T ] )
 {
 for( ZONE* item : brd->Zones() )
 {
 if( ( item->GetLayerSet() & aLayers ).any() )
 {
 if( !aFunc( item ) )
 return n;

 n++;
 }
 }
 }

 for( FOOTPRINT* footprint : brd->Footprints() )
 {
 if( typeMask[ PCB_FP_TEXT_T ] )
 {
 if( ( footprint->Reference().GetLayerSet() & aLayers ).any() )
 {
 if( !aFunc( &footprint->Reference() ) )
 return n;

 n++;
 }

 if( ( footprint->Value().GetLayerSet() & aLayers ).any() )
 {
 if( !aFunc( &footprint->Value() ) )
 return n;

 n++;
 }
 }

 if( typeMask[ PCB_PAD_T ] )
 {
 for( PAD* pad : footprint->Pads() )
 {
 // Careful: if a pad has a hole then it pierces all layers
 if( ( pad->GetDrillSizeX() > 0 && pad->GetDrillSizeY() > 0 )
 || ( pad->GetLayerSet() & aLayers ).any() )
 {
 if( !aFunc( pad ) )
 return n;

 n++;
 }
 }
 }

 for( BOARD_ITEM* dwg : footprint->GraphicalItems() )
 {
 if( (dwg->GetLayerSet() & aLayers).any() )
 {
 if( typeMask[ PCB_FP_TEXT_T ] && dwg->Type() == PCB_FP_TEXT_T )
 {
 if( !aFunc( dwg ) )
 return n;

 n++;
 }
 else if( typeMask[ PCB_FP_SHAPE_T ] && dwg->Type() == PCB_FP_SHAPE_T )
 {
 if( !aFunc( dwg ) )
 return n;

 n++;
 }
 }
 }

 if( typeMask[ PCB_FP_ZONE_T ] )
 {
 for( ZONE* zone : footprint->Zones() )
 {
 if( (zone->GetLayerSet() & aLayers).any() )
 {
 if( !aFunc( zone ) )
 return n;

 n++;
 }
 }
 }

 if( typeMask[ PCB_FOOTPRINT_T ] )
 {
 if( !aFunc( footprint ) )
 return n;

 n++;
 }
 }

 return n;
}

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_FP_SHAPE_T, PCB_FP_TEXT_T, PCB_FP_ZONE_T, PCB_GROUP_T, PCB_PAD_T, PCB_SHAPE_T, PCB_TARGET_T, PCB_TEXT_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, DRC_TEST_PROVIDER::s_allBasicItems, DRC_TEST_PROVIDER::s_allBasicItemsButZones, BOARD::Tracks(), and BOARD::Zones().

Referenced by DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_SILK_TO_MASK::Run(), Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), DRC_TEST_PROVIDER_MISC::testDisabledLayers(), and DRC_TEST_PROVIDER_MISC::testTextVars().

GetConstraintTypes()

std::set< DRC_CONSTRAINT_T > DRC_TEST_PROVIDER_HOLE_TO_HOLE::GetConstraintTypes ( ) const

overridevirtual

Implements DRC_TEST_PROVIDER.

Definition at line 336 of file drc_test_provider_hole_to_hole.cpp.

{
 return { HOLE_TO_HOLE_CONSTRAINT };
}

References HOLE_TO_HOLE_CONSTRAINT.

GetDescription()

virtual const wxString DRC_TEST_PROVIDER_HOLE_TO_HOLE::GetDescription ( ) const

inlineoverridevirtual

Reimplemented from DRC_TEST_PROVIDER.

Definition at line 66 of file drc_test_provider_hole_to_hole.cpp.

 {
 return "Tests hole to hole spacing";
 }

GetName()

virtual const wxString DRC_TEST_PROVIDER_HOLE_TO_HOLE::GetName ( void  ) const

inlineoverridevirtual

Reimplemented from DRC_TEST_PROVIDER.

Definition at line 61 of file drc_test_provider_hole_to_hole.cpp.

 {
 return "hole_to_hole_clearance";
 };

GetNumPhases()

int DRC_TEST_PROVIDER_HOLE_TO_HOLE::GetNumPhases ( ) const

overridevirtual

Implements DRC_TEST_PROVIDER.

Definition at line 330 of file drc_test_provider_hole_to_hole.cpp.

{
 return 1;
}

IsEnabled()

bool DRC_TEST_PROVIDER::IsEnabled ( ) const

inlineinherited

Definition at line 101 of file drc_test_provider.h.

 {
 return m_enabled;
 }

References DRC_TEST_PROVIDER::m_enabled.

isInvisibleText()

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

protectedinherited

Definition at line 327 of file drc_test_provider.cpp.

{

 if( const FP_TEXT* text = dyn_cast<const FP_TEXT*>( aItem ) )
 {
 if( !text->IsVisible() )
 return true;
 }

 if( const PCB_TEXT* text = dyn_cast<const PCB_TEXT*>( aItem ) )
 {
 if( !text->IsVisible() )
 return true;
 }

 return false;
}

References text.

Referenced by DRC_TEST_PROVIDER_SILK_TO_MASK::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), and DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run().

IsRuleDriven()

virtual bool DRC_TEST_PROVIDER::IsRuleDriven ( ) const

inlinevirtualinherited

Definition at line 96 of file drc_test_provider.h.

 {
 return m_isRuleDriven;
 }

References DRC_TEST_PROVIDER::m_isRuleDriven.

reportAux()

void DRC_TEST_PROVIDER::reportAux ( wxString  fmt,   ...  )

protectedvirtualinherited

Definition at line 86 of file drc_test_provider.cpp.

{
 va_list vargs;
 va_start( vargs, fmt );
 wxString str;
 str.PrintfV( fmt, vargs );
 va_end( vargs );
 m_drcEngine->ReportAux( str );
}

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

Referenced by DRC_TEST_PROVIDER::reportPhase(), DRC_TEST_PROVIDER_VIA_DIAMETER::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_SILK_TO_MASK::Run(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_LVS::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testFootprintCourtyardDefinitions(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadClearances(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackClearances().

reportPhase()

bool DRC_TEST_PROVIDER::reportPhase ( const wxString &  aStageName )

protectedvirtualinherited

Definition at line 79 of file drc_test_provider.cpp.

{
 reportAux( aMessage );
 return m_drcEngine->ReportPhase( aMessage );
}

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

Referenced by DRC_TEST_PROVIDER_VIA_DIAMETER::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_HOLE_SIZE::Run(), DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), DRC_TEST_PROVIDER_SILK_TO_MASK::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), Run(), DRC_TEST_PROVIDER_LVS::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_MISC::Run(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::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 ( int  aCount, int  aSize, int  aDelta  )

protectedvirtualinherited

Definition at line 67 of file drc_test_provider.cpp.

{
 if( ( aCount % aDelta ) == 0 || aCount == aSize - 1 )
 {
 if( !m_drcEngine->ReportProgress( (double) aCount / (double) aSize ) )
 return false;
 }

 return true;
}

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

Referenced by DRC_TEST_PROVIDER_VIA_DIAMETER::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), DRC_TEST_PROVIDER_SILK_TO_MASK::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::Run(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testFootprintCourtyardDefinitions(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadClearances(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackClearances(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones().

reportRuleStatistics()

void DRC_TEST_PROVIDER::reportRuleStatistics ( )

protectedvirtualinherited

Definition at line 120 of file drc_test_provider.cpp.

{
 if( !m_isRuleDriven )
 return;

 m_drcEngine->ReportAux( "Rule hit statistics: " );

 for( const std::pair<const DRC_RULE* const, int>& stat : m_stats )
 {
 if( stat.first )
 {
 m_drcEngine->ReportAux( wxString::Format( " - rule '%s': %d hits ",
 stat.first->m_Name,
 stat.second ) );
 }
 }
}

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

Referenced by DRC_TEST_PROVIDER_VIA_DIAMETER::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_HOLE_SIZE::Run(), DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), DRC_TEST_PROVIDER_SILK_TO_MASK::Run(), Run(), DRC_TEST_PROVIDER_LVS::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::Run(), and DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal().

reportViolation()

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

protectedvirtualinherited

Definition at line 56 of file drc_test_provider.cpp.

{
 if( item->GetViolatingRule() )
 accountCheck( item->GetViolatingRule() );

 item->SetViolatingTest( this );
 m_drcEngine->ReportViolation( item, aMarkerPos );
}

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

Referenced by DRC_TEST_PROVIDER_MATCHED_LENGTH::checkLengths(), DRC_TEST_PROVIDER_HOLE_SIZE::checkPad(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkSkews(), DRC_TEST_PROVIDER_HOLE_SIZE::checkVia(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkViaCounts(), DRC_TEST_PROVIDER_VIA_DIAMETER::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), DRC_TEST_PROVIDER_SILK_TO_MASK::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_MISC::testDisabledLayers(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testFootprintCourtyardDefinitions(), DRC_TEST_PROVIDER_LVS::testFootprints(), testHoleAgainstHole(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_MISC::testOutline(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_MISC::testTextVars(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones().

Run()

bool DRC_TEST_PROVIDER_HOLE_TO_HOLE::Run ( )

overridevirtual

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

Implements DRC_TEST_PROVIDER.

Definition at line 100 of file drc_test_provider_hole_to_hole.cpp.

{
 if( m_drcEngine->IsErrorLimitExceeded( DRCE_DRILLED_HOLES_TOO_CLOSE )
 && m_drcEngine->IsErrorLimitExceeded( DRCE_DRILLED_HOLES_COLOCATED ) )
 {
 reportAux( "Hole to hole violations ignored. Tests not run." );
 return true; // continue with other tests
 }

 m_board = m_drcEngine->GetBoard();

 DRC_CONSTRAINT worstClearanceConstraint;

 if( m_drcEngine->QueryWorstConstraint( HOLE_TO_HOLE_CONSTRAINT, worstClearanceConstraint ) )
 {
 m_largestClearance = worstClearanceConstraint.GetValue().Min();
 reportAux( "Worst hole to hole : %d nm", m_largestClearance );
 }
 else
 {
 reportAux( "No hole to hole constraints found. Skipping check." );
 return true; // continue with other tests
 }

 if( !reportPhase( _( "Checking hole to hole clearances..." ) ) )
 return false; // DRC cancelled

 // This is the number of tests between 2 calls to the progress bar
 const size_t delta = 50;
 size_t count = 0;
 size_t ii = 0;

 m_holeTree.clear();

 auto countItems =
 [&]( BOARD_ITEM* item ) -> bool
 {
 if( item->Type() == PCB_PAD_T )
 ++count;
 else if( item->Type() == PCB_VIA_T )
 ++count;

 return true;
 };

 auto addToHoleTree =
 [&]( BOARD_ITEM* item ) -> bool
 {
 if( !reportProgress( ii++, count, delta ) )
 return false;

 if( item->Type() == PCB_PAD_T )
 {
 PAD* pad = static_cast<PAD*>( item );

 // We only care about drilled (ie: round) holes
 if( pad->GetDrillSize().x && pad->GetDrillSize().x == pad->GetDrillSize().y )
 m_holeTree.Insert( item, F_Cu, m_largestClearance );
 }
 else if( item->Type() == PCB_VIA_T )
 {
 PCB_VIA* via = static_cast<PCB_VIA*>( item );

 // We only care about mechanically drilled (ie: non-laser) holes
 if( via->GetViaType() == VIATYPE::THROUGH )
 m_holeTree.Insert( item, F_Cu, m_largestClearance );
 }

 return true;
 };

 forEachGeometryItem( { PCB_PAD_T, PCB_VIA_T }, LSET::AllLayersMask(), countItems );

 count *= 2; // One for adding to tree; one for checking

 forEachGeometryItem( { PCB_PAD_T, PCB_VIA_T }, LSET::AllLayersMask(), addToHoleTree );

 std::map< std::pair<BOARD_ITEM*, BOARD_ITEM*>, int> checkedPairs;

 for( PCB_TRACK* track : m_board->Tracks() )
 {
 if( track->Type() != PCB_VIA_T )
 continue;

 PCB_VIA* via = static_cast<PCB_VIA*>( track );

 if( !reportProgress( ii++, count, delta ) )
 return false; // DRC cancelled

 // We only care about mechanically drilled (ie: non-laser) holes
 if( via->GetViaType() == VIATYPE::THROUGH )
 {
 std::shared_ptr<SHAPE_CIRCLE> holeShape = getDrilledHoleShape( via );

 m_holeTree.QueryColliding( via, F_Cu, F_Cu,
 // Filter:
 [&]( BOARD_ITEM* other ) -> bool
 {
 BOARD_ITEM* a = via;
 BOARD_ITEM* b = other;

 // store canonical order so we don't collide in both directions
 // (a:b and b:a)
 if( static_cast<void*>( a ) > static_cast<void*>( b ) )
 std::swap( a, b );

 if( checkedPairs.count( { a, b } ) )
 {
 return false;
 }
 else
 {
 checkedPairs[ { a, b } ] = 1;
 return true;
 }
 },
 // Visitor:
 [&]( BOARD_ITEM* other ) -> bool
 {
 return testHoleAgainstHole( via, holeShape.get(), other );
 },
 m_largestClearance );
 }
 }

 checkedPairs.clear();

 for( FOOTPRINT* footprint : m_board->Footprints() )
 {
 for( PAD* pad : footprint->Pads() )
 {
 if( !reportProgress( ii++, count, delta ) )
 return false; // DRC cancelled

 // We only care about drilled (ie: round) holes
 if( pad->GetDrillSize().x && pad->GetDrillSize().x == pad->GetDrillSize().y )
 {
 std::shared_ptr<SHAPE_CIRCLE> holeShape = getDrilledHoleShape( pad );

 m_holeTree.QueryColliding( pad, F_Cu, F_Cu,
 // Filter:
 [&]( BOARD_ITEM* other ) -> bool
 {
 BOARD_ITEM* a = pad;
 BOARD_ITEM* b = other;

 // store canonical order so we don't collide in both directions
 // (a:b and b:a)
 if( static_cast<void*>( a ) > static_cast<void*>( b ) )
 std::swap( a, b );

 if( checkedPairs.count( { a, b } ) )
 {
 return false;
 }
 else
 {
 checkedPairs[ { a, b } ] = 1;
 return true;
 }
 },
 // Visitor:
 [&]( BOARD_ITEM* other ) -> bool
 {
 return testHoleAgainstHole( pad, holeShape.get(), other );
 },
 m_largestClearance );
 }
 }
 }

 reportRuleStatistics();

 return true;
}

References _, LSET::AllLayersMask(), DRC_RTREE::clear(), delta, DRCE_DRILLED_HOLES_COLOCATED, DRCE_DRILLED_HOLES_TOO_CLOSE, F_Cu, BOARD::Footprints(), DRC_TEST_PROVIDER::forEachGeometryItem(), DRC_ENGINE::GetBoard(), getDrilledHoleShape(), DRC_CONSTRAINT::GetValue(), HOLE_TO_HOLE_CONSTRAINT, DRC_RTREE::Insert(), DRC_ENGINE::IsErrorLimitExceeded(), m_board, DRC_TEST_PROVIDER::m_drcEngine, m_holeTree, DRC_TEST_PROVIDER_CLEARANCE_BASE::m_largestClearance, MINOPTMAX< T >::Min(), pad, PCB_PAD_T, PCB_VIA_T, DRC_RTREE::QueryColliding(), DRC_ENGINE::QueryWorstConstraint(), DRC_TEST_PROVIDER::reportAux(), DRC_TEST_PROVIDER::reportPhase(), DRC_TEST_PROVIDER::reportProgress(), DRC_TEST_PROVIDER::reportRuleStatistics(), testHoleAgainstHole(), THROUGH, BOARD::Tracks(), and via.

SetDRCEngine()

void DRC_TEST_PROVIDER::SetDRCEngine ( DRC_ENGINE *  engine )

inlineinherited

Definition at line 78 of file drc_test_provider.h.

 {
 m_drcEngine = engine;
 m_stats.clear();
 }

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

testHoleAgainstHole()

bool DRC_TEST_PROVIDER_HOLE_TO_HOLE::testHoleAgainstHole ( BOARD_ITEM *  aItem, SHAPE_CIRCLE *  aHole, BOARD_ITEM *  aOther  )

private

Definition at line 277 of file drc_test_provider_hole_to_hole.cpp.

{
 bool reportCoLocation = !m_drcEngine->IsErrorLimitExceeded( DRCE_DRILLED_HOLES_COLOCATED );
 bool reportHole2Hole = !m_drcEngine->IsErrorLimitExceeded( DRCE_DRILLED_HOLES_TOO_CLOSE );

 if( !reportCoLocation && !reportHole2Hole )
 return false;

 std::shared_ptr<SHAPE_CIRCLE> otherHole = getDrilledHoleShape( aOther );
 int epsilon = m_board->GetDesignSettings().GetDRCEpsilon();
 SEG::ecoord epsilon_sq = SEG::Square( epsilon );

 // Holes at same location generate a separate violation
 if( ( aHole->GetCenter() - otherHole->GetCenter() ).SquaredEuclideanNorm() < epsilon_sq )
 {
 if( reportCoLocation )
 {
 std::shared_ptr<DRC_ITEM> drce = DRC_ITEM::Create( DRCE_DRILLED_HOLES_COLOCATED );
 drce->SetItems( aItem, aOther );
 reportViolation( drce, (wxPoint) aHole->GetCenter() );
 }
 }
 else if( reportHole2Hole )
 {
 int actual = ( aHole->GetCenter() - otherHole->GetCenter() ).EuclideanNorm();
 actual = std::max( 0, actual - aHole->GetRadius() - otherHole->GetRadius() );

 auto constraint = m_drcEngine->EvalRules( HOLE_TO_HOLE_CONSTRAINT, aItem, aOther,
 UNDEFINED_LAYER /* holes pierce all layers */ );
 int minClearance = constraint.GetValue().Min() - epsilon;

 if( minClearance >= 0 && actual < minClearance )
 {
 std::shared_ptr<DRC_ITEM> drce = DRC_ITEM::Create( DRCE_DRILLED_HOLES_TOO_CLOSE );

 m_msg.Printf( _( "(%s min %s; actual %s)" ),
 constraint.GetName(),
 MessageTextFromValue( userUnits(), minClearance ),
 MessageTextFromValue( userUnits(), actual ) );

 drce->SetErrorMessage( drce->GetErrorText() + wxS( " " ) + m_msg );
 drce->SetItems( aItem, aOther );
 drce->SetViolatingRule( constraint.GetParentRule() );

 reportViolation( drce, (wxPoint) aHole->GetCenter() );
 }
 }

 return true;
}

References _, DRC_ITEM::Create(), DRCE_DRILLED_HOLES_COLOCATED, DRCE_DRILLED_HOLES_TOO_CLOSE, EuclideanNorm(), DRC_ENGINE::EvalRules(), SHAPE_CIRCLE::GetCenter(), BOARD::GetDesignSettings(), BOARD_DESIGN_SETTINGS::GetDRCEpsilon(), getDrilledHoleShape(), SHAPE_CIRCLE::GetRadius(), DRC_CONSTRAINT::GetValue(), HOLE_TO_HOLE_CONSTRAINT, DRC_ENGINE::IsErrorLimitExceeded(), m_board, DRC_TEST_PROVIDER::m_drcEngine, DRC_TEST_PROVIDER::m_msg, MessageTextFromValue(), MINOPTMAX< T >::Min(), DRC_TEST_PROVIDER::reportViolation(), SEG::Square(), UNDEFINED_LAYER, and DRC_TEST_PROVIDER::userUnits().

Referenced by Run().

userUnits()

EDA_UNITS DRC_TEST_PROVIDER::userUnits ( ) const

protectedinherited

Definition at line 97 of file drc_test_provider.cpp.

{
 return m_drcEngine->UserUnits();
}

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

Referenced by DRC_TEST_PROVIDER_MATCHED_LENGTH::checkLengths(), DRC_TEST_PROVIDER_HOLE_SIZE::checkPad(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkSkews(), DRC_TEST_PROVIDER_HOLE_SIZE::checkVia(), DRC_TEST_PROVIDER_VIA_DIAMETER::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_SILK_TO_MASK::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), testHoleAgainstHole(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones().

Member Data Documentation

m_board

BOARD* DRC_TEST_PROVIDER_HOLE_TO_HOLE::m_board

private

Definition at line 78 of file drc_test_provider_hole_to_hole.cpp.

Referenced by Run(), and testHoleAgainstHole().

m_boardOutlineValid

bool DRC_TEST_PROVIDER_CLEARANCE_BASE::m_boardOutlineValid

protectedinherited

Definition at line 53 of file drc_test_provider_clearance_base.h.

m_drcEngine

DRC_ENGINE* DRC_TEST_PROVIDER::m_drcEngine

protectedinherited

Definition at line 131 of file drc_test_provider.h.

Referenced by DRC_TEST_PROVIDER_HOLE_SIZE::checkPad(), DRC_TEST_PROVIDER_HOLE_SIZE::checkVia(), DRC_TEST_PROVIDER::forEachGeometryItem(), DRC_TEST_PROVIDER_LVS::GetNumPhases(), DRC_TEST_PROVIDER::reportAux(), DRC_TEST_PROVIDER::reportPhase(), DRC_TEST_PROVIDER::reportProgress(), DRC_TEST_PROVIDER::reportRuleStatistics(), DRC_TEST_PROVIDER::reportViolation(), DRC_TEST_PROVIDER_VIA_DIAMETER::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_HOLE_SIZE::Run(), DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), DRC_TEST_PROVIDER_SILK_TO_MASK::Run(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::Run(), DRC_TEST_PROVIDER_MISC::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), Run(), DRC_TEST_PROVIDER_LVS::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), DRC_TEST_PROVIDER::SetDRCEngine(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testFootprintCourtyardDefinitions(), DRC_TEST_PROVIDER_LVS::testFootprints(), testHoleAgainstHole(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_MISC::testTextVars(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones(), and DRC_TEST_PROVIDER::userUnits().

m_enabled

bool DRC_TEST_PROVIDER::m_enabled = true

protectedinherited

Definition at line 134 of file drc_test_provider.h.

Referenced by DRC_TEST_PROVIDER::Enable(), and DRC_TEST_PROVIDER::IsEnabled().

m_holeTree

DRC_RTREE DRC_TEST_PROVIDER_HOLE_TO_HOLE::m_holeTree

private

Definition at line 79 of file drc_test_provider_hole_to_hole.cpp.

Referenced by Run().

m_isRuleDriven

bool DRC_TEST_PROVIDER::m_isRuleDriven = true

protectedinherited

Definition at line 133 of file drc_test_provider.h.

Referenced by DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::DRC_TEST_PROVIDER_COURTYARD_CLEARANCE(), DRC_TEST_PROVIDER_LVS::DRC_TEST_PROVIDER_LVS(), DRC_TEST_PROVIDER_MISC::DRC_TEST_PROVIDER_MISC(), DRC_TEST_PROVIDER::IsRuleDriven(), and DRC_TEST_PROVIDER::reportRuleStatistics().

m_largestClearance

int DRC_TEST_PROVIDER_CLEARANCE_BASE::m_largestClearance

protectedinherited

Definition at line 52 of file drc_test_provider_clearance_base.h.

Referenced by DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::Run(), Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::Run(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadClearances(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackClearances().

m_msg

wxString DRC_TEST_PROVIDER::m_msg

protectedinherited

Definition at line 136 of file drc_test_provider.h.

Referenced by DRC_TEST_PROVIDER_MATCHED_LENGTH::checkLengths(), DRC_TEST_PROVIDER_HOLE_SIZE::checkPad(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkSkews(), DRC_TEST_PROVIDER_HOLE_SIZE::checkVia(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkViaCounts(), DRC_TEST_PROVIDER_VIA_DIAMETER::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_SILK_TO_MASK::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_MISC::testDisabledLayers(), DRC_TEST_PROVIDER_LVS::testFootprints(), testHoleAgainstHole(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_MISC::testOutline(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones().

m_stats

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

protectedinherited

Definition at line 132 of file drc_test_provider.h.

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

s_allBasicItems

std::vector< KICAD_T > DRC_TEST_PROVIDER::s_allBasicItems

staticprotectedinherited

Definition at line 127 of file drc_test_provider.h.

Referenced by DRC_TEST_PROVIDER::forEachGeometryItem(), DRC_TEST_PROVIDER_SILK_TO_MASK::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), and DRC_TEST_PROVIDER_MISC::testDisabledLayers().

s_allBasicItemsButZones

std::vector< KICAD_T > DRC_TEST_PROVIDER::s_allBasicItemsButZones

staticprotectedinherited

Definition at line 128 of file drc_test_provider.h.

Referenced by DRC_TEST_PROVIDER::forEachGeometryItem(), and DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run().

---

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

• drc_test_provider_hole_to_hole.cpp