KiCad PCB EDA Suite
DRC_TEST_PROVIDER_ANNULAR_WIDTH Class Reference
Inheritance diagram for DRC_TEST_PROVIDER_ANNULAR_WIDTH:
DRC_TEST_PROVIDER

Public Member Functions

 DRC_TEST_PROVIDER_ANNULAR_WIDTH ()
 
virtual ~DRC_TEST_PROVIDER_ANNULAR_WIDTH ()
 
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
 
void SetDRCEngine (DRC_ENGINE *engine)
 

Static Public Member Functions

static void Init ()
 

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 VECTOR2I &aMarkerPos, PCB_LAYER_ID aMarkerLayer)
 
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_ENGINEm_drcEngine
 
std::unordered_map< const DRC_RULE *, int > m_stats
 
bool m_isRuleDriven = true
 

Static Protected Attributes

static std::vector< KICAD_Ts_allBasicItems
 
static std::vector< KICAD_Ts_allBasicItemsButZones
 

Detailed Description

Definition at line 47 of file drc_test_provider_annular_width.cpp.

Constructor & Destructor Documentation

◆ DRC_TEST_PROVIDER_ANNULAR_WIDTH()

DRC_TEST_PROVIDER_ANNULAR_WIDTH::DRC_TEST_PROVIDER_ANNULAR_WIDTH ( )
inline

Definition at line 50 of file drc_test_provider_annular_width.cpp.

51 {
52 }

◆ ~DRC_TEST_PROVIDER_ANNULAR_WIDTH()

virtual DRC_TEST_PROVIDER_ANNULAR_WIDTH::~DRC_TEST_PROVIDER_ANNULAR_WIDTH ( )
inlinevirtual

Definition at line 54 of file drc_test_provider_annular_width.cpp.

55 {
56 }

Member Function Documentation

◆ accountCheck() [1/2]

void DRC_TEST_PROVIDER::accountCheck ( const DRC_CONSTRAINT constraintToTest)
protectedvirtualinherited

Definition at line 132 of file drc_test_provider.cpp.

133{
134 accountCheck( constraintToTest.GetParentRule() );
135}
DRC_RULE * GetParentRule() const
Definition: drc_rule.h:143
virtual void accountCheck(const DRC_RULE *ruleToTest)

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

◆ accountCheck() [2/2]

void DRC_TEST_PROVIDER::accountCheck ( const DRC_RULE ruleToTest)
protectedvirtualinherited

Definition at line 121 of file drc_test_provider.cpp.

122{
123 auto it = m_stats.find( ruleToTest );
124
125 if( it == m_stats.end() )
126 m_stats[ ruleToTest ] = 1;
127 else
128 m_stats[ ruleToTest ] += 1;
129}
std::unordered_map< const DRC_RULE *, int > m_stats

References DRC_TEST_PROVIDER::m_stats.

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

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

