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