KiCad PCB EDA Suite
erc_settings.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) 2018-2020 CERN
5 * Copyright (C) 2020-2021 KiCad Developers, see AUTHORS.txt for contributors.
6 * @author Jon Evans <[email protected]>
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License along
19 * with this program. If not, see <http://www.gnu.org/licenses/>.
20 */
21
22#ifndef _ERC_SETTINGS_H
23#define _ERC_SETTINGS_H
24
25#include <erc_item.h>
26#include <pin_type.h>
28#include <widgets/ui_common.h>
29
30
31class SCH_MARKER;
32class SCHEMATIC;
33
34
37{
80
82
83 // Errors after this point will not automatically appear in the Severities Panel
84
85 ERCE_PIN_TO_PIN_WARNING, // pin connected to an other pin: warning level
86 ERCE_PIN_TO_PIN_ERROR, // pin connected to an other pin: error level
87 ERCE_ANNOTATION_ACTION // Not actually an error; just an action performed during
88 // annotation which is passed back through the error handler.
89};
90
92enum class PIN_ERROR
93{
94 OK,
95 WARNING,
98};
99
101#define NPI 4 // Net with Pin isolated, this pin has type Not Connected and must be left N.C.
102#define DRV 3 // Net driven by a signal (a pin output for instance)
103#define NET_NC 2 // Net "connected" to a "NoConnect symbol"
104#define NOD 1 // Net not driven ( Such as 2 or more connected inputs )
105#define NOC 0 // initial state of a net: no connection
106
114{
115public:
116 ERC_SETTINGS( JSON_SETTINGS* aParent, const std::string& aPath );
117
118 virtual ~ERC_SETTINGS();
119
120 bool operator==( const ERC_SETTINGS& other ) const
121 {
122 return ( other.m_ERCSeverities == m_ERCSeverities );
123 }
124
125 bool operator!=( const ERC_SETTINGS& other ) const
126 {
127 return !( other == *this );
128 }
129
130 bool IsTestEnabled( int aErrorCode ) const
131 {
132 return GetSeverity( aErrorCode ) != RPT_SEVERITY_IGNORE;
133 }
134
135 SEVERITY GetSeverity( int aErrorCode ) const;
136
137 void SetSeverity( int aErrorCode, SEVERITY aSeverity );
138
139 void ResetPinMap();
140
141 PIN_ERROR GetPinMapValue( int aFirstType, int aSecondType ) const
142 {
143 wxASSERT( aFirstType < ELECTRICAL_PINTYPES_TOTAL
144 && aSecondType < ELECTRICAL_PINTYPES_TOTAL );
145 return m_PinMap[aFirstType][aSecondType];
146 }
147
149 {
150 return m_PinMap[static_cast<int>( aFirstType )][static_cast<int>( aSecondType )];
151 }
152
153 void SetPinMapValue( int aFirstType, int aSecondType, PIN_ERROR aValue )
154 {
155 wxASSERT( aFirstType < ELECTRICAL_PINTYPES_TOTAL
156 && aSecondType < ELECTRICAL_PINTYPES_TOTAL );
157 m_PinMap[aFirstType][aSecondType] = aValue;
158 }
159
161 PIN_ERROR aValue )
162 {
163 m_PinMap[static_cast<int>( aFirstType )][static_cast<int>( aSecondType )] = aValue;
164 }
165
166 int GetPinMinDrive( ELECTRICAL_PINTYPE aFirstType, ELECTRICAL_PINTYPE aSecondType ) const
167 {
168 return m_PinMinDrive[static_cast<int>( aFirstType )][static_cast<int>( aSecondType )];
169 }
170
171public:
172
173 std::map<int, SEVERITY> m_ERCSeverities;
174 std::set<wxString> m_ErcExclusions;
175
177
179
180private:
181
183};
184
185
191{
192private:
195 std::vector<SCH_MARKER*> m_filteredMarkers;
196
197public:
199 m_schematic( aSchematic ),
200 m_severities( 0 )
201 { }
202
203 void SetSeverities( int aSeverities ) override;
204
205 int GetCount( int aSeverity = -1 ) const override;
206
207 std::shared_ptr<RC_ITEM> GetItem( int aIndex ) const override;
208
209 std::shared_ptr<ERC_ITEM> GetERCItem( int aIndex ) const;
210
211 void DeleteItem( int aIndex, bool aDeep ) override;
212
213private:
214
215 void visitMarkers( std::function<void( SCH_MARKER* )> aVisitor ) const;
216};
217
218
219#endif // _ERC_SETTINGS_H
Container for ERC settings.
Definition: erc_settings.h:114
bool IsTestEnabled(int aErrorCode) const
Definition: erc_settings.h:130
PIN_ERROR GetPinMapValue(ELECTRICAL_PINTYPE aFirstType, ELECTRICAL_PINTYPE aSecondType) const
Definition: erc_settings.h:148
static PIN_ERROR m_defaultPinMap[ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]
Default Look up table which gives the ERC error level for a pair of connected pins.
Definition: erc_settings.h:182
bool operator!=(const ERC_SETTINGS &other) const
Definition: erc_settings.h:125
SEVERITY GetSeverity(int aErrorCode) const
ERC_SETTINGS(JSON_SETTINGS *aParent, const std::string &aPath)
void SetPinMapValue(ELECTRICAL_PINTYPE aFirstType, ELECTRICAL_PINTYPE aSecondType, PIN_ERROR aValue)
Definition: erc_settings.h:160
void ResetPinMap()
void SetSeverity(int aErrorCode, SEVERITY aSeverity)
bool operator==(const ERC_SETTINGS &other) const
Definition: erc_settings.h:120
virtual ~ERC_SETTINGS()
PIN_ERROR GetPinMapValue(int aFirstType, int aSecondType) const
Definition: erc_settings.h:141
std::map< int, SEVERITY > m_ERCSeverities
Definition: erc_settings.h:173
std::set< wxString > m_ErcExclusions
Definition: erc_settings.h:174
static int m_PinMinDrive[ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]
Look up table which gives the minimal drive for a pair of connected pins on a net.
Definition: erc_settings.h:178
void SetPinMapValue(int aFirstType, int aSecondType, PIN_ERROR aValue)
Definition: erc_settings.h:153
PIN_ERROR m_PinMap[ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]
Definition: erc_settings.h:176
int GetPinMinDrive(ELECTRICAL_PINTYPE aFirstType, ELECTRICAL_PINTYPE aSecondType) const
Definition: erc_settings.h:166
NESTED_SETTINGS is a JSON_SETTINGS that lives inside a JSON_SETTINGS.
Provide an abstract interface of a RC_ITEM* list manager.
Definition: rc_item.h:48
Holds all the data relating to one schematic.
Definition: schematic.h:61
An implementation of the RC_ITEM_LIST interface which uses the global SHEETLIST to fulfill the contra...
Definition: erc_settings.h:191
int GetCount(int aSeverity=-1) const override
void SetSeverities(int aSeverities) override
void visitMarkers(std::function< void(SCH_MARKER *)> aVisitor) const
SHEETLIST_ERC_ITEMS_PROVIDER(SCHEMATIC *aSchematic)
Definition: erc_settings.h:198
void DeleteItem(int aIndex, bool aDeep) override
Remove (and optionally deletes) the indexed item from the list.
std::shared_ptr< ERC_ITEM > GetERCItem(int aIndex) const
std::vector< SCH_MARKER * > m_filteredMarkers
Definition: erc_settings.h:195
std::shared_ptr< RC_ITEM > GetItem(int aIndex) const override
Retrieve a RC_ITEM by index.
ERCE_T
ERC error codes.
Definition: erc_settings.h:37
@ ERCE_UNSPECIFIED
Definition: erc_settings.h:38
@ ERCE_UNANNOTATED
Symbol has not been annotated.
Definition: erc_settings.h:75
@ ERCE_POWERPIN_NOT_DRIVEN
Power input pin connected to some others pins but no power out pin to drive it.
Definition: erc_settings.h:45
@ ERCE_DRIVER_CONFLICT
Conflicting drivers (labels, etc) on a subgraph.
Definition: erc_settings.h:61
@ ERCE_MISSING_POWER_INPUT_PIN
Symbol has power input pins that are not placed on the schematic.
Definition: erc_settings.h:54
@ ERCE_SIMILAR_LABELS
2 labels are equal for case insensitive comparisons.
Definition: erc_settings.h:51
@ ERCE_ANNOTATION_ACTION
Definition: erc_settings.h:87
@ ERCE_FIRST
Definition: erc_settings.h:39
@ ERCE_LABEL_NOT_CONNECTED
Label not connected to anything.
Definition: erc_settings.h:50
@ ERCE_ENDPOINT_OFF_GRID
Pin or wire-end off grid.
Definition: erc_settings.h:41
@ ERCE_DUPLICATE_REFERENCE
More than one symbol with the same reference.
Definition: erc_settings.h:78
@ ERCE_EXTRA_UNITS
Symbol has more units than are defined.
Definition: erc_settings.h:76
@ ERCE_BUS_TO_BUS_CONFLICT
A connection between bus objects doesn't share at least one net.
Definition: erc_settings.h:64
@ ERCE_LAST
Definition: erc_settings.h:81
@ ERCE_BUS_LABEL_ERROR
A label attached to a bus isn't in bus format.
Definition: erc_settings.h:63
@ ERCE_BUS_ENTRY_CONFLICT
A wire connected to a bus doesn't match the bus.
Definition: erc_settings.h:62
@ ERCE_NETCLASS_CONFLICT
Multiple labels assign different netclasses to same net.
Definition: erc_settings.h:68
@ ERCE_GLOBLABEL
A global label is unique.
Definition: erc_settings.h:69
@ ERCE_BUS_TO_NET_CONFLICT
A bus wire is graphically connected to a net port/pin (or vice versa).
Definition: erc_settings.h:66
@ ERCE_NOCONNECT_NOT_CONNECTED
A no connect symbol is not connected to anything.
Definition: erc_settings.h:49
@ ERCE_DIFFERENT_UNIT_NET
Shared pin in a multi-unit symbol is connected to more than one net.
Definition: erc_settings.h:58
@ ERCE_PIN_NOT_CONNECTED
Pin not connected and not no connect symbol.
Definition: erc_settings.h:42
@ ERCE_BUS_ENTRY_NEEDED
Importer failed to auto-place a bus entry.
Definition: erc_settings.h:79
@ ERCE_UNRESOLVED_VARIABLE
A text variable could not be resolved.
Definition: erc_settings.h:70
@ ERCE_SIMULATION_MODEL
An error was found in the simulation model.
Definition: erc_settings.h:71
@ ERCE_DIFFERENT_UNIT_FP
Different units of the same symbol have different footprints assigned.
Definition: erc_settings.h:52
@ ERCE_NOCONNECT_CONNECTED
A no connect symbol is connected to more than 1 pin.
Definition: erc_settings.h:48
@ ERCE_PIN_TO_PIN_WARNING
Definition: erc_settings.h:85
@ ERCE_PIN_NOT_DRIVEN
Pin connected to some others pins but no pin to drive it.
Definition: erc_settings.h:43
@ ERCE_MISSING_INPUT_PIN
Symbol has input pins that are not placed.
Definition: erc_settings.h:55
@ ERCE_MISSING_UNIT
Symbol has units that are not placed on the schematic.
Definition: erc_settings.h:57
@ ERCE_DUPLICATE_SHEET_NAME
Duplicate sheet names within a given sheet.
Definition: erc_settings.h:40
@ ERCE_MISSING_BIDI_PIN
Symbol has bi-directional pins that are not placed.
Definition: erc_settings.h:56
@ ERCE_LIB_SYMBOL_ISSUES
Library symbol changed from current symbol in schematic or the library symbol link no longer valid.
Definition: erc_settings.h:73
@ ERCE_HIERACHICAL_LABEL
Mismatch between hierarchical labels and pins sheets.
Definition: erc_settings.h:47
@ ERCE_WIRE_DANGLING
Some wires are not connected to anything else.
Definition: erc_settings.h:72
@ ERCE_BUS_ALIAS_CONFLICT
Conflicting bus alias definitions across sheets.
Definition: erc_settings.h:60
@ ERCE_DIFFERENT_UNIT_VALUE
Units of same symbol have different values.
Definition: erc_settings.h:77
@ ERCE_PIN_TO_PIN_ERROR
Definition: erc_settings.h:86
PIN_ERROR
The values a pin-to-pin entry in the pin matrix can take on.
Definition: erc_settings.h:93
ELECTRICAL_PINTYPE
The symbol library pin object electrical types used in ERC tests.
Definition: pin_type.h:36
#define ELECTRICAL_PINTYPES_TOTAL
Definition: pin_type.h:53
SEVERITY
@ RPT_SEVERITY_IGNORE
Functions to provide common constants and other functions to assist in making a consistent UI.