159{
160 BOARD *brd = m_drcEngine->GetBoard();
161 std::bitset<MAX_STRUCT_TYPE_ID> typeMask;
162 int n = 0;
163
164 if( aTypes.size() == 0 )
165 {
166 for( int i = 0; i < MAX_STRUCT_TYPE_ID; i++ )
167 typeMask[ i ] = true;
168 }
169 else
170 {
171 for( KICAD_T aType : aTypes )
172 typeMask[ aType ] = true;
173 }
174
175 for( PCB_TRACK* item : brd->Tracks() )
176 {
177 if( (item->GetLayerSet() & aLayers).any() )
178 {
179 if( typeMask[ PCB_TRACE_T ] && item->Type() == PCB_TRACE_T )
180 {
181 aFunc( item );
182 n++;
183 }
184 else if( typeMask[ PCB_VIA_T ] && item->Type() == PCB_VIA_T )
185 {
186 aFunc( item );
187 n++;
188 }
189 else if( typeMask[ PCB_ARC_T ] && item->Type() == PCB_ARC_T )
190 {
191 aFunc( item );
192 n++;
193 }
194 }
195 }
196
197 for( BOARD_ITEM* item : brd->Drawings() )
198 {
199 if( (item->GetLayerSet() & aLayers).any() )
200 {
201 if( typeMask[ PCB_DIMENSION_T ] && BaseType( item->Type() ) == PCB_DIMENSION_T )
202 {
203 if( !aFunc( item ) )
204 return n;
205
206 n++;
207 }
208 else if( typeMask[ PCB_SHAPE_T ] && item->Type() == PCB_SHAPE_T )
209 {
210 if( !aFunc( item ) )
211 return n;
212
213 n++;
214 }
215 else if( typeMask[ PCB_TEXT_T ] && item->Type() == PCB_TEXT_T )
216 {
217 if( !aFunc( item ) )
218 return n;
219
220 n++;
221 }
222 else if( typeMask[ PCB_TEXTBOX_T ] && item->Type() == PCB_TEXTBOX_T )
223 {
224 if( !aFunc( item ) )
225 return n;
226
227 n++;
228 }
229 else if( typeMask[ PCB_TARGET_T ] && item->Type() == PCB_TARGET_T )
230 {
231 if( !aFunc( item ) )
232 return n;
233
234 n++;
235 }
236 }
237 }
238
239 if( typeMask[ PCB_ZONE_T ] )
240 {
241 for( ZONE* item : brd->Zones() )
242 {
243 if( ( item->GetLayerSet() & aLayers ).any() )
244 {
245 if( !aFunc( item ) )
246 return n;
247
248 n++;
249 }
250 }
251 }
252
253 for( FOOTPRINT* footprint : brd->Footprints() )
254 {
255 if( typeMask[ PCB_FP_TEXT_T ] )
256 {
257 if( ( footprint->Reference().GetLayerSet() & aLayers ).any() )
258 {
259 if( !aFunc( &footprint->Reference() ) )
260 return n;
261
262 n++;
263 }
264
265 if( ( footprint->Value().GetLayerSet() & aLayers ).any() )
266 {
267 if( !aFunc( &footprint->Value() ) )
268 return n;
269
270 n++;
271 }
272 }
273
274 if( typeMask[ PCB_PAD_T ] )
275 {
276 for( PAD* pad : footprint->Pads() )
277 {
278 // Careful: if a pad has a hole then it pierces all layers
279 if( pad->HasHole() || ( pad->GetLayerSet() & aLayers ).any() )
280 {
281 if( !aFunc( pad ) )
282 return n;
283
284 n++;
285 }
286 }
287 }
288
289 for( BOARD_ITEM* dwg : footprint->GraphicalItems() )
290 {
291 if( (dwg->GetLayerSet() & aLayers).any() )
292 {
293 if( typeMask[ PCB_DIMENSION_T ] && BaseType( dwg->Type() ) == PCB_DIMENSION_T )
294 {
295 if( !aFunc( dwg ) )
296 return n;
297
298 n++;
299 }
300 else if( typeMask[ PCB_FP_TEXT_T ] && dwg->Type() == PCB_FP_TEXT_T )
301 {
302 if( !aFunc( dwg ) )
303 return n;
304
305 n++;
306 }
307 else if( typeMask[ PCB_FP_TEXTBOX_T ] && dwg->Type() == PCB_FP_TEXTBOX_T )
308 {
309 if( !aFunc( dwg ) )
310 return n;
311
312 n++;
313 }
314 else if( typeMask[ PCB_FP_SHAPE_T ] && dwg->Type() == PCB_FP_SHAPE_T )
315 {
316 if( !aFunc( dwg ) )
317 return n;
318
319 n++;
320 }
321 }
322 }
323
324 if( typeMask[ PCB_FP_ZONE_T ] )
325 {
326 for( ZONE* zone : footprint->Zones() )
327 {
328 if( (zone->GetLayerSet() & aLayers).any() )
329 {
330 if( !aFunc( zone ) )
331 return n;
332
333 n++;
334 }
335 }
336 }
337
338 if( typeMask[ PCB_FOOTPRINT_T ] )
339 {
340 if( !aFunc( footprint ) )
341 return n;
342
343 n++;
344 }
345 }
346
347 return n;
348}
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:53
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:240
ZONES & Zones()
Definition: board.h:288
FOOTPRINTS & Footprints()
Definition: board.h:282
TRACKS & Tracks()
Definition: board.h:279
DRAWINGS & Drawings()
Definition: board.h:285
BOARD * GetBoard() const
Definition: drc_engine.h:88
DRC_ENGINE * m_drcEngine
Definition: pad.h:59
Handle a list of polygons defining a copper zone.
Definition: zone.h:58
constexpr KICAD_T BaseType(const KICAD_T aType)
Return the underlying type of the given type.
Definition: typeinfo.h:245
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:78
@ PCB_SHAPE_T
class PCB_SHAPE, a segment not on copper layers
Definition: typeinfo.h:90
@ PCB_FP_SHAPE_T
class FP_SHAPE, a footprint edge
Definition: typeinfo.h:96
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:104
@ MAX_STRUCT_TYPE_ID
Definition: typeinfo.h:233
@ PCB_FP_TEXTBOX_T
class FP_TEXTBOX, wrapped text in a footprint
Definition: typeinfo.h:95
@ PCB_TEXTBOX_T
class PCB_TEXTBOX, wrapped text on a layer
Definition: typeinfo.h:93
@ PCB_ZONE_T
class ZONE, a copper pour area
Definition: typeinfo.h:114
@ PCB_TEXT_T
class PCB_TEXT, text on a layer
Definition: typeinfo.h:92
@ PCB_TARGET_T
class PCB_TARGET, a target (graphic item)
Definition: typeinfo.h:113
@ PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
Definition: typeinfo.h:88
@ PCB_FP_ZONE_T
class ZONE, managed by a footprint
Definition: typeinfo.h:102
@ PCB_PAD_T
class PAD, a pad in a footprint
Definition: typeinfo.h:89
@ PCB_FP_TEXT_T
class FP_TEXT, text in a footprint
Definition: typeinfo.h:94
@ PCB_ARC_T
class PCB_ARC, an arc track segment on a copper layer
Definition: typeinfo.h:105
@ PCB_DIMENSION_T
class PCB_DIMENSION_BASE: abstract dimension meta-type
Definition: typeinfo.h:107
@ PCB_TRACE_T
class PCB_TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:103

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_TEXTBOX_T, PCB_FP_ZONE_T, PCB_PAD_T, PCB_SHAPE_T, PCB_TARGET_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, BOARD::Tracks(), and BOARD::Zones().

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

