test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING Class Reference

Inheritance diagram for test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING:

Public Member Functions
	DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING ()
virtual	~DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING ()
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 int	GetNumPhases () const override
virtual std::set< DRC_CONSTRAINT_T >	GetConstraintTypes () 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
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 Attributes
BOARD *	m_board

Detailed Description

Definition at line 53 of file drc_test_provider_diff_pair_coupling.cpp.

Constructor & Destructor Documentation

DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING()

test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING ( )

inline

Definition at line 56 of file drc_test_provider_diff_pair_coupling.cpp.

 :
 m_board( nullptr )
 {
 }

~DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING()

virtual test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::~DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING ( )

inlinevirtual

Definition at line 61 of file drc_test_provider_diff_pair_coupling.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(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), 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 > test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::GetConstraintTypes ( ) const

overridevirtual

Implements DRC_TEST_PROVIDER.

Definition at line 523 of file drc_test_provider_diff_pair_coupling.cpp.

{
 return { DIFF_PAIR_GAP_CONSTRAINT, DIFF_PAIR_MAX_UNCOUPLED_CONSTRAINT };
}

References DIFF_PAIR_GAP_CONSTRAINT, and DIFF_PAIR_MAX_UNCOUPLED_CONSTRAINT.

GetDescription()

virtual const wxString test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::GetDescription ( ) const

inlineoverridevirtual

Reimplemented from DRC_TEST_PROVIDER.

Definition at line 72 of file drc_test_provider_diff_pair_coupling.cpp.

 {
 return "Tests differential pair coupling";
 }

GetName()

virtual const wxString test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::GetName ( void  ) const

inlineoverridevirtual

Reimplemented from DRC_TEST_PROVIDER.

Definition at line 67 of file drc_test_provider_diff_pair_coupling.cpp.

 {
 return "diff_pair_coupling";
 };

GetNumPhases()

virtual int test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::GetNumPhases ( ) const

inlineoverridevirtual

Implements DRC_TEST_PROVIDER.

