Inheritance diagram for DRC_TEST_PROVIDER_MATCHED_LENGTH:

Public Member Functions
	DRC_TEST_PROVIDER_MATCHED_LENGTH ()

virtual	~DRC_TEST_PROVIDER_MATCHED_LENGTH ()

virtual bool	Run () override
	Runs 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 int	GetNumPhases () const override

virtual std::set< DRC_CONSTRAINT_T >	GetConstraintTypes () const override

DRC_LENGTH_REPORT	BuildLengthReport () const

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, 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
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 Types
using	LENGTH_ENTRY = DRC_LENGTH_REPORT::ENTRY

typedef std::set< BOARD_CONNECTED_ITEM * >	CITEMS

typedef std::vector< LENGTH_ENTRY >	LENGTH_ENTRIES

Private Member Functions
bool	runInternal (bool aDelayReportMode=false)

void	checkLengthViolations (DRC_CONSTRAINT &aConstraint, LENGTH_ENTRIES &aMatchedConnections)

void	checkSkewViolations (DRC_CONSTRAINT &aConstraint, LENGTH_ENTRIES &aMatchedConnections)

void	checkViaCountViolations (DRC_CONSTRAINT &aConstraint, LENGTH_ENTRIES &aMatchedConnections)

Private Attributes
BOARD *	m_board

DRC_LENGTH_REPORT	m_report

Detailed Description

Definition at line 44 of file drc_test_provider_matched_length.cpp.

Member Typedef Documentation

◆ CITEMS

typedef std::set<BOARD_CONNECTED_ITEM*> DRC_TEST_PROVIDER_MATCHED_LENGTH::CITEMS

private

Definition at line 82 of file drc_test_provider_matched_length.cpp.

◆ LENGTH_ENTRIES

typedef std::vector<LENGTH_ENTRY> DRC_TEST_PROVIDER_MATCHED_LENGTH::LENGTH_ENTRIES

private

Definition at line 83 of file drc_test_provider_matched_length.cpp.

◆ LENGTH_ENTRY

using DRC_TEST_PROVIDER_MATCHED_LENGTH::LENGTH_ENTRY = DRC_LENGTH_REPORT::ENTRY

private

Definition at line 81 of file drc_test_provider_matched_length.cpp.

Constructor & Destructor Documentation

◆ DRC_TEST_PROVIDER_MATCHED_LENGTH()

DRC_TEST_PROVIDER_MATCHED_LENGTH::DRC_TEST_PROVIDER_MATCHED_LENGTH ( )

inline

Definition at line 47 of file drc_test_provider_matched_length.cpp.

                                         :
         m_board( nullptr )
     {
     }

◆ ~DRC_TEST_PROVIDER_MATCHED_LENGTH()

virtual DRC_TEST_PROVIDER_MATCHED_LENGTH::~DRC_TEST_PROVIDER_MATCHED_LENGTH ( )

inlinevirtual

Definition at line 52 of file drc_test_provider_matched_length.cpp.

53 {

54 }

Member Function Documentation

◆ accountCheck() [1/2]

void DRC_TEST_PROVIDER::accountCheck ( const DRC_RULE * ruleToTest )

protectedvirtualinherited

Definition at line 102 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 113 of file drc_test_provider.cpp.

 {
     accountCheck( constraintToTest.GetParentRule() );
 }

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

◆ BuildLengthReport()

DRC_LENGTH_REPORT DRC_TEST_PROVIDER_MATCHED_LENGTH::BuildLengthReport ( ) const

◆ checkLengthViolations()

void DRC_TEST_PROVIDER_MATCHED_LENGTH::checkLengthViolations	(	DRC_CONSTRAINT &	aConstraint,
		LENGTH_ENTRIES &	aMatchedConnections
	)

private