◆ GetDescription()

virtual const wxString DRC_TEST_PROVIDER_ANNULAR_WIDTH::GetDescription ( ) const
inlineoverridevirtual

Reimplemented from DRC_TEST_PROVIDER.

Definition at line 65 of file drc_test_provider_annular_width.cpp.

66 {
67 return wxT( "Tests pad/via annular rings" );
68 }

◆ GetName()

virtual const wxString DRC_TEST_PROVIDER_ANNULAR_WIDTH::GetName ( void  ) const
inlineoverridevirtual

Reimplemented from DRC_TEST_PROVIDER.

Definition at line 60 of file drc_test_provider_annular_width.cpp.

61 {
62 return wxT( "annular_width" );
63 };

◆ Init()

void DRC_TEST_PROVIDER::Init ( )
staticinherited

Definition at line 52 of file drc_test_provider.cpp.

53{
54 if( s_allBasicItems.size() == 0 )
55 {
56 for( int i = 0; i < MAX_STRUCT_TYPE_ID; i++ )
57 {
58 if( i != PCB_FOOTPRINT_T && i != PCB_GROUP_T )
59 {
60 s_allBasicItems.push_back( (KICAD_T) i );
61
62 if( i != PCB_ZONE_T && i != PCB_FP_ZONE_T )
63 s_allBasicItemsButZones.push_back( (KICAD_T) i );
64 }
65 }
66 }
67}
static std::vector< KICAD_T > s_allBasicItemsButZones
static std::vector< KICAD_T > s_allBasicItems
@ PCB_GROUP_T
class PCB_GROUP, a set of BOARD_ITEMs
Definition: typeinfo.h:117

References MAX_STRUCT_TYPE_ID, PCB_FOOTPRINT_T, PCB_FP_ZONE_T, PCB_GROUP_T, PCB_ZONE_T, DRC_TEST_PROVIDER::s_allBasicItems, and DRC_TEST_PROVIDER::s_allBasicItemsButZones.

Referenced by DRC_ENGINE::RunTests().

◆ isInvisibleText()

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

Definition at line 351 of file drc_test_provider.cpp.