Definition at line 77 of file drc_test_provider_diff_pair_coupling.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(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_LVS::Run(), 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(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::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_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::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(), DRC_TEST_PROVIDER_LVS::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::Run(), 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(), 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(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::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 test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run ( )

overridevirtual

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

Implements DRC_TEST_PROVIDER.

Definition at line 276 of file drc_test_provider_diff_pair_coupling.cpp.

{
 m_board = m_drcEngine->GetBoard();



 std::map<DIFF_PAIR_KEY, DIFF_PAIR_ITEMS> dpRuleMatches;

 auto evaluateDpConstraints =
 [&]( BOARD_ITEM *item ) -> bool
 {
 DIFF_PAIR_KEY key;
 BOARD_CONNECTED_ITEM* citem = static_cast<BOARD_CONNECTED_ITEM*>( item );
 NETINFO_ITEM* refNet = citem->GetNet();

 if( refNet && DRC_ENGINE::IsNetADiffPair( m_board, refNet, key.netP, key.netN ) )
 {
 drc_dbg( 10, "eval dp %p\n", item );

 const DRC_CONSTRAINT_T constraintsToCheck[] = {
 DIFF_PAIR_GAP_CONSTRAINT,
 DIFF_PAIR_MAX_UNCOUPLED_CONSTRAINT
 };

 for( int i = 0; i < 2; i++ )
 {
 auto constraint = m_drcEngine->EvalRules( constraintsToCheck[ i ], item,
 nullptr, item->GetLayer() );

 if( constraint.IsNull() )
 continue;

 drc_dbg( 10, "cns %d item %p\n", constraintsToCheck[i], item );

 key.parentRule = constraint.GetParentRule();

 if( refNet->GetNetCode() == key.netN )
 dpRuleMatches[key].itemsN.insert( citem );
 else
 dpRuleMatches[key].itemsP.insert( citem );
 }
 }

 return true;
 };

 m_board->GetConnectivity()->GetFromToCache()->Rebuild( m_board );

 forEachGeometryItem( { PCB_TRACE_T, PCB_VIA_T, PCB_ARC_T },
 LSET::AllCuMask(), evaluateDpConstraints );

 drc_dbg( 10, "dp rule matches %d\n", (int) dpRuleMatches.size() );


 DRC_RTREE copperTree;

 auto addToTree =
 [&copperTree]( BOARD_ITEM *item ) -> bool
 {
 for( PCB_LAYER_ID layer : item->GetLayerSet().Seq() )
 {
 if( IsCopperLayer( layer ) )
 copperTree.Insert( item, layer );
 }

 return true;
 };

 forEachGeometryItem( { PCB_TRACE_T, PCB_VIA_T, PCB_PAD_T, PCB_ZONE_T, PCB_ARC_T },
 LSET::AllCuMask(), addToTree );


 reportAux( wxString::Format( _("DPs evaluated:") ) );

 for( auto& it : dpRuleMatches )
 {
  NETINFO_ITEM *niP = m_board->GetNetInfo().GetNetItem( it.first.netP );
 NETINFO_ITEM *niN = m_board->GetNetInfo().GetNetItem( it.first.netN );

 assert( niP );
 assert( niN );

 wxString nameP = niP->GetNetname();
 wxString nameN = niN->GetNetname();

 reportAux( wxString::Format( "Rule '%s', DP: (+) %s - (-) %s",
 it.first.parentRule->m_Name, nameP, nameN ) );

 extractDiffPairCoupledItems( it.second, copperTree );

 it.second.totalCoupled = 0;
 it.second.totalLengthN = 0;
 it.second.totalLengthP = 0;

 drc_dbg(10, " coupled prims : %d\n", (int) it.second.coupled.size() );

 OPT<DRC_CONSTRAINT> gapConstraint =
 it.first.parentRule->FindConstraint( DIFF_PAIR_GAP_CONSTRAINT );
 OPT<DRC_CONSTRAINT> maxUncoupledConstraint =
 it.first.parentRule->FindConstraint( DIFF_PAIR_MAX_UNCOUPLED_CONSTRAINT );

 for( BOARD_CONNECTED_ITEM* item : it.second.itemsN )
 {
 // fixme: include vias
 if( PCB_TRACK* track = dyn_cast<PCB_TRACK*>( item ) )
 it.second.totalLengthN += track->GetLength();
 }

 for( BOARD_CONNECTED_ITEM* item : it.second.itemsP )
 {
 // fixme: include vias
 if( PCB_TRACK* track = dyn_cast<PCB_TRACK*>( item ) )
 it.second.totalLengthP += track->GetLength();
 }

 for( auto& cpair : it.second.coupled )
 {
 int length = cpair.coupledN.Length();
 int gap = cpair.coupledN.Distance( cpair.coupledP );

 gap -= cpair.parentN->GetWidth() / 2;
 gap -= cpair.parentP->GetWidth() / 2;

 cpair.computedGap = gap;

 auto overlay = m_drcEngine->GetDebugOverlay();

 if( overlay )
 {
 overlay->SetIsFill(false);
 overlay->SetIsStroke(true);
 overlay->SetStrokeColor( RED );
 overlay->SetLineWidth( 100000 );
 overlay->Line( cpair.coupledP );
 overlay->SetStrokeColor( BLUE );
 overlay->Line( cpair.coupledN );
 }

 drc_dbg( 10, " len %d gap %d l %d\n", length, gap,
 cpair.parentP->GetLayer() );

 if( gapConstraint )
 {
 auto val = gapConstraint->GetValue();
 bool insideRange = true;

 if( val.HasMin() && gap < val.Min() )
 insideRange = false;

 if( val.HasMax() && gap > val.Max() )
 insideRange = false;

// if(val.HasMin() && val.HasMax() )
 // drc_dbg(10, "Vmin %d vmax %d\n", val.Min(), val.Max() );

 cpair.couplingOK = insideRange;
 }
 else
 {
 cpair.couplingOK = true;
 }

 if( cpair.couplingOK )
 it.second.totalCoupled += length;
 }

 int totalLen = std::max( it.second.totalLengthN, it.second.totalLengthP );
 reportAux( wxString::Format( " - coupled length: %s, total length: %s",

 MessageTextFromValue( userUnits(), it.second.totalCoupled ),
 MessageTextFromValue( userUnits(), totalLen ) ) );

 int totalUncoupled = totalLen - it.second.totalCoupled;

 bool uncoupledViolation = false;

 if( maxUncoupledConstraint )
 {
 auto val = maxUncoupledConstraint->GetValue();

 if ( val.HasMax() && totalUncoupled > val.Max() )
 {
 auto drce = DRC_ITEM::Create( DRCE_DIFF_PAIR_UNCOUPLED_LENGTH_TOO_LONG );

 m_msg = wxString::Format( _( "(%s maximum uncoupled length: %s; actual: %s)" ),
 maxUncoupledConstraint->GetParentRule()->m_Name,
 MessageTextFromValue( userUnits(), val.Max() ),
 MessageTextFromValue( userUnits(), totalUncoupled ) );

 drce->SetErrorMessage( drce->GetErrorText() + wxS( " " ) + m_msg );

 for( BOARD_CONNECTED_ITEM* offendingTrack : it.second.itemsP )
 drce->AddItem( offendingTrack );

 for( BOARD_CONNECTED_ITEM* offendingTrack : it.second.itemsN )
 drce->AddItem( offendingTrack );

 uncoupledViolation = true;

 drce->SetViolatingRule( maxUncoupledConstraint->GetParentRule() );

 reportViolation( drce, ( *it.second.itemsP.begin() )->GetPosition() );
 }
 }

 if ( gapConstraint && ( uncoupledViolation || !maxUncoupledConstraint ) )
 {
 for( auto& cpair : it.second.coupled )
 {
 if( !cpair.couplingOK )
 {
 auto val = gapConstraint->GetValue();
 auto drcItem = DRC_ITEM::Create( DRCE_DIFF_PAIR_GAP_OUT_OF_RANGE );

 m_msg = drcItem->GetErrorText() + " (" +
 gapConstraint->GetParentRule()->m_Name + " ";

 if( val.HasMin() )
 m_msg += wxString::Format( _( "minimum gap: %s; " ),
 MessageTextFromValue( userUnits(), val.Min() ) );

 if( val.HasMax() )
 m_msg += wxString::Format( _( "maximum gap: %s; " ),
 MessageTextFromValue( userUnits(), val.Max() ) );

 m_msg += wxString::Format( _( "actual: %s)" ),
 MessageTextFromValue( userUnits(), cpair.computedGap ) );

 drcItem->SetErrorMessage( m_msg );

 drcItem->AddItem( cpair.parentP );
 drcItem->AddItem( cpair.parentN );

 drcItem->SetViolatingRule( gapConstraint->GetParentRule() );

 reportViolation( drcItem, cpair.parentP->GetPosition() );
 }
 }
 }
 }

 reportRuleStatistics();

 return true;
}

References _, LSET::AllCuMask(), BLUE, DRC_ITEM::Create(), DIFF_PAIR_GAP_CONSTRAINT, DIFF_PAIR_MAX_UNCOUPLED_CONSTRAINT, drc_dbg, DRCE_DIFF_PAIR_GAP_OUT_OF_RANGE, DRCE_DIFF_PAIR_UNCOUPLED_LENGTH_TOO_LONG, DRC_ENGINE::EvalRules(), extractDiffPairCoupledItems(), DRC_TEST_PROVIDER::forEachGeometryItem(), Format(), DRC_ENGINE::GetBoard(), BOARD::GetConnectivity(), DRC_ENGINE::GetDebugOverlay(), BOARD_CONNECTED_ITEM::GetNet(), NETINFO_ITEM::GetNetCode(), BOARD::GetNetInfo(), NETINFO_LIST::GetNetItem(), NETINFO_ITEM::GetNetname(), DRC_RTREE::Insert(), IsCopperLayer(), DRC_ENGINE::IsNetADiffPair(), m_board, DRC_TEST_PROVIDER::m_drcEngine, DRC_TEST_PROVIDER::m_msg, MessageTextFromValue(), DIFF_PAIR_KEY::netN, DIFF_PAIR_KEY::netP, overlay, DIFF_PAIR_KEY::parentRule, PCB_ARC_T, PCB_PAD_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, RED, DRC_TEST_PROVIDER::reportAux(), DRC_TEST_PROVIDER::reportRuleStatistics(), DRC_TEST_PROVIDER::reportViolation(), and DRC_TEST_PROVIDER::userUnits().

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 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(), Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::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* test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::m_board

private

Definition at line 86 of file drc_test_provider_diff_pair_coupling.cpp.

Referenced by Run().

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(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::Run(), DRC_TEST_PROVIDER_LVS::Run(), 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(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::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_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.

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(), Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_MISC::testDisabledLayers(), DRC_TEST_PROVIDER_LVS::testFootprints(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::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_diff_pair_coupling.cpp