KiCad PCB EDA Suite
ERC_SETTINGS Class Reference

Container for ERC settings. More...

#include <erc_settings.h>

Inheritance diagram for ERC_SETTINGS:
NESTED_SETTINGS JSON_SETTINGS

Public Member Functions

 ERC_SETTINGS (JSON_SETTINGS *aParent, const std::string &aPath)
 
virtual ~ERC_SETTINGS ()
 
void LoadDefaults ()
 
bool operator== (const ERC_SETTINGS &other) const
 
bool operator!= (const ERC_SETTINGS &other) const
 
bool IsTestEnabled (int aErrorCode) const
 
int GetSeverity (int aErrorCode) const
 
void SetSeverity (int aErrorCode, int aSeverity)
 
void ResetPinMap ()
 
PIN_ERROR GetPinMapValue (int aFirstType, int aSecondType) const
 
PIN_ERROR GetPinMapValue (ELECTRICAL_PINTYPE aFirstType, ELECTRICAL_PINTYPE aSecondType) const
 
void SetPinMapValue (int aFirstType, int aSecondType, PIN_ERROR aValue)
 
void SetPinMapValue (ELECTRICAL_PINTYPE aFirstType, ELECTRICAL_PINTYPE aSecondType, PIN_ERROR aValue)
 
int GetPinMinDrive (ELECTRICAL_PINTYPE aFirstType, ELECTRICAL_PINTYPE aSecondType) const
 
bool LoadFromFile (const std::string &aDirectory="") override
 Loads the JSON document from the parent and then calls Load() More...
 
bool SaveToFile (const std::string &aDirectory="", bool aForce=false) override
 Calls Store() and then saves the JSON document contents into the parent JSON_SETTINGS. More...
 
void SetParent (JSON_SETTINGS *aParent)
 
JSON_SETTINGSGetParent ()
 
std::string GetFilename () const
 
wxString GetFullFilename () const
 
SETTINGS_LOC GetLocation () const
 
void SetLegacyFilename (const std::string &aFilename)
 
virtual void Load ()
 Updates the parameters of this object based on the current JSON document contents. More...
 
virtual bool Store ()
 Stores the current parameters into the JSON document represented by this object Note: this doesn't do any writing to disk; that's handled by SETTINGS_MANAGER. More...
 
void ResetToDefaults ()
 Resets all parameters to default values. More...
 
OPT< nlohmann::jsonGetJson (const std::string &aPath) const
 Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1.key2.key3" to refer to nested objects. More...
 
template<typename ValueType >
OPT< ValueType > Get (const std::string &aPath) const
 Fetches a value from within the JSON document. More...
 
template<>
OPT< wxString > Get (const std::string &aPath) const
 
template<typename ValueType >
void Set (const std::string &aPath, ValueType aVal)
 Stores a value into the JSON document Will throw an exception if ValueType isn't something that the library can handle. More...
 
template<>
void Set (const std::string &aPath, wxString aVal)
 
template<>
void Set (const std::string &aPath, wxString aVal)
 
virtual bool Migrate ()
 Migrates the schema of this settings from the version in the file to the latest version. More...
 
virtual bool MigrateFromLegacy (wxConfigBase *aLegacyConfig)
 Migrates from wxConfig to JSON-based configuration. More...
 
void AddNestedSettings (NESTED_SETTINGS *aSettings)
 Transfers ownership of a given NESTED_SETTINGS to this object. More...
 
void ReleaseNestedSettings (NESTED_SETTINGS *aSettings)
 Saves and frees a nested settings object, if it exists within this one. More...
 
void SetManager (SETTINGS_MANAGER *aManager)
 

Static Public Member Functions

static nlohmann::json::json_pointer PointerFromString (std::string aPath)
 Builds a JSON pointer based on a given string. More...
 

Public Attributes

std::map< int, int > m_Severities
 
PIN_ERROR m_PinMap [ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]
 

Static Public Attributes

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. More...
 

Protected Member Functions