Definition at line 100 of file drc_test_provider_matched_length.cpp.

 {
     for( const DRC_LENGTH_REPORT::ENTRY& ent : matchedConnections )
     {
         bool minViolation = false;
         bool maxViolation = false;
         int  minLen = 0;
         int  maxLen = 0;
 
         if( aConstraint.GetValue().HasMin() && ent.total < aConstraint.GetValue().Min() )
         {
             minViolation = true;
             minLen       = aConstraint.GetValue().Min();
         }
         else if( aConstraint.GetValue().HasMax() && ent.total > aConstraint.GetValue().Max() )
         {
             maxViolation = true;
             maxLen       = aConstraint.GetValue().Max();
         }
 
         if( ( minViolation || maxViolation ) )
         {
             std::shared_ptr<DRC_ITEM> drcItem = DRC_ITEM::Create( DRCE_LENGTH_OUT_OF_RANGE );
 
             if( minViolation )
             {
                 m_msg.Printf( _( "(%s min length: %s; actual: %s)" ),
                               aConstraint.GetName(),
                               MessageTextFromValue( userUnits(), minLen ),
                               MessageTextFromValue( userUnits(), ent.total ) );
             }
             else if( maxViolation )
             {
                 m_msg.Printf( _( "(%s max length: %s; actual: %s)" ),
                               aConstraint.GetName(),
                               MessageTextFromValue( userUnits(), maxLen ),
                               MessageTextFromValue( userUnits(), ent.total ) );
             }
 
             drcItem->SetErrorMessage( drcItem->GetErrorText() + wxS( " " ) + m_msg );
 
             for( auto offendingTrack : ent.items )
                 drcItem->AddItem( offendingTrack );
 
             drcItem->SetViolatingRule( aConstraint.GetParentRule() );
 
             reportViolation( drcItem, (*ent.items.begin() )->GetPosition() );
         }
     }
 }

References _, DRC_ITEM::Create(), DRCE_LENGTH_OUT_OF_RANGE, DRC_CONSTRAINT::GetName(), DRC_CONSTRAINT::GetParentRule(), DRC_CONSTRAINT::GetValue(), MINOPTMAX< T >::HasMax(), MINOPTMAX< T >::HasMin(), DRC_TEST_PROVIDER::m_msg, MINOPTMAX< T >::Max(), MessageTextFromValue(), MINOPTMAX< T >::Min(), DRC_TEST_PROVIDER::reportViolation(), and DRC_TEST_PROVIDER::userUnits().

Referenced by runInternal().

◆ checkSkewViolations()

void DRC_TEST_PROVIDER_MATCHED_LENGTH::checkSkewViolations	(	DRC_CONSTRAINT &	aConstraint,
		LENGTH_ENTRIES &	aMatchedConnections
	)

private

Definition at line 152 of file drc_test_provider_matched_length.cpp.

 {
     int avgLength = 0;
 
     for( const DRC_LENGTH_REPORT::ENTRY& ent : matchedConnections )
         avgLength += ent.total;
 
     avgLength /= matchedConnections.size();
 
     for( const auto& ent : matchedConnections )
     {
         int skew = ent.total - avgLength;
         if( aConstraint.GetValue().HasMax() && abs( skew ) > aConstraint.GetValue().Max() )
         {
             std::shared_ptr<DRC_ITEM> drcItem = DRC_ITEM::Create( DRCE_SKEW_OUT_OF_RANGE );
 
             m_msg.Printf( _( "(%s max skew: %s; actual: %s; average net length: %s; actual: %s)" ),
                           aConstraint.GetName(),
                           MessageTextFromValue( userUnits(), aConstraint.GetValue().Max() ),
                           MessageTextFromValue( userUnits(), skew ),
                           MessageTextFromValue( userUnits(), avgLength ),
                           MessageTextFromValue( userUnits(), ent.total ) );
 
             drcItem->SetErrorMessage( drcItem->GetErrorText() + " " + m_msg );
 
             for( BOARD_CONNECTED_ITEM* offendingTrack : ent.items )
                 drcItem->SetItems( offendingTrack );
 
             drcItem->SetViolatingRule( aConstraint.GetParentRule() );
 
             reportViolation( drcItem, (*ent.items.begin() )->GetPosition() );
         }
     }
 }

References _, DRC_ITEM::Create(), DRCE_SKEW_OUT_OF_RANGE, DRC_CONSTRAINT::GetName(), DRC_CONSTRAINT::GetParentRule(), DRC_CONSTRAINT::GetValue(), MINOPTMAX< T >::HasMax(), DRC_TEST_PROVIDER::m_msg, MINOPTMAX< T >::Max(), MessageTextFromValue(), DRC_TEST_PROVIDER::reportViolation(), and DRC_TEST_PROVIDER::userUnits().

Referenced by runInternal().

◆ checkViaCountViolations()

