KiCad PCB EDA Suite
Loading...
Searching...
No Matches
drc_test_provider_via_diameter.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2004-2023 KiCad Developers.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
24#include <pcb_track.h>
25#include <drc/drc_engine.h>
26#include <drc/drc_item.h>
27#include <drc/drc_rule.h>
29
30/*
31 Via diameter test.
32
33 Errors generated:
34 - DRCE_VIA_DIAMETER
35*/
36
38{
39public:
41 {}
42
44 {}
45
46 virtual bool Run() override;
47
48 virtual const wxString GetName() const override
49 {
50 return wxT( "diameter" );
51 };
52
53 virtual const wxString GetDescription() const override
54 {
55 return wxT( "Tests via diameters" );
56 }
57};
58
59
61{
63 {
64 reportAux( wxT( "Via diameter violations ignored. Tests not run." ) );
65 return true; // continue with other tests
66 }
67
69 {
70 reportAux( wxT( "No via diameter constraints found. Tests not run." ) );
71 return true; // continue with other tests
72 }
73
74 if( !reportPhase( _( "Checking via diameters..." ) ) )
75 return false; // DRC cancelled
76
77 auto checkViaDiameter =
78 [&]( BOARD_ITEM* item ) -> bool
79 {
81 return false;
82
83 if( item->Type() != PCB_VIA_T )
84 return true;
85
86 PCB_VIA* via = static_cast<PCB_VIA*>( item );
87
88 // TODO: once we have padstacks this will need to run per-layer...
89 auto constraint = m_drcEngine->EvalRules( VIA_DIAMETER_CONSTRAINT, item, nullptr,
91 bool fail_min = false;
92 bool fail_max = false;
93 int constraintDiameter = 0;
94 int actual = via->GetWidth();
95
96 if( constraint.GetSeverity() != RPT_SEVERITY_IGNORE )
97 {
98 if( constraint.Value().HasMin() && actual < constraint.Value().Min() )
99 {
100 fail_min = true;
101 constraintDiameter = constraint.Value().Min();
102 }
103
104 if( constraint.Value().HasMax() && actual > constraint.Value().Max() )
105 {
106 fail_max = true;
107 constraintDiameter = constraint.Value().Max();
108 }
109 }
110
111 if( fail_min || fail_max )
112 {
113 std::shared_ptr<DRC_ITEM> drcItem = DRC_ITEM::Create( DRCE_VIA_DIAMETER );
114 wxString msg;
115
116 if( fail_min )
117 {
118 msg = formatMsg( _( "(%s min diameter %s; actual %s)" ),
119 constraint.GetName(),
120 constraintDiameter,
121 actual );
122 }
123 else if( fail_max )
124 {
125 msg = formatMsg( _( "(%s max diameter %s; actual %s)" ),
126 constraint.GetName(),
127 constraintDiameter,
128 actual );
129 }
130
131 drcItem->SetErrorMessage( drcItem->GetErrorText() + wxS( " " ) + msg );
132 drcItem->SetItems( item );
133 drcItem->SetViolatingRule( constraint.GetParentRule() );
134
135 reportViolation( drcItem, via->GetPosition(), via->GetLayer() );
136 }
137
138 return true;
139 };
140
141 const int progressDelta = 500;
142 int ii = 0;
143
144 for( PCB_TRACK* item : m_drcEngine->GetBoard()->Tracks() )
145 {
146 if( !reportProgress( ii++, m_drcEngine->GetBoard()->Tracks().size(), progressDelta ) )
147 break;
148
149 if( !checkViaDiameter( item ) )
150 break;
151 }
152
154
155 return !m_drcEngine->IsCancelled();
156}
157
158
159namespace detail
160{
162}
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:79
const TRACKS & Tracks() const
Definition: board.h:327
BOARD * GetBoard() const
Definition: drc_engine.h:89
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:652
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:352
virtual bool Run() override
Run this provider against the given PCB with configured options (if any).
virtual const wxString GetName() const override
virtual const wxString GetDescription() const override
Represent a DRC "provider" which runs some DRC functions over a BOARD and spits out DRC_ITEM and posi...
wxString formatMsg(const wxString &aFormatString, const wxString &aSource, double aConstraint, double aActual)
virtual bool reportPhase(const wxString &aStageName)
virtual void reportViolation(std::shared_ptr< DRC_ITEM > &item, const VECTOR2I &aMarkerPos, int aMarkerLayer)
DRC_ENGINE * m_drcEngine
void reportAux(const wxString &aMsg)
virtual void reportRuleStatistics()
virtual bool reportProgress(size_t aCount, size_t aSize, size_t aDelta=1)
@ DRCE_VIA_DIAMETER
Definition: drc_item.h:58
@ VIA_DIAMETER_CONSTRAINT
Definition: drc_rule.h:64
#define _(s)
@ UNDEFINED_LAYER
Definition: layer_ids.h:61
static DRC_REGISTER_TEST_PROVIDER< DRC_TEST_PROVIDER_ANNULAR_WIDTH > dummy
@ RPT_SEVERITY_IGNORE
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:97