KiCad PCB EDA Suite
ERC_SETTINGS Class Reference

Container for ERC settings. More...

#include <erc_settings.h>

Public Member Functions

void LoadDefaults ()
 
bool operator== (const ERC_SETTINGS &other) const
 
bool operator!= (const ERC_SETTINGS &other) const
 

Public Attributes

bool write_erc_file
 If true, write ERC results to a file. More...
 
bool check_similar_labels
 If true, check each sheet for labels that differ only by letter case. More...
 
bool check_unique_global_labels
 If true, check to ensure that each global label apperas more than once. More...
 
bool check_bus_driver_conflicts
 If true, check that buses don't have conflicting drivers. More...
 
bool check_bus_entry_conflicts
 If true, check that wires connecting to buses actually exist in the bus. More...
 
bool check_bus_to_bus_conflicts
 If true, check that bus-to-bus connections share at least one member. More...
 
bool check_bus_to_net_conflicts
 If true, check that bus wires don't graphically connect to net objects (or vice versa) More...
 

Detailed Description

Container for ERC settings.

Currently only stores flags about checks to run, but could later be expanded to contain the matrix of electrical pin types.

Definition at line 30 of file erc_settings.h.

Member Function Documentation

◆ LoadDefaults()

void ERC_SETTINGS::LoadDefaults ( )
inline

Definition at line 33 of file erc_settings.h.

34  {
35  write_erc_file = false;
36  check_similar_labels = true;
42  }
bool check_unique_global_labels
If true, check to ensure that each global label apperas more than once.
Definition: erc_settings.h:67
bool write_erc_file
If true, write ERC results to a file.
Definition: erc_settings.h:61
bool check_bus_to_bus_conflicts
If true, check that bus-to-bus connections share at least one member.
Definition: erc_settings.h:76
bool check_bus_to_net_conflicts
If true, check that bus wires don't graphically connect to net objects (or vice versa)
Definition: erc_settings.h:79
bool check_bus_driver_conflicts
If true, check that buses don't have conflicting drivers.
Definition: erc_settings.h:70
bool check_bus_entry_conflicts
If true, check that wires connecting to buses actually exist in the bus.
Definition: erc_settings.h:73
bool check_similar_labels
If true, check each sheet for labels that differ only by letter case.
Definition: erc_settings.h:64

References check_bus_driver_conflicts, check_bus_entry_conflicts, check_bus_to_bus_conflicts, check_bus_to_net_conflicts, check_similar_labels, check_unique_global_labels, and write_erc_file.

Referenced by DIALOG_ERC::ResetDefaultERCDiag().

◆ operator!=()

bool ERC_SETTINGS::operator!= ( const ERC_SETTINGS other) const
inline

Definition at line 55 of file erc_settings.h.

56  {
57  return !( other == *this );
58  }

◆ operator==()

bool ERC_SETTINGS::operator== ( const ERC_SETTINGS other) const
inline

Definition at line 44 of file erc_settings.h.

45  {
46  return ( other.write_erc_file == write_erc_file &&
53  }
bool check_unique_global_labels
If true, check to ensure that each global label apperas more than once.
Definition: erc_settings.h:67
bool write_erc_file
If true, write ERC results to a file.
Definition: erc_settings.h:61
bool check_bus_to_bus_conflicts
If true, check that bus-to-bus connections share at least one member.
Definition: erc_settings.h:76
bool check_bus_to_net_conflicts
If true, check that bus wires don't graphically connect to net objects (or vice versa)
Definition: erc_settings.h:79
bool check_bus_driver_conflicts
If true, check that buses don't have conflicting drivers.
Definition: erc_settings.h:70
bool check_bus_entry_conflicts
If true, check that wires connecting to buses actually exist in the bus.
Definition: erc_settings.h:73
bool check_similar_labels
If true, check each sheet for labels that differ only by letter case.
Definition: erc_settings.h:64

References check_bus_driver_conflicts, check_bus_entry_conflicts, check_bus_to_bus_conflicts, check_bus_to_net_conflicts, check_similar_labels, check_unique_global_labels, and write_erc_file.

Member Data Documentation

◆ check_bus_driver_conflicts

bool ERC_SETTINGS::check_bus_driver_conflicts

◆ check_bus_entry_conflicts

bool ERC_SETTINGS::check_bus_entry_conflicts

If true, check that wires connecting to buses actually exist in the bus.

Definition at line 73 of file erc_settings.h.

Referenced by SCH_EDIT_FRAME::GetProjectFileParameters(), LoadDefaults(), operator==(), CONNECTION_GRAPH::RunERC(), DIALOG_ERC::transferControlsToSettings(), and DIALOG_ERC::transferSettingsToControls().

◆ check_bus_to_bus_conflicts

bool ERC_SETTINGS::check_bus_to_bus_conflicts

If true, check that bus-to-bus connections share at least one member.

Definition at line 76 of file erc_settings.h.

Referenced by SCH_EDIT_FRAME::GetProjectFileParameters(), LoadDefaults(), operator==(), CONNECTION_GRAPH::RunERC(), DIALOG_ERC::transferControlsToSettings(), and DIALOG_ERC::transferSettingsToControls().

◆ check_bus_to_net_conflicts

bool ERC_SETTINGS::check_bus_to_net_conflicts

If true, check that bus wires don't graphically connect to net objects (or vice versa)

Definition at line 79 of file erc_settings.h.

Referenced by SCH_EDIT_FRAME::GetProjectFileParameters(), LoadDefaults(), operator==(), CONNECTION_GRAPH::RunERC(), DIALOG_ERC::transferControlsToSettings(), and DIALOG_ERC::transferSettingsToControls().

◆ check_similar_labels

bool ERC_SETTINGS::check_similar_labels

If true, check each sheet for labels that differ only by letter case.

Definition at line 64 of file erc_settings.h.

Referenced by SCH_EDIT_FRAME::GetProjectFileParameters(), LoadDefaults(), operator==(), DIALOG_ERC::TestErc(), DIALOG_ERC::transferControlsToSettings(), and DIALOG_ERC::transferSettingsToControls().

◆ check_unique_global_labels

bool ERC_SETTINGS::check_unique_global_labels

If true, check to ensure that each global label apperas more than once.

Definition at line 67 of file erc_settings.h.

Referenced by SCH_EDIT_FRAME::GetProjectFileParameters(), LoadDefaults(), operator==(), CONNECTION_GRAPH::RunERC(), DIALOG_ERC::transferControlsToSettings(), and DIALOG_ERC::transferSettingsToControls().

◆ write_erc_file

bool ERC_SETTINGS::write_erc_file

The documentation for this class was generated from the following file: