KiCad PCB EDA Suite
erc_settings.h File Reference
#include <erc_item.h>
#include <pin_type.h>
#include <settings/nested_settings.h>
#include <widgets/ui_common.h>

Go to the source code of this file.

Classes

class  ERC_SETTINGS
 Container for ERC settings. More...
 
class  SHEETLIST_ERC_ITEMS_PROVIDER
 An implementation of the RC_ITEM_LIST interface which uses the global SHEETLIST to fulfill the contract. More...
 

Macros

#define NPI   4
 Types of drive on a net (used for legacy ERC) More...
 
#define DRV   3
 
#define NET_NC   2
 
#define NOD   1
 
#define NOC   0
 

Enumerations

enum  ERCE_T {
  ERCE_UNSPECIFIED = 0 , ERCE_FIRST , ERCE_DUPLICATE_SHEET_NAME = ERCE_FIRST , ERCE_ENDPOINT_OFF_GRID ,
  ERCE_PIN_NOT_CONNECTED , ERCE_PIN_NOT_DRIVEN , ERCE_POWERPIN_NOT_DRIVEN , ERCE_HIERACHICAL_LABEL ,
  ERCE_NOCONNECT_CONNECTED , ERCE_NOCONNECT_NOT_CONNECTED , ERCE_LABEL_NOT_CONNECTED , ERCE_SIMILAR_LABELS ,
  ERCE_DIFFERENT_UNIT_FP , ERCE_MISSING_POWER_INPUT_PIN , ERCE_MISSING_INPUT_PIN , ERCE_MISSING_BIDI_PIN ,
  ERCE_MISSING_UNIT , ERCE_DIFFERENT_UNIT_NET , ERCE_BUS_ALIAS_CONFLICT , ERCE_DRIVER_CONFLICT ,
  ERCE_BUS_ENTRY_CONFLICT , ERCE_BUS_LABEL_ERROR , ERCE_BUS_TO_BUS_CONFLICT , ERCE_BUS_TO_NET_CONFLICT ,
  ERCE_NETCLASS_CONFLICT , ERCE_GLOBLABEL , ERCE_UNRESOLVED_VARIABLE , ERCE_SIMULATION_MODEL ,
  ERCE_WIRE_DANGLING , ERCE_LIB_SYMBOL_ISSUES , ERCE_UNANNOTATED , ERCE_EXTRA_UNITS ,
  ERCE_DIFFERENT_UNIT_VALUE , ERCE_DUPLICATE_REFERENCE , ERCE_BUS_ENTRY_NEEDED , ERCE_LAST = ERCE_BUS_ENTRY_NEEDED ,
  ERCE_PIN_TO_PIN_WARNING , ERCE_PIN_TO_PIN_ERROR , ERCE_ANNOTATION_ACTION
}
 ERC error codes. More...
 
enum class  PIN_ERROR { OK , WARNING , PP_ERROR , UNCONNECTED }
 The values a pin-to-pin entry in the pin matrix can take on. More...
 

Macro Definition Documentation

◆ DRV

#define DRV   3

Definition at line 102 of file erc_settings.h.

◆ NET_NC

#define NET_NC   2

Definition at line 103 of file erc_settings.h.

◆ NOC

#define NOC   0

Definition at line 105 of file erc_settings.h.

◆ NOD

#define NOD   1

Definition at line 104 of file erc_settings.h.

◆ NPI

#define NPI   4

Types of drive on a net (used for legacy ERC)

Definition at line 101 of file erc_settings.h.

Enumeration Type Documentation

◆ ERCE_T

enum ERCE_T

ERC error codes.

Enumerator
ERCE_UNSPECIFIED 
ERCE_FIRST 
ERCE_DUPLICATE_SHEET_NAME 

Duplicate sheet names within a given sheet.

ERCE_ENDPOINT_OFF_GRID 

Pin or wire-end off grid.

ERCE_PIN_NOT_CONNECTED 

Pin not connected and not no connect symbol.

ERCE_PIN_NOT_DRIVEN 

Pin connected to some others pins but no pin to drive it.

pins to drive it can be output, passive, 3sttae, I/O

ERCE_POWERPIN_NOT_DRIVEN 

Power input pin connected to some others pins but no power out pin to drive it.

ERCE_HIERACHICAL_LABEL 

Mismatch between hierarchical labels and pins sheets.

ERCE_NOCONNECT_CONNECTED 

A no connect symbol is connected to more than 1 pin.

ERCE_NOCONNECT_NOT_CONNECTED 

A no connect symbol is not connected to anything.

ERCE_LABEL_NOT_CONNECTED 

Label not connected to anything.

ERCE_SIMILAR_LABELS 

2 labels are equal for case insensitive comparisons.

ERCE_DIFFERENT_UNIT_FP 

Different units of the same symbol have different footprints assigned.

ERCE_MISSING_POWER_INPUT_PIN 

Symbol has power input pins that are not placed on the schematic.

ERCE_MISSING_INPUT_PIN 

Symbol has input pins that are not placed.

ERCE_MISSING_BIDI_PIN 

Symbol has bi-directional pins that are not placed.

ERCE_MISSING_UNIT 

Symbol has units that are not placed on the schematic.

ERCE_DIFFERENT_UNIT_NET 

Shared pin in a multi-unit symbol is connected to more than one net.

ERCE_BUS_ALIAS_CONFLICT 

Conflicting bus alias definitions across sheets.

ERCE_DRIVER_CONFLICT 

Conflicting drivers (labels, etc) on a subgraph.

ERCE_BUS_ENTRY_CONFLICT 

A wire connected to a bus doesn't match the bus.

ERCE_BUS_LABEL_ERROR 

A label attached to a bus isn't in bus format.

ERCE_BUS_TO_BUS_CONFLICT 

A connection between bus objects doesn't share at least one net.

ERCE_BUS_TO_NET_CONFLICT 

A bus wire is graphically connected to a net port/pin (or vice versa).

ERCE_NETCLASS_CONFLICT 

Multiple labels assign different netclasses to same net.

ERCE_GLOBLABEL 

A global label is unique.

ERCE_UNRESOLVED_VARIABLE 

A text variable could not be resolved.

ERCE_SIMULATION_MODEL 

An error was found in the simulation model.

ERCE_WIRE_DANGLING 

Some wires are not connected to anything else.

ERCE_LIB_SYMBOL_ISSUES 

Library symbol changed from current symbol in schematic or the library symbol link no longer valid.

ERCE_UNANNOTATED 

Symbol has not been annotated.

ERCE_EXTRA_UNITS 

Symbol has more units than are defined.

ERCE_DIFFERENT_UNIT_VALUE 

Units of same symbol have different values.

ERCE_DUPLICATE_REFERENCE 

More than one symbol with the same reference.

ERCE_BUS_ENTRY_NEEDED 

Importer failed to auto-place a bus entry.

ERCE_LAST 
ERCE_PIN_TO_PIN_WARNING 
ERCE_PIN_TO_PIN_ERROR 
ERCE_ANNOTATION_ACTION 

Definition at line 36 of file erc_settings.h.

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};
@ 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

enum class PIN_ERROR
strong

The values a pin-to-pin entry in the pin matrix can take on.

Enumerator
OK 
WARNING 
PP_ERROR 
UNCONNECTED 

Definition at line 92 of file erc_settings.h.

93{
94 OK,
95 WARNING,
98};
#define OK