void DRC_TEST_PROVIDER_MATCHED_LENGTH::checkViaCountViolations	(	DRC_CONSTRAINT &	aConstraint,
		LENGTH_ENTRIES &	aMatchedConnections
	)

private

Definition at line 189 of file drc_test_provider_matched_length.cpp.

 {
     for( const auto& ent : matchedConnections )
     {
         if( aConstraint.GetValue().HasMax() && ent.viaCount > aConstraint.GetValue().Max() )
         {
             std::shared_ptr<DRC_ITEM> drcItem = DRC_ITEM::Create( DRCE_TOO_MANY_VIAS );
 
             m_msg.Printf( _( "(%s max count: %d; actual: %d)" ),
                           aConstraint.GetName(),
                           aConstraint.GetValue().Max(),
                           ent.viaCount );
 
             drcItem->SetErrorMessage( drcItem->GetErrorText() + wxS( " " ) + m_msg );
 
             for( auto offendingTrack : ent.items )
                 drcItem->SetItems( offendingTrack );
 
             drcItem->SetViolatingRule( aConstraint.GetParentRule() );
 
             reportViolation( drcItem, (*ent.items.begin() )->GetPosition() );
         }
     }
 }

References _, DRC_ITEM::Create(), DRCE_TOO_MANY_VIAS, DRC_CONSTRAINT::GetName(), DRC_CONSTRAINT::GetParentRule(), DRC_CONSTRAINT::GetValue(), MINOPTMAX< T >::HasMax(), DRC_TEST_PROVIDER::m_msg, MINOPTMAX< T >::Max(), and DRC_TEST_PROVIDER::reportViolation().

Referenced by runInternal().

◆ 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 138 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( 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_HOLE_CLEARANCE::Run(), DRC_TEST_PROVIDER_SILK_TO_MASK::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), runInternal(), DRC_TEST_PROVIDER_MISC::testDisabledLayers(), and DRC_TEST_PROVIDER_MISC::testTextVars().

◆ GetConstraintTypes()

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

overridevirtual

Implements DRC_TEST_PROVIDER.

Definition at line 390 of file drc_test_provider_matched_length.cpp.

 {
     return { LENGTH_CONSTRAINT, SKEW_CONSTRAINT, VIA_COUNT_CONSTRAINT };
 }

References LENGTH_CONSTRAINT, SKEW_CONSTRAINT, and VIA_COUNT_CONSTRAINT.

◆ GetDescription()

virtual const wxString DRC_TEST_PROVIDER_MATCHED_LENGTH::GetDescription ( ) const

inlineoverridevirtual

Reimplemented from DRC_TEST_PROVIDER.

Definition at line 63 of file drc_test_provider_matched_length.cpp.

     {
         return "Tests matched track lengths.";
     }

◆ GetName()

virtual const wxString DRC_TEST_PROVIDER_MATCHED_LENGTH::GetName ( void ) const

inlineoverridevirtual

Reimplemented from DRC_TEST_PROVIDER.

Definition at line 58 of file drc_test_provider_matched_length.cpp.

     {
         return "length";
     };

◆ GetNumPhases()

virtual int DRC_TEST_PROVIDER_MATCHED_LENGTH::GetNumPhases ( ) const

inlineoverridevirtual

Implements DRC_TEST_PROVIDER.

Definition at line 68 of file drc_test_provider_matched_length.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 326 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 85 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().

◆ reportPhase()

bool DRC_TEST_PROVIDER::reportPhase ( const wxString & aStageName )

protectedvirtualinherited

Definition at line 78 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_DISALLOW::Run(), DRC_TEST_PROVIDER_VIA_DIAMETER::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_HOLE_SIZE::Run(), DRC_TEST_PROVIDER_ANNULUS::Run(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), DRC_TEST_PROVIDER_SILK_TO_MASK::Run(), DRC_TEST_PROVIDER_HOLE_CLEARANCE::Run(), DRC_TEST_PROVIDER_MISC::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_LVS::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::Run(), 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 66 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_ANNULUS::Run(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), DRC_TEST_PROVIDER_HOLE_CLEARANCE::Run(), DRC_TEST_PROVIDER_SILK_TO_MASK::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_EDGE_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::testZones().

◆ reportRuleStatistics()

void DRC_TEST_PROVIDER::reportRuleStatistics ( )

protectedvirtualinherited

Definition at line 119 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().

◆ reportViolation()

