KiCad PCB EDA Suite
Loading...
Searching...
No Matches
drc_rule.h
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) 2020-2023 KiCad Developers, see change_log.txt for contributors.
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#ifndef DRC_RULE_H
25#define DRC_RULE_H
26
27#include <kiid.h>
28#include <core/typeinfo.h>
29#include <optional>
30#include <core/minoptmax.h>
31#include <layer_ids.h>
32#include <lset.h>
33#include <netclass.h>
34#include <zones.h>
36#include <wx/intl.h>
38
39class BOARD_ITEM;
40class PCBEXPR_UCODE;
41class DRC_CONSTRAINT;
43
44
46{
75};
76
77
79{
90};
91
92
94{
95public:
96 DRC_RULE();
97 DRC_RULE( const wxString& aName );
98
99 virtual ~DRC_RULE();
100
101 virtual bool AppliesTo( const BOARD_ITEM* a, const BOARD_ITEM* b = nullptr ) const
102 {
103 return true;
104 };
105
106 void AddConstraint( DRC_CONSTRAINT& aConstraint );
107 std::optional<DRC_CONSTRAINT> FindConstraint( DRC_CONSTRAINT_T aType );
108
109public:
113 wxString m_Name;
117 std::vector<DRC_CONSTRAINT> m_Constraints;
119};
120
121
123{
124 public:
126 const wxString& aName = wxEmptyString ) :
127 m_Type( aType ),
128 m_Value(),
129 m_DisallowFlags( 0 ),
131 m_Test( nullptr ),
132 m_name( aName ),
133 m_parentRule( nullptr )
134 {
135 }
136
137 bool IsNull() const
138 {
139 return m_Type == NULL_CONSTRAINT;
140 }
141
142 const MINOPTMAX<int>& GetValue() const { return m_Value; }
144
145 void SetParentRule( DRC_RULE *aParentRule ) { m_parentRule = aParentRule; }
147
148 void SetName( const wxString& aName ) { m_name = aName; }
149
150 wxString GetName() const
151 {
152 if( m_parentRule )
153 {
155 return m_parentRule->m_Name;
156 else
157 return wxString::Format( _( "rule '%s'" ), m_parentRule->m_Name );
158 }
159
160 return m_name;
161 }
162
164 {
165 if( m_parentRule )
166 return m_parentRule->m_Severity;
167 else
169 }
170
171public:
177
178private:
179 wxString m_name; // For just-in-time constraints
180 DRC_RULE* m_parentRule; // For constraints found in rules
181};
182
183
184const DRC_CONSTRAINT* GetConstraint( const BOARD_ITEM* aItem, const BOARD_ITEM* bItem,
185 int aConstraint, PCB_LAYER_ID aLayer,
186 wxString* aRuleName = nullptr );
187
188
189#endif // DRC_RULE_H
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:79
DRC_RULE_CONDITION * m_Test
Definition: drc_rule.h:176
wxString GetName() const
Definition: drc_rule.h:150
int m_DisallowFlags
Definition: drc_rule.h:174
SEVERITY GetSeverity() const
Definition: drc_rule.h:163
DRC_RULE * m_parentRule
Definition: drc_rule.h:180
void SetParentRule(DRC_RULE *aParentRule)
Definition: drc_rule.h:145
MINOPTMAX< int > & Value()
Definition: drc_rule.h:143
const MINOPTMAX< int > & GetValue() const
Definition: drc_rule.h:142
ZONE_CONNECTION m_ZoneConnection
Definition: drc_rule.h:175
void SetName(const wxString &aName)
Definition: drc_rule.h:148
MINOPTMAX< int > m_Value
Definition: drc_rule.h:173
DRC_CONSTRAINT_T m_Type
Definition: drc_rule.h:172
wxString m_name
Definition: drc_rule.h:179
DRC_RULE * GetParentRule() const
Definition: drc_rule.h:146
DRC_CONSTRAINT(DRC_CONSTRAINT_T aType=NULL_CONSTRAINT, const wxString &aName=wxEmptyString)
Definition: drc_rule.h:125
bool IsNull() const
Definition: drc_rule.h:137
SEVERITY m_Severity
Definition: drc_rule.h:118
bool m_Unary
Definition: drc_rule.h:110
DRC_RULE_CONDITION * m_Condition
Definition: drc_rule.h:116
LSET m_LayerCondition
Definition: drc_rule.h:115
virtual bool AppliesTo(const BOARD_ITEM *a, const BOARD_ITEM *b=nullptr) const
Definition: drc_rule.h:101
KIID m_ImplicitItemId
Definition: drc_rule.h:112
DRC_RULE()
Definition: drc_rule.cpp:31
std::vector< DRC_CONSTRAINT > m_Constraints
Definition: drc_rule.h:117
bool m_Implicit
Definition: drc_rule.h:111
wxString m_Name
Definition: drc_rule.h:113
void AddConstraint(DRC_CONSTRAINT &aConstraint)
Definition: drc_rule.cpp:60
wxString m_LayerSource
Definition: drc_rule.h:114
virtual ~DRC_RULE()
Definition: drc_rule.cpp:54
std::optional< DRC_CONSTRAINT > FindConstraint(DRC_CONSTRAINT_T aType)
Definition: drc_rule.cpp:67
Definition: kiid.h:49
LSET is a set of PCB_LAYER_IDs.
Definition: lset.h:35
const DRC_CONSTRAINT * GetConstraint(const BOARD_ITEM *aItem, const BOARD_ITEM *bItem, int aConstraint, PCB_LAYER_ID aLayer, wxString *aRuleName=nullptr)
DRC_DISALLOW_T
Definition: drc_rule.h:79
@ DRC_DISALLOW_PADS
Definition: drc_rule.h:84
@ DRC_DISALLOW_VIAS
Definition: drc_rule.h:80
@ DRC_DISALLOW_TEXTS
Definition: drc_rule.h:86
@ DRC_DISALLOW_ZONES
Definition: drc_rule.h:85
@ DRC_DISALLOW_HOLES
Definition: drc_rule.h:88
@ DRC_DISALLOW_GRAPHICS
Definition: drc_rule.h:87
@ DRC_DISALLOW_FOOTPRINTS
Definition: drc_rule.h:89
@ DRC_DISALLOW_TRACKS
Definition: drc_rule.h:83
@ DRC_DISALLOW_MICRO_VIAS
Definition: drc_rule.h:81
@ DRC_DISALLOW_BB_VIAS
Definition: drc_rule.h:82
DRC_CONSTRAINT_T
Definition: drc_rule.h:46
@ ANNULAR_WIDTH_CONSTRAINT
Definition: drc_rule.h:58
@ COURTYARD_CLEARANCE_CONSTRAINT
Definition: drc_rule.h:53
@ VIA_DIAMETER_CONSTRAINT
Definition: drc_rule.h:64
@ ZONE_CONNECTION_CONSTRAINT
Definition: drc_rule.h:59
@ DIFF_PAIR_GAP_CONSTRAINT
Definition: drc_rule.h:67
@ DISALLOW_CONSTRAINT
Definition: drc_rule.h:63
@ TRACK_WIDTH_CONSTRAINT
Definition: drc_rule.h:57
@ SILK_CLEARANCE_CONSTRAINT
Definition: drc_rule.h:54
@ EDGE_CLEARANCE_CONSTRAINT
Definition: drc_rule.h:51
@ MIN_RESOLVED_SPOKES_CONSTRAINT
Definition: drc_rule.h:62
@ TEXT_THICKNESS_CONSTRAINT
Definition: drc_rule.h:56
@ LENGTH_CONSTRAINT
Definition: drc_rule.h:65
@ VIA_COUNT_CONSTRAINT
Definition: drc_rule.h:70
@ PHYSICAL_HOLE_CLEARANCE_CONSTRAINT
Definition: drc_rule.h:72
@ CLEARANCE_CONSTRAINT
Definition: drc_rule.h:48
@ NULL_CONSTRAINT
Definition: drc_rule.h:47
@ THERMAL_SPOKE_WIDTH_CONSTRAINT
Definition: drc_rule.h:61
@ CONNECTION_WIDTH_CONSTRAINT
Definition: drc_rule.h:74
@ THERMAL_RELIEF_GAP_CONSTRAINT
Definition: drc_rule.h:60
@ MAX_UNCOUPLED_CONSTRAINT
Definition: drc_rule.h:68
@ ASSERTION_CONSTRAINT
Definition: drc_rule.h:73
@ SKEW_CONSTRAINT
Definition: drc_rule.h:66
@ HOLE_CLEARANCE_CONSTRAINT
Definition: drc_rule.h:49
@ HOLE_SIZE_CONSTRAINT
Definition: drc_rule.h:52
@ TEXT_HEIGHT_CONSTRAINT
Definition: drc_rule.h:55
@ DIFF_PAIR_INTRA_SKEW_CONSTRAINT
Definition: drc_rule.h:69
@ PHYSICAL_CLEARANCE_CONSTRAINT
Definition: drc_rule.h:71
@ HOLE_TO_HOLE_CONSTRAINT
Definition: drc_rule.h:50
#define _(s)
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
SEVERITY
@ RPT_SEVERITY_UNDEFINED
ZONE_CONNECTION
How pads are covered by copper in zone.
Definition: zones.h:47