template<typename ValueType >
bool fromLegacy (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy wxConfig value to a given JSON pointer value. More...
 
bool fromLegacyString (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy wxConfig string value to a given JSON pointer value. More...
 
bool fromLegacyColor (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy COLOR4D stored in a wxConfig string to a given JSON pointer value. More...
 
virtual wxString getFileExt () const
 
virtual wxString getLegacyFileExt () const
 

Protected Attributes

JSON_SETTINGSm_parent
 A pointer to the parent object to load and store from. More...
 
std::string m_path
 The path (in pointer format) of where to store this document in the parent. More...
 
std::string m_filename
 The filename (not including path) of this settings file. More...
 
std::string m_legacy_filename
 The filename of the wxConfig legacy file (if different from m_filename) More...
 
SETTINGS_LOC m_location
 The location of this settings file (. More...
 
std::vector< PARAM_BASE * > m_params
 The list of parameters (owned by this object) More...
 
std::vector< NESTED_SETTINGS * > m_nested_settings
 Nested settings files that live inside this one, if any. More...
 
bool m_createIfMissing
 Whether or not the backing store file should be created it if doesn't exist. More...
 
bool m_createIfDefault
 Whether or not the backing store file should be created if all parameters are still at their default values. More...
 
bool m_writeFile
 Whether or not the backing store file should be written. More...
 
bool m_deleteLegacyAfterMigration
 Whether or not to delete legacy file after migration. More...
 
bool m_resetParamsIfMissing
 Whether or not to set parameters to their default value if missing from JSON on Load() More...
 
int m_schemaVersion
 Version of this settings schema. More...
 
SETTINGS_MANAGERm_manager
 A pointer to the settings manager managing this file (may be null) More...
 
std::vector< nlohmann::json::json_pointer > m_preserved_paths
 A list of JSON pointers that are preserved during a read-update-write to disk. More...
 

Static Private Attributes

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. 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 87 of file erc_settings.h.

Constructor & Destructor Documentation

◆ ERC_SETTINGS()

ERC_SETTINGS::ERC_SETTINGS ( JSON_SETTINGS aParent,
const std::string &  aPath 
)

Definition at line 84 of file erc_settings.cpp.

84  :
85  NESTED_SETTINGS( "erc", ercSettingsSchemaVersion, aParent, aPath )
86 {
87  ResetPinMap();
88 
89  for( int i = ERCE_FIRST; i <= ERCE_LAST; ++i )
91 
94 
95  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "rule_severities",
96  [&]() -> nlohmann::json
97  {
98  nlohmann::json ret = {};
99 
100  for( const RC_ITEM& item : ERC_ITEM::GetItemsWithSeverities() )
101  {
102  int code = item.GetErrorCode();
103 
104  if( !m_Severities.count( code ) )
105  continue;
106 
107  wxString name = item.GetSettingsKey();
108 
109  ret[std::string( name.ToUTF8() )] =
110  SeverityToString( static_cast<SEVERITY>( m_Severities[code] ) );
111  }
112 
113  return ret;
114  },
115  [&]( const nlohmann::json& aJson )
116  {
117  if( !aJson.is_object() )
118  return;
119 
120  for( const RC_ITEM& item : ERC_ITEM::GetItemsWithSeverities() )
121  {
122  int code = item.GetErrorCode();
123  wxString name = item.GetSettingsKey();
124 
125  std::string key( name.ToUTF8() );
126 
127  if( aJson.contains( key ) )
128  m_Severities[code] = SeverityFromString( aJson[key] );
129  }
130  },
131  {} ) );
132 
133  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "pin_map",
134  [&]() -> nlohmann::json
135  {
136  nlohmann::json ret = nlohmann::json::array();
137 
138  for( int i = 0; i < ELECTRICAL_PINTYPES_TOTAL; i++ )
139  {
140  nlohmann::json inner = nlohmann::json::array();
141 
142  for( int j = 0; j < ELECTRICAL_PINTYPES_TOTAL; j++ )
143  inner.push_back( static_cast<int>( GetPinMapValue( i, j ) ) );
144 
145  ret.push_back( inner );
146  }
147 
148  return ret;
149  },
150  [&]( const nlohmann::json& aJson )
151  {
152  if( !aJson.is_array() || aJson.size() != ELECTRICAL_PINTYPES_TOTAL )
153  return;
154 
155  for( size_t i = 0; i < ELECTRICAL_PINTYPES_TOTAL; i++ )
156  {
157  if( i > aJson.size() - 1 )
158  break;
159 
160  nlohmann::json inner = aJson[i];
161 
162  if( !inner.is_array() || inner.size() != ELECTRICAL_PINTYPES_TOTAL )
163  return;
164 
165  for( size_t j = 0; j < ELECTRICAL_PINTYPES_TOTAL; j++ )
166  {
167  if( inner[j].is_number_integer() )
168  {
169  int val = inner[j].get<int>();
170 
171  if( val >= 0 && val <= static_cast<int>( PIN_ERROR::UNCONNECTED ) )
172  SetPinMapValue( i, j, static_cast<PIN_ERROR>( val ) );
173  }
174  }
175  }
176  },
177  {} ) );
178 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
Like a normal param, but with custom getter and setter functions.
Definition: parameters.h:227
static std::vector< std::reference_wrapper< RC_ITEM > > GetItemsWithSeverities()
Definition: erc_item.h:39
RC_ITEM is a holder for a DRC (in Pcbnew) or ERC (in Eeschema) error item.
Definition: rc_item.h:77
nlohmann::json json
Definition: gerbview.cpp:40
void ResetPinMap()
const int ercSettingsSchemaVersion
std::map< int, int > m_Severities
Definition: erc_settings.h:157
wxString SeverityToString(const SEVERITY &aSeverity)
Definition: ui_common.cpp:119
const char * name
Definition: DXF_plotter.cpp:60
SEVERITY SeverityFromString(const wxString &aSeverity)
Definition: ui_common.cpp:108
void SetPinMapValue(int aFirstType, int aSecondType, PIN_ERROR aValue)
Definition: erc_settings.h:137
NESTED_SETTINGS(const std::string &aName, int aSchemaVersion, JSON_SETTINGS *aParent, const std::string &aPath)
PIN_ERROR GetPinMapValue(int aFirstType, int aSecondType) const
Definition: erc_settings.h:125
#define ELECTRICAL_PINTYPES_TOTAL
Definition: pin_type.h:54

References ELECTRICAL_PINTYPES_TOTAL, ERCE_FIRST, ERCE_LAST, ERCE_PIN_TO_PIN_WARNING, ERCE_UNSPECIFIED, ERC_ITEM::GetItemsWithSeverities(), GetPinMapValue(), JSON_SETTINGS::m_params, m_Severities, name, ResetPinMap(), RPT_SEVERITY_ERROR, RPT_SEVERITY_UNDEFINED, RPT_SEVERITY_WARNING, SetPinMapValue(), SeverityFromString(), SeverityToString(), and UNCONNECTED.

◆ ~ERC_SETTINGS()

ERC_SETTINGS::~ERC_SETTINGS ( )
virtual

Definition at line 181 of file erc_settings.cpp.

182 {
183  if( m_parent )
184  {
186  m_parent = nullptr;
187  }
188 }
JSON_SETTINGS * m_parent
A pointer to the parent object to load and store from.
void ReleaseNestedSettings(NESTED_SETTINGS *aSettings)
Saves and frees a nested settings object, if it exists within this one.

References NESTED_SETTINGS::m_parent, and JSON_SETTINGS::ReleaseNestedSettings().

Member Function Documentation

◆ AddNestedSettings()

void JSON_SETTINGS::AddNestedSettings ( NESTED_SETTINGS aSettings)
inherited

Transfers ownership of a given NESTED_SETTINGS to this object.

Can be used to construct a NESTED_SETTINGS without the parent object needing to know about the implementation of the nested object;

Parameters
aSettingsis the settings object to take ownership of
aTargetis a pointer to update to the passed in settings

Definition at line 501 of file json_settings.cpp.

502 {
503  wxLogTrace( traceSettings, "AddNestedSettings %s", aSettings->GetFilename() );
504  m_nested_settings.push_back( aSettings );
505 }
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
std::string GetFilename() const
Definition: json_settings.h:56
const char * traceSettings
Flag to enable settings tracing.

References JSON_SETTINGS::GetFilename(), JSON_SETTINGS::m_nested_settings, and traceSettings.

Referenced by NESTED_SETTINGS::SetParent().

◆ fromLegacy()

template<typename ValueType >
template bool JSON_SETTINGS::fromLegacy< bool > ( wxConfigBase *  aConfig,
const std::string &  aKey,
const std::string &  aDest 
)
protectedinherited

Translates a legacy wxConfig value to a given JSON pointer value.

Template Parameters
ValueTypeis the basic type of the value
Parameters
aConfigis the legacy config to read from
aKeyis the key (within the current path) to read
aDestis a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 413 of file json_settings.cpp.

415 {
416  ValueType val;
417 
418  if( aConfig->Read( aKey, &val ) )
419  {
420  try
421  {
422  ( *this )[PointerFromString( aDest )] = val;
423  }
424  catch( ... )
425  {
426  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
427  return false;
428  }
429 
430  return true;
431  }
432 
433  return false;
434 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

◆ fromLegacyColor()

bool JSON_SETTINGS::fromLegacyColor ( wxConfigBase *  aConfig,
const std::string &  aKey,
const std::string &  aDest 
)
protectedinherited

Translates a legacy COLOR4D stored in a wxConfig string to a given JSON pointer value.

Parameters
aConfigis the legacy config to read from
aKeyis the key (within the current path) to read
aDestis a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 473 of file json_settings.cpp.

475 {
476  wxString str;
477 
478  if( aConfig->Read( aKey, &str ) )
479  {
481  color.SetFromWxString( str );
482 
483  try
484  {
485  nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
486  ( *this )[PointerFromString( aDest )] = js;
487  }
488  catch( ... )
489  {
490  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
491  return false;
492  }
493 
494  return true;
495  }
496 
497  return false;
498 }
int color
Definition: DXF_plotter.cpp:61
nlohmann::json json
Definition: gerbview.cpp:40
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:99

References color, and JSON_SETTINGS::PointerFromString().

Referenced by APP_SETTINGS_BASE::migrateWindowConfig().

◆ fromLegacyString()

bool JSON_SETTINGS::fromLegacyString ( wxConfigBase *  aConfig,
const std::string &  aKey,
const std::string &  aDest 
)
protectedinherited

Translates a legacy wxConfig string value to a given JSON pointer value.

Parameters
aConfigis the legacy config to read from
aKeyis the key (within the current path) to read
aDestis a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 449 of file json_settings.cpp.

451 {
452  wxString str;
453 
454  if( aConfig->Read( aKey, &str ) )
455  {
456  try
457  {
458  ( *this )[PointerFromString( aDest )] = str.ToUTF8();
459  }
460  catch( ... )
461  {
462  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
463  return false;
464  }
465 
466  return true;
467  }
468 
469  return false;
470 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

Referenced by BITMAP2CMP_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), LIBEDIT_SETTINGS::MigrateFromLegacy(), PROJECT_FILE::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), and APP_SETTINGS_BASE::migrateWindowConfig().

◆ Get() [1/2]

template<typename ValueType >
OPT<ValueType> JSON_SETTINGS::Get ( const std::string &  aPath) const
inlineinherited

Fetches a value from within the JSON document.

Will return an empty optional if the value is not found or a mismatching type.

Template Parameters
ValueTypeis the type to cast to
Parameters
aPathis the path within the document to retrieve
Returns
a value from within this document

Definition at line 111 of file json_settings.h.

112  {
113  if( OPT<nlohmann::json> ret = GetJson( aPath ) )
114  {
115  try
116  {
117  return ret->get<ValueType>();
118  }
119  catch( ... )
120  {
121  }
122  }
123 
124  return NULLOPT;
125  }
OPT< nlohmann::json > GetJson(const std::string &aPath) const
Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1....
const auto NULLOPT
Definition: optional.h:9
boost::optional< T > OPT
Definition: optional.h:7

References JSON_SETTINGS::GetJson(), and NULLOPT.

Referenced by PARAM< wxString >::Load(), COLOR_MAP_PARAM::Load(), PARAM_LAMBDA< ValueType >::Load(), PARAM_SCALED< ValueType >::Load(), BOARD_DESIGN_SETTINGS::LoadFromFile(), PARAM< wxString >::MatchesFile(), COLOR_MAP_PARAM::MatchesFile(), PARAM_PATH::MatchesFile(), PARAM_LAMBDA< ValueType >::MatchesFile(), and PARAM_SCALED< ValueType >::MatchesFile().

◆ Get() [2/2]

OPT< wxString > JSON_SETTINGS::Get ( const std::string &  aPath) const
inherited

Definition at line 531 of file json_settings.cpp.

532 {
533  if( OPT<nlohmann::json> opt_json = GetJson( aPath ) )
534  return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
535 
536  return NULLOPT;
537 }
OPT< nlohmann::json > GetJson(const std::string &aPath) const
Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1....
const auto NULLOPT
Definition: optional.h:9
boost::optional< T > OPT
Definition: optional.h:7

References JSON_SETTINGS::GetJson(), and NULLOPT.

◆ getFileExt()

virtual wxString JSON_SETTINGS::getFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 217 of file json_settings.h.

218  {
219  return wxT( "json" );
220  }

Referenced by JSON_SETTINGS::GetFullFilename(), JSON_SETTINGS::LoadFromFile(), and JSON_SETTINGS::SaveToFile().

◆ GetFilename()

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const
inherited

Definition at line 69 of file json_settings.cpp.

70 {
71  return wxString( m_filename.c_str(), wxConvUTF8 ) + "." + getFileExt();
72 }
std::string m_filename
The filename (not including path) of this settings file.
virtual wxString getFileExt() const

References JSON_SETTINGS::getFileExt(), and JSON_SETTINGS::m_filename.

Referenced by JSON_SETTINGS::JSON_SETTINGS(), JSON_SETTINGS::LoadFromFile(), and JSON_SETTINGS::SaveToFile().

◆ GetJson()

OPT< nlohmann::json > JSON_SETTINGS::GetJson ( const std::string &  aPath) const
inherited

Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1.key2.key3" to refer to nested objects.

Parameters
aPathis a string containing one or more keys separated by '.'
Returns
a JSON object from within this one

Definition at line 358 of file json_settings.cpp.

359 {
360  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
361 
362  if( this->contains( ptr ) )
363  {
364  try
365  {
366  return OPT<nlohmann::json>{ this->at( ptr ) };
367  }
368  catch( ... )
369  {
370  }
371  }
372 
373  return OPT<nlohmann::json>{};
374 }
boost::optional< T > OPT
Definition: optional.h:7
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

Referenced by JSON_SETTINGS::Get(), PARAM_LAMBDA< ValueType >::Load(), PARAM_LIST< wxString >::Load(), PARAM_MAP< Value >::Load(), PARAM_WXSTRING_MAP::Load(), PARAM_LAMBDA< ValueType >::MatchesFile(), PARAM_LIST< wxString >::MatchesFile(), PARAM_PATH_LIST::MatchesFile(), PARAM_MAP< Value >::MatchesFile(), and PARAM_WXSTRING_MAP::MatchesFile().

◆ getLegacyFileExt()

virtual wxString JSON_SETTINGS::getLegacyFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 222 of file json_settings.h.

223  {
224  return wxEmptyString;
225  }

Referenced by JSON_SETTINGS::LoadFromFile().

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 60 of file json_settings.h.

60 { return m_location; }
SETTINGS_LOC m_location
The location of this settings file (.

References JSON_SETTINGS::m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ GetParent()

JSON_SETTINGS* NESTED_SETTINGS::GetParent ( void  )
inlineinherited

Definition at line 54 of file nested_settings.h.

55  {
56  return m_parent;
57  }
JSON_SETTINGS * m_parent
A pointer to the parent object to load and store from.

References NESTED_SETTINGS::m_parent.

Referenced by BOARD_DESIGN_SETTINGS::LoadFromFile().

◆ GetPinMapValue() [1/2]

PIN_ERROR ERC_SETTINGS::GetPinMapValue ( int  aFirstType,
int  aSecondType 
) const
inline

Definition at line 125 of file erc_settings.h.

126  {
127  wxASSERT( aFirstType < ELECTRICAL_PINTYPES_TOTAL
128  && aSecondType < ELECTRICAL_PINTYPES_TOTAL );
129  return m_PinMap[aFirstType][aSecondType];
130  }
PIN_ERROR m_PinMap[ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]
Definition: erc_settings.h:159
#define ELECTRICAL_PINTYPES_TOTAL
Definition: pin_type.h:54

References ELECTRICAL_PINTYPES_TOTAL, and m_PinMap.

Referenced by PANEL_SETUP_PINMAP::changeErrorLevel(), ERC_SETTINGS(), PANEL_SETUP_PINMAP::reBuildMatrixPanel(), and ERC_TESTER::TestOthersItems().

◆ GetPinMapValue() [2/2]

PIN_ERROR ERC_SETTINGS::GetPinMapValue ( ELECTRICAL_PINTYPE  aFirstType,
ELECTRICAL_PINTYPE  aSecondType 
) const
inline

Definition at line 132 of file erc_settings.h.

133  {
134  return m_PinMap[static_cast<int>( aFirstType )][static_cast<int>( aSecondType )];
135  }
PIN_ERROR m_PinMap[ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]
Definition: erc_settings.h:159

References m_PinMap.

◆ GetPinMinDrive()

int ERC_SETTINGS::GetPinMinDrive ( ELECTRICAL_PINTYPE  aFirstType,
ELECTRICAL_PINTYPE  aSecondType 
) const
inline

Definition at line 150 of file erc_settings.h.

151  {
152  return m_PinMinDrive[static_cast<int>( aFirstType )][static_cast<int>( aSecondType )];
153  }
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:161

References m_PinMinDrive.

Referenced by ERC_TESTER::TestOthersItems().

◆ GetSeverity()

int ERC_SETTINGS::GetSeverity ( int  aErrorCode) const

Definition at line 191 of file erc_settings.cpp.

192 {
193  // Special-case pin-to-pin errors:
194  // Ignore-or-not is controlled by ERCE_PIN_TO_PIN_WARNING (for both)
195  // Warning-or-error is controlled by which errorCode it is
196  if( aErrorCode == ERCE_PIN_TO_PIN_ERROR )
197  {
198  wxASSERT( m_Severities.count( ERCE_PIN_TO_PIN_WARNING ) );
199 
201  return RPT_SEVERITY_IGNORE;
202  else
203  return RPT_SEVERITY_ERROR;
204  }
205  else if( aErrorCode == ERCE_PIN_TO_PIN_WARNING )
206  {
207  wxASSERT( m_Severities.count( ERCE_PIN_TO_PIN_WARNING ) );
208 
210  return RPT_SEVERITY_IGNORE;
211  else
212  return RPT_SEVERITY_WARNING;
213  }
214 
215  wxCHECK_MSG( m_Severities.count( aErrorCode ), RPT_SEVERITY_IGNORE,
216  "Missing severity from map in ERC_SETTINGS!" );
217 
218  return m_Severities.at( aErrorCode );
219 }
std::map< int, int > m_Severities
Definition: erc_settings.h:157

References ERCE_PIN_TO_PIN_ERROR, ERCE_PIN_TO_PIN_WARNING, m_Severities, RPT_SEVERITY_ERROR, RPT_SEVERITY_IGNORE, and RPT_SEVERITY_WARNING.

Referenced by ERC_TESTER::diagnose(), SHEETLIST_ERC_ITEMS_PROVIDER::GetCount(), DIALOG_ERC::OnERCItemRClick(), SHEETLIST_ERC_ITEMS_PROVIDER::SetSeverities(), and DIALOG_ERC::writeReport().

◆ IsTestEnabled()

bool ERC_SETTINGS::IsTestEnabled ( int  aErrorCode) const
inline

Definition at line 114 of file erc_settings.h.

115  {
116  return m_Severities.at( aErrorCode ) != RPT_SEVERITY_IGNORE;
117  }
std::map< int, int > m_Severities
Definition: erc_settings.h:157

References m_Severities, and RPT_SEVERITY_IGNORE.

Referenced by CONNECTION_GRAPH::ercCheckLabels(), CONNECTION_GRAPH::RunERC(), and PARAM_CFG_SEVERITIES::SaveParam().

◆ Load()

void JSON_SETTINGS::Load ( )
virtualinherited

Updates the parameters of this object based on the current JSON document contents.

Definition at line 75 of file json_settings.cpp.

76 {
77  for( auto param : m_params )
78  {
79  try
80  {
81  param->Load( this, m_resetParamsIfMissing );
82  }
83  catch( ... )
84  {
85  // Skip unreadable parameters in file:
86 #ifdef DEBUG
87  wxLogMessage( wxString::Format( "param '%s' load err", param->GetJsonPath().c_str() ) );
88 #endif
89  }
90  }
91 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
bool m_resetParamsIfMissing
Whether or not to set parameters to their default value if missing from JSON on Load()
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205

References Format(), JSON_SETTINGS::m_params, and JSON_SETTINGS::m_resetParamsIfMissing.

Referenced by NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), COLOR_SETTINGS::migrateSchema0to1(), and SETTINGS_MANAGER::SaveColorSettings().

◆ LoadDefaults()

◆ LoadFromFile()

bool NESTED_SETTINGS::LoadFromFile ( const std::string &  aDirectory = "")
overridevirtualinherited

Loads the JSON document from the parent and then calls Load()

Parameters
aDirectory

Reimplemented from JSON_SETTINGS.

Definition at line 44 of file nested_settings.cpp.

45 {
46  clear();
47  bool success = false;
48 
49  if( m_parent )
50  {
51  nlohmann::json::json_pointer ptr = PointerFromString( m_path );
52 
53  if( m_parent->contains( ptr ) )
54  {
55  try
56  {
57  update( ( *m_parent )[ptr] );
58 
59  wxLogTrace( traceSettings, "Loaded NESTED_SETTINGS %s with schema %d",
61 
62  success = true;
63  }
64  catch( ... )
65  {
66  wxLogTrace( traceSettings, "NESTED_SETTINGS %s: Could not load from %s at %s",
68  }
69  }
70  }
71 
72  Load();
73 
74  return success;
75 }
std::string m_filename
The filename (not including path) of this settings file.
JSON_SETTINGS * m_parent
A pointer to the parent object to load and store from.
std::string m_path
The path (in pointer format) of where to store this document in the parent.
std::string GetFilename() const
Definition: json_settings.h:56
const char * traceSettings
Flag to enable settings tracing.
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
int m_schemaVersion
Version of this settings schema.
virtual void Load()
Updates the parameters of this object based on the current JSON document contents.

References MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::clear(), JSON_SETTINGS::GetFilename(), JSON_SETTINGS::Load(), JSON_SETTINGS::m_filename, NESTED_SETTINGS::m_parent, NESTED_SETTINGS::m_path, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS::PointerFromString(), and traceSettings.

Referenced by BOARD_DESIGN_SETTINGS::LoadFromFile(), DIALOG_SCHEMATIC_SETUP::OnAuxiliaryAction(), PNS::ROUTING_SETTINGS::ROUTING_SETTINGS(), NESTED_SETTINGS::SetParent(), and SCHEMATIC::SetProject().

◆ Migrate()

bool JSON_SETTINGS::Migrate ( )
virtualinherited

Migrates the schema of this settings from the version in the file to the latest version.

Schema migration doesn't need to be used every time a setting is added! This is intended to be more of an "escape hatch" in the event that we decide to move settings around or make other changes to a settings file format that can't simply be handled by loading a new default

Returns
true if migration was successful

Reimplemented in COMMON_SETTINGS, COLOR_SETTINGS, and FOOTPRINT_EDITOR_SETTINGS.

Definition at line 377 of file json_settings.cpp.

378 {
379  wxLogTrace( traceSettings, "Migrate() not implemented for %s", typeid( *this ).name() );
380  return false;
381 }
const char * traceSettings
Flag to enable settings tracing.

References traceSettings.

Referenced by JSON_SETTINGS::LoadFromFile().

◆ MigrateFromLegacy()

bool JSON_SETTINGS::MigrateFromLegacy ( wxConfigBase *  aLegacyConfig)
virtualinherited

Migrates from wxConfig to JSON-based configuration.

Should be implemented by any subclasses of JSON_SETTINGS that map to a legacy (wxConfig-based) config file.

Parameters
aLegacyConfigis a wxConfigBase holding a loaded configuration to migrate
Returns
true if migration was successful

Reimplemented in PCBNEW_SETTINGS, EESCHEMA_SETTINGS, APP_SETTINGS_BASE, PCB_CALCULATOR_SETTINGS, COMMON_SETTINGS, EDA_3D_VIEWER_SETTINGS, COLOR_SETTINGS, PROJECT_FILE, LIBEDIT_SETTINGS, PROJECT_LOCAL_SETTINGS, GERBVIEW_SETTINGS, FOOTPRINT_EDITOR_SETTINGS, CVPCB_SETTINGS, BITMAP2CMP_SETTINGS, PL_EDITOR_SETTINGS, and KICAD_SETTINGS.

Definition at line 384 of file json_settings.cpp.

385 {
386  wxLogTrace( traceSettings,
387  "MigrateFromLegacy() not implemented for %s", typeid( *this ).name() );
388  return false;
389 }
const char * traceSettings
Flag to enable settings tracing.

References traceSettings.

Referenced by JSON_SETTINGS::LoadFromFile().

◆ operator!=()

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

Definition at line 109 of file erc_settings.h.

110  {
111  return !( other == *this );
112  }

◆ operator==()

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

Definition at line 104 of file erc_settings.h.

105  {
106  return ( other.m_Severities == m_Severities );
107  }
std::map< int, int > m_Severities
Definition: erc_settings.h:157

References m_Severities.

◆ PointerFromString()

nlohmann::json::json_pointer JSON_SETTINGS::PointerFromString ( std::string  aPath)
staticinherited

Builds a JSON pointer based on a given string.

Parameters
aPathis the path in the form "key1.key2.key3"
Returns
a JSON pointer that can be used to index into a JSON object

Definition at line 392 of file json_settings.cpp.

393 {
394  std::replace( aPath.begin(), aPath.end(), '.', '/' );
395  aPath.insert( 0, "/" );
396 
397  nlohmann::json::json_pointer p;
398 
399  try
400  {
401  p = nlohmann::json::json_pointer( aPath );
402  }
403  catch( ... )
404  {
405  wxASSERT_MSG( false, wxT( "Invalid pointer path in PointerFromString!" ) );
406  }
407 
408  return p;
409 }

Referenced by JSON_SETTINGS::fromLegacy(), JSON_SETTINGS::fromLegacyColor(), JSON_SETTINGS::fromLegacyString(), JSON_SETTINGS::GetJson(), JSON_SETTINGS::JSON_SETTINGS(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), FOOTPRINT_EDITOR_SETTINGS::Migrate(), COLOR_SETTINGS::Migrate(), COMMON_SETTINGS::Migrate(), APP_SETTINGS_BASE::migrateFindReplace(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), PROJECT_FILE::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), SETTINGS_MANAGER::SaveColorSettings(), NESTED_SETTINGS::SaveToFile(), PROJECT_LOCAL_SETTINGS::SaveToFile(), PROJECT_FILE::SaveToFile(), and JSON_SETTINGS::Set().

◆ ReleaseNestedSettings()

void JSON_SETTINGS::ReleaseNestedSettings ( NESTED_SETTINGS aSettings)
inherited

Saves and frees a nested settings object, if it exists within this one.

Parameters
aSettingsis a pointer to a NESTED_SETTINGS that has already been added to this one

Definition at line 508 of file json_settings.cpp.

509 {
510  if( !aSettings )
511  return;
512 
513  auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
514  [&aSettings]( const JSON_SETTINGS* aPtr ) {
515  return aPtr == aSettings;
516  } );
517 
518  if( it != m_nested_settings.end() )
519  {
520  wxLogTrace( traceSettings, "Flush and release %s", ( *it )->GetFilename() );
521  ( *it )->SaveToFile();
522  m_nested_settings.erase( it );
523  }
524 
525  aSettings->SetParent( nullptr );
526 }
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
const char * traceSettings
Flag to enable settings tracing.
void SetParent(JSON_SETTINGS *aParent)

References JSON_SETTINGS::m_nested_settings, NESTED_SETTINGS::SetParent(), and traceSettings.

Referenced by BOARD::ClearProject(), BOARD_DESIGN_SETTINGS::~BOARD_DESIGN_SETTINGS(), ~ERC_SETTINGS(), NESTED_SETTINGS::~NESTED_SETTINGS(), NET_SETTINGS::~NET_SETTINGS(), and SCHEMATIC_SETTINGS::~SCHEMATIC_SETTINGS().

◆ ResetPinMap()

void ERC_SETTINGS::ResetPinMap ( )

Definition at line 228 of file erc_settings.cpp.

229 {
230  memcpy( m_PinMap, m_defaultPinMap, sizeof( m_PinMap ) );
231 }
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:165
PIN_ERROR m_PinMap[ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]
Definition: erc_settings.h:159

References m_defaultPinMap, and m_PinMap.

Referenced by ERC_SETTINGS(), and PANEL_SETUP_PINMAP::OnResetMatrixClick().

◆ ResetToDefaults()

void JSON_SETTINGS::ResetToDefaults ( )
inherited

Resets all parameters to default values.

Does NOT write to file or update underlying JSON.

Definition at line 273 of file json_settings.cpp.

274 {
275  for( auto param : m_params )
276  param->SetDefault();
277 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

Referenced by EDA_3D_VIEWER::Process_Special_Functions().

◆ SaveToFile()

bool NESTED_SETTINGS::SaveToFile ( const std::string &  aDirectory = "",
bool  aForce = false 
)
overridevirtualinherited

Calls Store() and then saves the JSON document contents into the parent JSON_SETTINGS.

Parameters
aDirectoryis ignored
Returns
true if the document contents were updated

Reimplemented from JSON_SETTINGS.

Definition at line 78 of file nested_settings.cpp.

79 {
80  if( !m_parent )
81  return false;
82 
83  bool modified = Store();
84 
85  try
86  {
87  nlohmann::json patch =
88  nlohmann::json::diff( *this, ( *m_parent )[PointerFromString( m_path )] );
89  modified |= !patch.empty();
90  }
91  catch( ... )
92  {
93  modified = true;
94  }
95 
96  if( !modified && !aForce )
97  return false;
98 
99  try
100  {
101  ( *m_parent )[PointerFromString( m_path ) ].update( *this );
102 
103  wxLogTrace( traceSettings, "Stored NESTED_SETTINGS %s with schema %d",
105  }
106  catch( ... )
107  {
108  wxLogTrace( traceSettings, "NESTED_SETTINGS %s: Could not store to %s at %s",
110  }
111 
112  return modified;
113 }
virtual bool Store()
Stores the current parameters into the JSON document represented by this object Note: this doesn't do...
std::string m_filename
The filename (not including path) of this settings file.
nlohmann::json json
Definition: gerbview.cpp:40
JSON_SETTINGS * m_parent
A pointer to the parent object to load and store from.
std::string m_path
The path (in pointer format) of where to store this document in the parent.
std::string GetFilename() const
Definition: json_settings.h:56
const char * traceSettings
Flag to enable settings tracing.
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
int m_schemaVersion
Version of this settings schema.

References JSON_SETTINGS::GetFilename(), JSON_SETTINGS::m_filename, NESTED_SETTINGS::m_parent, NESTED_SETTINGS::m_path, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS::PointerFromString(), JSON_SETTINGS::Store(), and traceSettings.

◆ Set() [1/3]

template<typename ValueType >
void JSON_SETTINGS::Set ( const std::string &  aPath,
ValueType  aVal 
)
inlineinherited

Stores a value into the JSON document Will throw an exception if ValueType isn't something that the library can handle.

Template Parameters
ValueTypeis the type to store
Parameters
aPathis a path to store in the form "key1.key2.key3"
aValis the value to store

Definition at line 135 of file json_settings.h.

136  {
137  ( *this )[PointerFromString( aPath ) ] = aVal;
138  }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

Referenced by COLOR_MAP_PARAM::Store(), PARAM< wxString >::Store(), PARAM_PATH::Store(), PARAM_LAMBDA< ValueType >::Store(), PARAM_SCALED< ValueType >::Store(), PARAM_LIST< wxString >::Store(), PARAM_PATH_LIST::Store(), PARAM_MAP< Value >::Store(), and PARAM_WXSTRING_MAP::Store().

◆ Set() [2/3]

template<>
void JSON_SETTINGS::Set ( const std::string &  aPath,
wxString  aVal 
)
inherited

◆ Set() [3/3]

template<>
void JSON_SETTINGS::Set ( const std::string &  aPath,
wxString  aVal 
)
inherited

Definition at line 540 of file json_settings.cpp.

541 {
542  ( *this )[PointerFromString( std::move( aPath ) ) ] = aVal.ToUTF8();
543 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

◆ SetLegacyFilename()

void JSON_SETTINGS::SetLegacyFilename ( const std::string &  aFilename)
inlineinherited

Definition at line 62 of file json_settings.h.

62 { m_legacy_filename = aFilename; }
std::string m_legacy_filename
The filename of the wxConfig legacy file (if different from m_filename)

References JSON_SETTINGS::m_legacy_filename.

Referenced by LIBEDIT_SETTINGS::LIBEDIT_SETTINGS().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER aManager)
inlineinherited

Definition at line 175 of file json_settings.h.

176  {
177  m_manager = aManager;
178  }
SETTINGS_MANAGER * m_manager
A pointer to the settings manager managing this file (may be null)

References JSON_SETTINGS::m_manager.

◆ SetParent()

void NESTED_SETTINGS::SetParent ( JSON_SETTINGS aParent)
inherited

Definition at line 116 of file nested_settings.cpp.

117 {
118  m_parent = aParent;
119 
120  if( m_parent )
121  {
122  m_parent->AddNestedSettings( this );
123 
124  // In case we were created after the parent's ctor
125  LoadFromFile();
126  }
127 }
void AddNestedSettings(NESTED_SETTINGS *aSettings)
Transfers ownership of a given NESTED_SETTINGS to this object.
bool LoadFromFile(const std::string &aDirectory="") override
Loads the JSON document from the parent and then calls Load()
JSON_SETTINGS * m_parent
A pointer to the parent object to load and store from.

References JSON_SETTINGS::AddNestedSettings(), NESTED_SETTINGS::LoadFromFile(), and NESTED_SETTINGS::m_parent.

Referenced by BOARD::ClearProject(), NESTED_SETTINGS::NESTED_SETTINGS(), JSON_SETTINGS::ReleaseNestedSettings(), and BOARD::SetProject().

◆ SetPinMapValue() [1/2]

void ERC_SETTINGS::SetPinMapValue ( int  aFirstType,
int  aSecondType,
PIN_ERROR  aValue 
)
inline

Definition at line 137 of file erc_settings.h.

138  {
139  wxASSERT( aFirstType < ELECTRICAL_PINTYPES_TOTAL
140  && aSecondType < ELECTRICAL_PINTYPES_TOTAL );
141  m_PinMap[aFirstType][aSecondType] = aValue;
142  }
PIN_ERROR m_PinMap[ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]
Definition: erc_settings.h:159
#define ELECTRICAL_PINTYPES_TOTAL
Definition: pin_type.h:54

References ELECTRICAL_PINTYPES_TOTAL, and m_PinMap.

Referenced by PANEL_SETUP_PINMAP::changeErrorLevel(), and ERC_SETTINGS().

◆ SetPinMapValue() [2/2]

void ERC_SETTINGS::SetPinMapValue ( ELECTRICAL_PINTYPE  aFirstType,
ELECTRICAL_PINTYPE  aSecondType,
PIN_ERROR  aValue 
)
inline

Definition at line 144 of file erc_settings.h.

146  {
147  m_PinMap[static_cast<int>( aFirstType )][static_cast<int>( aSecondType )] = aValue;
148  }
PIN_ERROR m_PinMap[ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]
Definition: erc_settings.h:159

References m_PinMap.

◆ SetSeverity()

void ERC_SETTINGS::SetSeverity ( int  aErrorCode,
int  aSeverity 
)

Definition at line 222 of file erc_settings.cpp.

223 {
224  m_Severities[ aErrorCode ] = aSeverity;
225 }
std::map< int, int > m_Severities
Definition: erc_settings.h:157

References m_Severities.

Referenced by DIALOG_ERC::OnERCItemRClick().

◆ Store()

bool JSON_SETTINGS::Store ( )
virtualinherited

Stores the current parameters into the JSON document represented by this object Note: this doesn't do any writing to disk; that's handled by SETTINGS_MANAGER.

Returns
true if any part of the JSON document was updated

Definition at line 259 of file json_settings.cpp.

260 {
261  bool modified = false;
262 
263  for( auto param : m_params )
264  {
265  modified |= !param->MatchesFile( this );
266  param->Store( this );
267  }
268 
269  return modified;
270 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

Referenced by PANEL_MODEDIT_COLOR_SETTINGS::PANEL_MODEDIT_COLOR_SETTINGS(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), SETTINGS_MANAGER::SaveColorSettings(), NESTED_SETTINGS::SaveToFile(), and JSON_SETTINGS::SaveToFile().

Member Data Documentation

◆ m_createIfDefault

bool JSON_SETTINGS::m_createIfDefault
protectedinherited

Whether or not the backing store file should be created if all parameters are still at their default values.

Ignored if m_createIfMissing is false or m_writeFile is false.

Definition at line 249 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_createIfMissing

bool JSON_SETTINGS::m_createIfMissing
protectedinherited

Whether or not the backing store file should be created it if doesn't exist.

Definition at line 243 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_defaultPinMap

PIN_ERROR ERC_SETTINGS::m_defaultPinMap
staticprivate
Initial value:
=
{
{ OK, OK, OK, OK, OK, WAR, OK, OK, OK, OK, ERR },
{ OK, ERR, OK, WAR, OK, WAR, OK, ERR, ERR, ERR, ERR },
{ OK, OK, OK, OK, OK, WAR, OK, WAR, OK, WAR, ERR },
{ OK, WAR, OK, OK, OK, WAR, WAR, ERR, WAR, WAR, ERR },
{ OK, OK, OK, OK, OK, WAR, OK, OK, OK, OK, ERR },
{ WAR, WAR, WAR, WAR, WAR, WAR, WAR, WAR, WAR, WAR, ERR },
{ OK, OK, OK, WAR, OK, WAR, OK, OK, OK, OK, ERR },
{ OK, ERR, WAR, ERR, OK, WAR, OK, ERR, ERR, ERR, ERR },
{ OK, ERR, OK, WAR, OK, WAR, OK, ERR, OK, OK, ERR },
{ OK, ERR, WAR, WAR, OK, WAR, OK, ERR, OK, OK, ERR },
{ ERR, ERR, ERR, ERR, ERR, ERR, ERR, ERR, ERR, ERR, ERR }
}

Default Look up table which gives the ERC error level for a pair of connected pins.

Definition at line 165 of file erc_settings.h.

Referenced by ResetPinMap().

◆ m_deleteLegacyAfterMigration

bool JSON_SETTINGS::m_deleteLegacyAfterMigration
protectedinherited

Whether or not to delete legacy file after migration.

Definition at line 255 of file json_settings.h.

Referenced by JSON_SETTINGS::LoadFromFile(), and PROJECT_FILE::PROJECT_FILE().

◆ m_filename

std::string JSON_SETTINGS::m_filename
protectedinherited

◆ m_legacy_filename

std::string JSON_SETTINGS::m_legacy_filename
protectedinherited

The filename of the wxConfig legacy file (if different from m_filename)

Definition at line 231 of file json_settings.h.

Referenced by JSON_SETTINGS::LoadFromFile(), and JSON_SETTINGS::SetLegacyFilename().

◆ m_location

SETTINGS_LOC JSON_SETTINGS::m_location
protectedinherited

The location of this settings file (.

See also
SETTINGS_LOC)

Definition at line 234 of file json_settings.h.

Referenced by JSON_SETTINGS::GetLocation().

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager
protectedinherited

A pointer to the settings manager managing this file (may be null)

Definition at line 264 of file json_settings.h.

Referenced by FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), and JSON_SETTINGS::SetManager().

◆ m_nested_settings

std::vector<NESTED_SETTINGS*> JSON_SETTINGS::m_nested_settings
protectedinherited

Nested settings files that live inside this one, if any.

Definition at line 240 of file json_settings.h.

Referenced by JSON_SETTINGS::AddNestedSettings(), JSON_SETTINGS::LoadFromFile(), JSON_SETTINGS::ReleaseNestedSettings(), and JSON_SETTINGS::SaveToFile().

◆ m_params

◆ m_parent

◆ m_path

std::string NESTED_SETTINGS::m_path
protectedinherited

The path (in pointer format) of where to store this document in the parent.

Definition at line 65 of file nested_settings.h.

Referenced by NESTED_SETTINGS::LoadFromFile(), and NESTED_SETTINGS::SaveToFile().

◆ m_PinMap

◆ m_PinMinDrive

int ERC_SETTINGS::m_PinMinDrive
static
Initial value:
=
{
{ NOD, DRV, DRV, DRV, DRV, DRV, NOD, DRV, DRV, DRV, NPI },
{ DRV, DRV, DRV, DRV, DRV, DRV, DRV, DRV, DRV, DRV, NPI },
{ DRV, DRV, DRV, DRV, DRV, DRV, NOD, DRV, DRV, DRV, NPI },
{ DRV, DRV, DRV, DRV, DRV, DRV, NOD, DRV, DRV, DRV, NPI },
{ DRV, DRV, DRV, DRV, DRV, DRV, NOD, DRV, DRV, DRV, NPI },
{ DRV, DRV, DRV, DRV, DRV, DRV, NOD, DRV, DRV, DRV, NPI },
{ NOD, DRV, NOD, NOD, NOD, NOD, NOD, DRV, NOD, NOD, NPI },
{ DRV, DRV, DRV, DRV, DRV, DRV, DRV, DRV, DRV, DRV, NPI },
{ DRV, DRV, DRV, DRV, DRV, DRV, NOD, DRV, DRV, DRV, NPI },
{ DRV, DRV, DRV, DRV, DRV, DRV, NOD, DRV, DRV, DRV, NPI },
{ NPI, NPI, NPI, NPI, NPI, NPI, NPI, NPI, NPI, NPI, NPI }
}

Look up table which gives the minimal drive for a pair of connected pins on a net.

The initial state of a net is NOC (Net with No Connection). It can be updated to NPI (Pin Isolated), NET_NC (Net with a no connect symbol), NOD (Not Driven) or DRV (DRIven). It can be updated to NET_NC with no error only if there is only one pin in net. Nets are OK when their final state is NET_NC or DRV. Nets with the state NOD have no valid source signal.

Definition at line 161 of file erc_settings.h.

Referenced by GetPinMinDrive().

◆ m_preserved_paths

std::vector<nlohmann::json::json_pointer> JSON_SETTINGS::m_preserved_paths
protectedinherited

A list of JSON pointers that are preserved during a read-update-write to disk.

Definition at line 267 of file json_settings.h.

◆ m_resetParamsIfMissing

bool JSON_SETTINGS::m_resetParamsIfMissing
protectedinherited

Whether or not to set parameters to their default value if missing from JSON on Load()

Definition at line 258 of file json_settings.h.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), and JSON_SETTINGS::Load().

◆ m_schemaVersion

int JSON_SETTINGS::m_schemaVersion
protectedinherited

◆ m_Severities

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile
protectedinherited

Whether or not the backing store file should be written.

Definition at line 252 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().


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