void DRC_TEST_PROVIDER::reportViolation	(	std::shared_ptr< DRC_ITEM > &	item,
		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().

◆ Run()

bool DRC_TEST_PROVIDER_MATCHED_LENGTH::Run ( )

overridevirtual

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

Implements DRC_TEST_PROVIDER.

Definition at line 216 of file drc_test_provider_matched_length.cpp.

 {
     return runInternal( false );
 }

References runInternal().

◆ runInternal()

bool DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal ( bool aDelayReportMode = false )

private

Definition at line 222 of file drc_test_provider_matched_length.cpp.

 {
     m_board = m_drcEngine->GetBoard();
     m_report.Clear();
 
     if( !aDelayReportMode )
     {
         if( !reportPhase( _( "Gathering length-constrained connections..." ) ) )
             return false;
     }
 
     std::map<DRC_RULE*, CITEMS> itemSets;
 
     auto evaluateLengthConstraints =
             [&]( BOARD_ITEM *item ) -> bool
             {
                 const DRC_CONSTRAINT_T constraintsToCheck[] = {
                         LENGTH_CONSTRAINT,
                         SKEW_CONSTRAINT,
                         VIA_COUNT_CONSTRAINT,
                 };
 
                 for( int i = 0; i < 3; i++ )
                 {
                     auto constraint = m_drcEngine->EvalRules( constraintsToCheck[i], item, nullptr,
                                                               item->GetLayer() );
 
                     if( constraint.IsNull() )
                         continue;
 
                     auto citem = static_cast<BOARD_CONNECTED_ITEM*>( item );
 
                     itemSets[ constraint.GetParentRule() ].insert( citem );
                 }
 
                 return true;
             };
 
     auto ftCache = m_board->GetConnectivity()->GetFromToCache();
 
     ftCache->Rebuild( m_board );
 
     forEachGeometryItem( { PCB_TRACE_T, PCB_VIA_T, PCB_ARC_T }, LSET::AllCuMask(),
                          evaluateLengthConstraints );
 
     std::map<DRC_RULE*, LENGTH_ENTRIES> matches;
 
     for( auto it : itemSets )
     {
         std::map<int, CITEMS> netMap;
 
         for( auto citem : it.second )
             netMap[ citem->GetNetCode() ].insert( citem );
 
 
         for( auto nitem : netMap )
         {
             LENGTH_ENTRY ent;
             ent.items = nitem.second;
             ent.netcode = nitem.first;
             ent.netname = m_board->GetNetInfo().GetNetItem( ent.netcode )->GetNetname();
 
             ent.viaCount = 0;
             ent.totalRoute = 0;
             ent.totalVia = 0;
             ent.totalPadToDie = 0;
             ent.fromItem = nullptr;
             ent.toItem = nullptr;
 
             for( BOARD_CONNECTED_ITEM* citem : nitem.second )
             {
                 if( citem->Type() == PCB_VIA_T )
                 {
                     ent.viaCount++;
                     ent.totalVia += computeViaThruLength( static_cast<VIA*>( citem ), nitem.second );
                 }
                 else if( citem->Type() == PCB_TRACE_T )
                 {
                     ent.totalRoute += static_cast<TRACK*>( citem )->GetLength();
                 }
                 else if ( citem->Type() == PCB_ARC_T )
                 {
                     ent.totalRoute += static_cast<ARC*>( citem )->GetLength();
                 }
                 else if( citem->Type() == PCB_PAD_T )
                 {
                     ent.totalPadToDie += static_cast<PAD*>( citem )->GetPadToDieLength();
                 }
             }
 
             ent.total = ent.totalRoute + ent.totalVia + ent.totalPadToDie;
             ent.matchingRule = it.first;
 
             // fixme: doesn't seem to work ;-)
             auto ftPath = ftCache->QueryFromToPath( ent.items );
 
             if( ftPath )
             {
                 ent.from = ftPath->fromName;
                 ent.to = ftPath->toName;
             }
             else
             {
                 ent.from = ent.to = _("<unconstrained>");
             }
 
             m_report.Add( ent );
             matches[ it.first ].push_back(ent);
         }
     }
 
     if( !aDelayReportMode )
     {
         for( auto it : matches )
         {
             DRC_RULE *rule = it.first;
             auto& matchedConnections = it.second;
 
             std::sort( matchedConnections.begin(), matchedConnections.end(),
                        [] ( const LENGTH_ENTRY&a, const LENGTH_ENTRY&b ) -> int
                        {
                            return a.netname < b.netname;
                        } );
 
             reportAux( wxString::Format( "Length-constrained traces for rule '%s':",
                                          it.first->m_Name ) );
 
             for( auto& ent : matchedConnections )
             {
                 reportAux(wxString::Format( " - net: %s, from: %s, to: %s, "
                                             "%d matching items, "
                                             "total: %s (tracks: %s, vias: %s, pad-to-die: %s), "
                                             "vias: %d",
                                             ent.netname,
                                             ent.from,
                                             ent.to,
                                             (int) ent.items.size(),
                                             MessageTextFromValue( userUnits(), ent.total ),
                                             MessageTextFromValue( userUnits(), ent.totalRoute ),
                                             MessageTextFromValue( userUnits(), ent.totalVia ),
                                             MessageTextFromValue( userUnits(), ent.totalPadToDie ),
                                             ent.viaCount ) );
             }
 
 
             OPT<DRC_CONSTRAINT> lengthConstraint = rule->FindConstraint( LENGTH_CONSTRAINT );
 
             if( lengthConstraint )
                 checkLengthViolations( *lengthConstraint, matchedConnections );
 
             OPT<DRC_CONSTRAINT> skewConstraint = rule->FindConstraint( SKEW_CONSTRAINT );
 
             if( skewConstraint )
                 checkSkewViolations( *skewConstraint, matchedConnections );
 
             OPT<DRC_CONSTRAINT> viaCountConstraint = rule->FindConstraint( VIA_COUNT_CONSTRAINT );
 
             if( viaCountConstraint )
                 checkViaCountViolations( *viaCountConstraint, matchedConnections );
         }
 
         reportRuleStatistics();
     }
 
     return true;
 }

Referenced by Run().

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

◆ userUnits()

EDA_UNITS DRC_TEST_PROVIDER::userUnits ( ) const

protectedinherited

Definition at line 96 of file drc_test_provider.cpp.

 {
     return m_drcEngine->UserUnits();
 }

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

Member Data Documentation

◆ m_board

BOARD* DRC_TEST_PROVIDER_MATCHED_LENGTH::m_board

private

Definition at line 89 of file drc_test_provider_matched_length.cpp.

Referenced by runInternal().

◆ m_drcEngine

DRC_ENGINE* DRC_TEST_PROVIDER::m_drcEngine

protectedinherited

Definition at line 131 of file drc_test_provider.h.

◆ 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_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_msg

wxString DRC_TEST_PROVIDER::m_msg

protectedinherited

Definition at line 136 of file drc_test_provider.h.

◆ m_report

DRC_LENGTH_REPORT DRC_TEST_PROVIDER_MATCHED_LENGTH::m_report

private

Definition at line 90 of file drc_test_provider_matched_length.cpp.

Referenced by runInternal().

◆ 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(), and DRC_TEST_PROVIDER_SILK_CLEARANCE::Run().

◆ 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_matched_length.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ CITEMS

◆ LENGTH_ENTRIES

◆ LENGTH_ENTRY

Constructor & Destructor Documentation

◆ DRC_TEST_PROVIDER_MATCHED_LENGTH()

◆ ~DRC_TEST_PROVIDER_MATCHED_LENGTH()

Member Function Documentation

◆ accountCheck() [1/2]

◆ accountCheck() [2/2]

◆ BuildLengthReport()

◆ checkLengthViolations()

◆ checkSkewViolations()

◆ checkViaCountViolations()

◆ Enable()

◆ forEachGeometryItem()

◆ GetConstraintTypes()

◆ GetDescription()

◆ GetName()

◆ GetNumPhases()

◆ IsEnabled()

◆ isInvisibleText()

◆ IsRuleDriven()

◆ reportAux()

◆ reportPhase()

◆ reportProgress()

◆ reportRuleStatistics()

◆ reportViolation()

◆ Run()

◆ runInternal()

◆ SetDRCEngine()

◆ userUnits()

Member Data Documentation

◆ m_board

◆ m_drcEngine

◆ m_enabled

◆ m_isRuleDriven

◆ m_msg

◆ m_report

◆ m_stats

◆ s_allBasicItems

◆ s_allBasicItemsButZones