352{
353
354 if( const FP_TEXT* text = dyn_cast<const FP_TEXT*>( aItem ) )
355 {
356 if( !text->IsVisible() )
357 return true;
358 }
359
360 if( const PCB_TEXT* text = dyn_cast<const PCB_TEXT*>( aItem ) )
361 {
362 if( !text->IsVisible() )
363 return true;
364 }
365
366 return false;
367}

References text.

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

◆ reportAux()

◆ reportPhase()

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

◆ reportProgress()

bool DRC_TEST_PROVIDER::reportProgress ( int  aCount,
int  aSize,
int  aDelta 
)
protectedvirtualinherited

Definition at line 85 of file drc_test_provider.cpp.

86{
87 if( ( aCount % aDelta ) == 0 || aCount == aSize - 1 )
88 {
89 if( !m_drcEngine->ReportProgress( (double) aCount / (double) aSize ) )
90 return false;
91 }
92
93 return true;
94}
bool ReportProgress(double aProgress)

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

Referenced by DRC_TEST_PROVIDER_SOLDER_MASK::buildRTrees(), DRC_CACHE_GENERATOR::Run(), Run(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::Run(), DRC_TEST_PROVIDER_LIBRARY_PARITY::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_VIA_DIAMETER::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), DRC_TEST_PROVIDER_MISC::testAssertions(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_MISC::testDisabledLayers(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testFootprintCourtyardDefinitions(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskBridges(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadClearances(), DRC_TEST_PROVIDER_SOLDER_MASK::testSilkToMaskClearance(), DRC_TEST_PROVIDER_MISC::testTextVars(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackClearances(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones().

◆ reportRuleStatistics()

void DRC_TEST_PROVIDER::reportRuleStatistics ( )
protectedvirtualinherited

Definition at line 138 of file drc_test_provider.cpp.

139{
140 if( !m_isRuleDriven )
141 return;
142
143 m_drcEngine->ReportAux( wxT( "Rule hit statistics: " ) );
144
145 for( const std::pair<const DRC_RULE* const, int>& stat : m_stats )
146 {
147 if( stat.first )
148 {
149 m_drcEngine->ReportAux( wxString::Format( wxT( " - rule '%s': %d hits " ),
150 stat.first->m_Name,
151 stat.second ) );
152 }
153 }
154}
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200

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

Referenced by Run(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_HOLE_SIZE::Run(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::Run(), DRC_TEST_PROVIDER_SOLDER_MASK::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_VIA_DIAMETER::Run(), and DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal().

◆ reportViolation()

void DRC_TEST_PROVIDER::reportViolation ( std::shared_ptr< DRC_ITEM > &  item,
const VECTOR2I aMarkerPos,
PCB_LAYER_ID  aMarkerLayer 
)
protectedvirtualinherited

Definition at line 74 of file drc_test_provider.cpp.

76{
77 if( item->GetViolatingRule() )
78 accountCheck( item->GetViolatingRule() );
79
80 item->SetViolatingTest( this );
81 m_drcEngine->ReportViolation( item, aMarkerPos, aMarkerLayer );
82}
void ReportViolation(const std::shared_ptr< DRC_ITEM > &aItem, const VECTOR2I &aPos, PCB_LAYER_ID aMarkerLayer)

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::checkPadHole(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkSkews(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkViaCounts(), DRC_TEST_PROVIDER_HOLE_SIZE::checkViaHole(), Run(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_FOOTPRINT_CHECKS::Run(), DRC_TEST_PROVIDER_LIBRARY_PARITY::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_SLIVER_CHECKER::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_VIA_DIAMETER::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_MISC::testAssertions(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_MISC::testDisabledLayers(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testFootprintCourtyardDefinitions(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::testHoleAgainstHole(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), DRC_TEST_PROVIDER_MISC::testOutline(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), DRC_TEST_PROVIDER_MISC::testTextVars(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testZoneLayer(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones().

◆ Run()

bool DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run ( )
overridevirtual

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

Implements DRC_TEST_PROVIDER.

Definition at line 72 of file drc_test_provider_annular_width.cpp.

73{
75 {
76 reportAux( wxT( "Annular width violations ignored. Skipping check." ) );
77 return true; // continue with other tests
78 }
79
80 const int progressDelta = 500;
81
83 {
84 reportAux( wxT( "No annular width constraints found. Tests not run." ) );
85 return true; // continue with other tests
86 }
87
88 if( !reportPhase( _( "Checking pad & via annular rings..." ) ) )
89 return false; // DRC cancelled
90
92
93 auto calcEffort =
94 []( BOARD_ITEM* item )
95 {
96 switch( item->Type() )
97 {
98 case PCB_VIA_T:
99 return 1;
100
101 case PCB_PAD_T:
102 {
103 PAD* pad = static_cast<PAD*>( item );
104
105 if( !pad->HasHole() || pad->GetAttribute() != PAD_ATTRIB::PTH )
106 return 0;
107
108 if( pad->GetOffset() == VECTOR2I( 0, 0 ) )
109 {
110 switch( pad->GetShape() )
111 {
113 if( pad->GetChamferRectRatio() > 0.30 )
114 break;
115
117
119 case PAD_SHAPE::OVAL:
120 case PAD_SHAPE::RECT:
122 return 1;
123
124 default:
125 break;
126 }
127 }
128
129 return 5;
130 }
131
132 default:
133 return 0;
134 }
135 };
136
137 auto checkAnnularWidth =
138 [&]( BOARD_ITEM* item ) -> bool
139 {
141 return false;
142
143 int annularWidth = 0;
144
145 switch( item->Type() )
146 {
147 case PCB_VIA_T:
148 {
149 PCB_VIA* via = static_cast<PCB_VIA*>( item );
150 annularWidth = ( via->GetWidth() - via->GetDrillValue() ) / 2;
151 break;
152 }
153
154 case PCB_PAD_T:
155 {
156 PAD* pad = static_cast<PAD*>( item );
157 bool handled = false;
158
159 if( !pad->HasHole() || pad->GetAttribute() != PAD_ATTRIB::PTH )
160 return true;
161
162 if( pad->GetOffset() == VECTOR2I( 0, 0 ) )
163 {
164 switch( pad->GetShape() )
165 {
167 if( pad->GetChamferRectRatio() > 0.30 )
168 break;
169
171
173 case PAD_SHAPE::OVAL:
174 case PAD_SHAPE::RECT:
176 annularWidth = std::min( pad->GetSizeX() - pad->GetDrillSizeX(),
177 pad->GetSizeY() - pad->GetDrillSizeY() ) / 2;
178 handled = true;
179 break;
180
181 default:
182 break;
183 }
184 }
185
186 if( !handled )
187 {
188 // Slow (but general purpose) method.
189 SHAPE_POLY_SET padOutline;
190
191 pad->TransformShapeWithClearanceToPolygon( padOutline, UNDEFINED_LAYER, 0,
192 maxError, ERROR_INSIDE );
193
194 if( !padOutline.Collide( pad->GetPosition() ) )
195 {
196 // Hole outside pad
197 annularWidth = 0;
198 }
199 else
200 {
201 std::shared_ptr<SHAPE_SEGMENT> slot = pad->GetEffectiveHoleShape();
202
203 // Disable is-inside test in SquaredDistance
204 padOutline.Outline( 0 ).SetClosed( false );
205
206 SEG::ecoord dist_sq = padOutline.SquaredDistance( slot->GetSeg() );
207 annularWidth = sqrt( dist_sq ) - slot->GetWidth() / 2;
208 }
209 }
210
211 break;
212 }
213
214 default:
215 return true;
216 }
217
218 // PADSTACKS TODO: once we have padstacks we'll need to run this per-layer....
219 auto constraint = m_drcEngine->EvalRules( ANNULAR_WIDTH_CONSTRAINT, item, nullptr,
221 int v_min = 0;
222 int v_max = 0;
223 bool fail_min = false;
224 bool fail_max = false;
225
226 if( constraint.GetSeverity() == RPT_SEVERITY_IGNORE )
227 return true;
228
229 if( constraint.Value().HasMin() )
230 {
231 v_min = constraint.Value().Min();
232 fail_min = annularWidth < v_min;
233 }
234
235 if( constraint.Value().HasMax() )
236 {
237 v_max = constraint.Value().Max();
238 fail_max = annularWidth > v_max;
239 }
240
241 if( fail_min || fail_max )
242 {
243 std::shared_ptr<DRC_ITEM> drcItem = DRC_ITEM::Create( DRCE_ANNULAR_WIDTH );
244 wxString msg;
245
246 if( fail_min )
247 {
248 msg.Printf( _( "(%s min annular width %s; actual %s)" ),
249 constraint.GetName(),
251 MessageTextFromValue( userUnits(), annularWidth ) );
252 }
253
254 if( fail_max )
255 {
256 msg.Printf( _( "(%s max annular width %s; actual %s)" ),
257 constraint.GetName(),
259 MessageTextFromValue( userUnits(), annularWidth ) );
260 }
261
262 drcItem->SetErrorMessage( drcItem->GetErrorText() + wxS( " " ) + msg );
263 drcItem->SetItems( item );
264 drcItem->SetViolatingRule( constraint.GetParentRule() );
265
266 reportViolation( drcItem, item->GetPosition(), item->GetLayer() );
267 }
268
269 return true;
270 };
271
272 BOARD* board = m_drcEngine->GetBoard();
273 size_t ii = 0;
274 size_t total = 0;
275
276 for( PCB_TRACK* item : board->Tracks() )
277 total += calcEffort( item );
278
279 for( FOOTPRINT* footprint : board->Footprints() )
280 {
281 for( PAD* pad : footprint->Pads() )
282 total += calcEffort( pad );
283 }
284
285 for( PCB_TRACK* item : board->Tracks() )
286 {
287 ii += calcEffort( item );
288
289 if( !reportProgress( ii, total, progressDelta ) )
290 return false; // DRC cancelled
291
292 if( !checkAnnularWidth( item ) )
293 break;
294 }
295
296 for( FOOTPRINT* footprint : board->Footprints() )
297 {
298 for( PAD* pad : footprint->Pads() )
299 {
300 ii += calcEffort( pad );
301
302 if( !reportProgress( ii, total, progressDelta ) )
303 return false; // DRC cancelled
304
305 if( !checkAnnularWidth( pad ) )
306 break;
307 }
308 }
309
311
312 return !m_drcEngine->IsCancelled();
313}
wxString MessageTextFromValue(EDA_UNITS aUnits, int aValue, bool aAddUnitLabel, EDA_DATA_TYPE aType)
Convert a value to a string using double notation.
Definition: base_units.cpp:103
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:619
MINOPTMAX< int > & Value()
Definition: drc_rule.h:140
bool HasRulesForConstraintType(DRC_CONSTRAINT_T constraintID)
bool IsErrorLimitExceeded(int error_code)
DRC_CONSTRAINT EvalRules(DRC_CONSTRAINT_T aConstraintType, const BOARD_ITEM *a, const BOARD_ITEM *b, PCB_LAYER_ID aLayer, REPORTER *aReporter=nullptr)
Definition: drc_engine.cpp:646
bool IsCancelled() const
static std::shared_ptr< DRC_ITEM > Create(int aErrorCode)
Constructs a DRC_ITEM for the given error code.
Definition: drc_item.cpp:324
virtual bool reportPhase(const wxString &aStageName)
virtual bool reportProgress(int aCount, int aSize, int aDelta)
virtual void reportViolation(std::shared_ptr< DRC_ITEM > &item, const VECTOR2I &aMarkerPos, PCB_LAYER_ID aMarkerLayer)
EDA_UNITS userUnits() const
virtual void reportRuleStatistics()
T Min() const
Definition: minoptmax.h:33
VECTOR2I::extended_type ecoord
Definition: seg.h:44
void SetClosed(bool aClosed)
Mark the line chain as closed (i.e.
Represent a set of closed polygons.
SEG::ecoord SquaredDistance(VECTOR2I aPoint, VECTOR2I *aNearest=nullptr) const
Compute the minimum distance squared between aPoint and all the polygons in the set.
bool Collide(const SHAPE *aShape, int aClearance=0, int *aActual=nullptr, VECTOR2I *aLocation=nullptr) const override
Check if the boundary of shape (this) lies closer to the shape aShape than aClearance,...
SHAPE_LINE_CHAIN & Outline(int aIndex)
@ DRCE_ANNULAR_WIDTH
Definition: drc_item.h:55
@ ANNULAR_WIDTH_CONSTRAINT
Definition: drc_rule.h:56
#define _(s)
@ ERROR_INSIDE
@ UNDEFINED_LAYER
Definition: layer_ids.h:60
#define KI_FALLTHROUGH
The KI_FALLTHROUGH macro is to be used when switch statement cases should purposely fallthrough from ...
Definition: macros.h:83
@ PTH
Plated through hole pad.
@ RPT_SEVERITY_IGNORE
VECTOR2< int > VECTOR2I
Definition: vector2d.h:607

References _, ANNULAR_WIDTH_CONSTRAINT, CHAMFERED_RECT, CIRCLE, SHAPE_POLY_SET::Collide(), DRC_ITEM::Create(), DRCE_ANNULAR_WIDTH, ERROR_INSIDE, DRC_ENGINE::EvalRules(), BOARD::Footprints(), DRC_ENGINE::GetBoard(), BOARD::GetDesignSettings(), DRC_ENGINE::HasRulesForConstraintType(), DRC_ENGINE::IsCancelled(), DRC_ENGINE::IsErrorLimitExceeded(), KI_FALLTHROUGH, DRC_TEST_PROVIDER::m_drcEngine, BOARD_DESIGN_SETTINGS::m_MaxError, MessageTextFromValue(), MINOPTMAX< T >::Min(), SHAPE_POLY_SET::Outline(), OVAL, pad, PCB_PAD_T, PCB_VIA_T, PTH, RECT, DRC_TEST_PROVIDER::reportAux(), DRC_TEST_PROVIDER::reportPhase(), DRC_TEST_PROVIDER::reportProgress(), DRC_TEST_PROVIDER::reportRuleStatistics(), DRC_TEST_PROVIDER::reportViolation(), ROUNDRECT, RPT_SEVERITY_IGNORE, SHAPE_LINE_CHAIN::SetClosed(), SHAPE_POLY_SET::SquaredDistance(), BOARD::Tracks(), UNDEFINED_LAYER, DRC_TEST_PROVIDER::userUnits(), DRC_CONSTRAINT::Value(), and via.

◆ SetDRCEngine()

void DRC_TEST_PROVIDER::SetDRCEngine ( DRC_ENGINE engine)
inlineinherited

Definition at line 80 of file drc_test_provider.h.

81 {
82 m_drcEngine = engine;
83 m_stats.clear();
84 }

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

Referenced by EDIT_TOOL::doMoveSelection(), and DRC_ENGINE::RunTests().

◆ userUnits()

Member Data Documentation

◆ m_drcEngine

DRC_ENGINE* DRC_TEST_PROVIDER::m_drcEngine
protectedinherited

Definition at line 117 of file drc_test_provider.h.

Referenced by DRC_TEST_PROVIDER_HOLE_SIZE::checkPadHole(), DRC_TEST_PROVIDER_HOLE_SIZE::checkViaHole(), DRC_TEST_PROVIDER::forEachGeometryItem(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::layerDesc(), DRC_TEST_PROVIDER_SLIVER_CHECKER::layerDesc(), DRC_TEST_PROVIDER::reportAux(), DRC_TEST_PROVIDER::reportPhase(), DRC_TEST_PROVIDER::reportProgress(), DRC_TEST_PROVIDER::reportRuleStatistics(), DRC_TEST_PROVIDER::reportViolation(), DRC_CACHE_GENERATOR::Run(), Run(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::Run(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_FOOTPRINT_CHECKS::Run(), DRC_TEST_PROVIDER_HOLE_SIZE::Run(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::Run(), DRC_TEST_PROVIDER_LIBRARY_PARITY::Run(), DRC_TEST_PROVIDER_MISC::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_SLIVER_CHECKER::Run(), DRC_TEST_PROVIDER_SOLDER_MASK::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_VIA_DIAMETER::Run(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::Run(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE_ON_MOVE::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), DRC_TEST_PROVIDER::SetDRCEngine(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_MISC::testAssertions(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_MISC::testDisabledLayers(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testFootprintCourtyardDefinitions(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::testHoleAgainstHole(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskBridges(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadClearances(), DRC_TEST_PROVIDER_SOLDER_MASK::testSilkToMaskClearance(), DRC_TEST_PROVIDER_MISC::testTextVars(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackClearances(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testZoneLayer(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones(), and DRC_TEST_PROVIDER::userUnits().

◆ m_isRuleDriven

◆ m_stats

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

◆ s_allBasicItems

◆ s_allBasicItemsButZones

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

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