Container for ERC settings. More...

#include <erc_settings.h>

Inheritance diagram for ERC_SETTINGS:

Public Member Functions
	ERC_SETTINGS (JSON_SETTINGS *aParent, const std::string &aPath)

virtual	~ERC_SETTINGS ()

bool	operator== (const ERC_SETTINGS &other) const

bool	operator!= (const ERC_SETTINGS &other) const

bool	IsTestEnabled (int aErrorCode) const

SEVERITY	GetSeverity (int aErrorCode) const

void	SetSeverity (int aErrorCode, SEVERITY aSeverity)

void	ResetPinMap ()

int	GetPinTypeWeight (ELECTRICAL_PINTYPE aPinType) const
	Get the weight for an electrical pin type.

ERC_PIN_SORTING_METRIC	GetERCSortingMetric () const
	Get the type of sorting metric the ERC checker should use to resolve multi-pin errors.

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 wxString &aDirectory="") override
	Loads the JSON document from the parent and then calls Load()

bool	SaveToFile (const wxString &aDirectory="", bool aForce=false) override
	Calls Store() and then saves the JSON document contents into the parent JSON_SETTINGS.

void	SetParent (JSON_SETTINGS *aParent, bool aLoadFromFile=true)

JSON_SETTINGS *	GetParent ()

wxString	GetFilename () const

wxString	GetFullFilename () const

void	SetFilename (const wxString &aFilename)

void	SetLocation (SETTINGS_LOC aLocation)

SETTINGS_LOC	GetLocation () const

virtual const PROJECT *	GetOwningProject () const
	Project-located settings override this to report the project they belong to so their save path is resolved against that project rather than the active one.

void	SetLegacyFilename (const wxString &aFilename)

bool	IsReadOnly () const

void	SetReadOnly (bool aReadOnly)

bool	ResetsParamsIfMissing () const

nlohmann::json &	At (const std::string &aPath)
	Wrappers for the underlying JSON API so that most consumers don't need json.hpp All of these functions take a string that is passed to PointerFromString internally.

bool	Contains (const std::string &aPath) const

JSON_SETTINGS_INTERNALS *	Internals ()

virtual void	Load ()
	Updates the parameters of this object based on the current JSON document contents.

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.

bool	IsFileSynced () const

void	ResetToDefaults ()
	Resets all parameters to default values.

std::optional< 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.key2.key3" to refer to nested objects.

template<typename ValueType>
std::optional< ValueType >	Get (const std::string &aPath) const
	Fetches a value from within the JSON document.

template<>
std::optional< wxString >	Get (const std::string &aPath) const

template<>
KICOMMON_API std::optional< 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.

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

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

virtual std::map< std::string, nlohmann::json >	GetFileHistories ()

bool	Migrate ()
	Migrates the schema of this settings from the version in the file to the latest version.

virtual bool	MigrateFromLegacy (wxConfigBase *aLegacyConfig)
	Migrates from wxConfig to JSON-based configuration.

void	AddNestedSettings (NESTED_SETTINGS *aSettings)
	Transfers ownership of a given NESTED_SETTINGS to this object.

void	ReleaseNestedSettings (NESTED_SETTINGS *aSettings)
	Saves and frees a nested settings object, if it exists within this one.

void	SetManager (SETTINGS_MANAGER *aManager)

const std::string	FormatAsString ()

bool	LoadFromRawFile (const wxString &aPath)

Static Public Member Functions
static bool	SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, wxString &aTarget)
	Sets the given string if the given key/path is present.

static bool	SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, bool &aTarget)
	Sets the given bool if the given key/path is present.

static bool	SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, int &aTarget)
	Sets the given int if the given key/path is present.

static bool	SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, unsigned int &aTarget)
	Sets the given unsigned int if the given key/path is present.

Public Attributes
std::map< int, SEVERITY >	m_ERCSeverities

std::set< ERC_EXCLUSION, ERC_EXCLUSION_COMPARE >	m_ErcExclusions

std::set< std::pair< wxString, wxString > >	m_ErcExclusionsLegacy

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.

Protected Member Functions
void	registerMigration (int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
	Registers a migration from one schema version to another.

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.

bool	fromLegacyString (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
	Translates a legacy wxConfig string value to a given JSON pointer value.

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.

bool	flushToStore ()
	Flushes nested settings and parameters into the JSON store.

std::string	formatFileContents ()
	Overlays the current store on the original file contents.

virtual wxString	getFileExt () const

virtual wxString	getLegacyFileExt () const

Static Protected Member Functions
template<typename ResultType>
static ResultType	fetchOrDefault (const nlohmann::json &aJson, const std::string &aKey, ResultType aDefault=ResultType())
	Helper to retrieve a value from a JSON object (dictionary) as a certain result type.

Protected Attributes
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.

wxString	m_filename
	The filename (not including path) of this settings file (inicode)

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

SETTINGS_LOC	m_location
	The location of this settings file (.

std::vector< PARAM_BASE * >	m_params
	The list of parameters (owned by this object)

std::vector< NESTED_SETTINGS * >	m_nested_settings
	Nested settings files that live inside this one, if any.

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

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

bool	m_writeFile
	Whether or not the backing store file should be written.

bool	m_modified
	True if the JSON data store has been written to since the last file write.

bool	m_fileSynced
	True once the store has been synchronized with an on-disk file (loaded or saved)

bool	m_deleteLegacyAfterMigration
	Whether or not to delete legacy file after migration.

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

int	m_schemaVersion
	Version of this settings schema.

bool	m_isFutureFormat
	Set to true if this settings is loaded from a file with a newer schema version than is known.

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

std::map< int, std::pair< int, std::function< bool()> > >	m_migrators
	A map of starting schema version to a pair of <ending version, migrator function>

std::unique_ptr< JSON_SETTINGS_INTERNALS >	m_internals

Private Member Functions
bool	migrateSchema0to1 ()

Private Attributes
std::map< ELECTRICAL_PINTYPE, int >	m_PinTypeWeights
	Weights for electrical pins used in ERC to decide which pin gets the marker in case of a multi-pin erc pin-to-pin error.

ERC_PIN_SORTING_METRIC	m_ERCSortingMetric
	The type of sorting used by the ERC checker to resolve multi-pin errors.

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.

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

Constructor & Destructor Documentation

◆ ERC_SETTINGS()

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

Definition at line 89 of file erc_settings.cpp.

References ELECTRICAL_PINTYPES_TOTAL, ERCE_BUS_ENTRY_CONFLICT, ERCE_DRIVER_CONFLICT, ERCE_EMPTY_LABEL_NAME, ERCE_ENDPOINT_OFF_GRID, ERCE_FIELD_NAME_WHITESPACE, ERCE_FIRST, ERCE_FOOTPRINT_FILTERS, ERCE_FOOTPRINT_LINK_ISSUES, ERCE_FOUR_WAY_JUNCTION, ERCE_GROUND_PIN_NOT_GROUND, ERCE_LABEL_MULTIPLE_WIRES, ERCE_LABEL_SINGLE_PIN, ERCE_LAST, ERCE_LIB_SYMBOL_ISSUES, ERCE_LIB_SYMBOL_MISMATCH, ERCE_MISSING_BIDI_PIN, ERCE_MISSING_INPUT_PIN, ERCE_MISSING_UNIT, ERCE_NOCONNECT_CONNECTED, ERCE_NOCONNECT_NOT_CONNECTED, ERCE_PIN_MAP_STALE_PIN, ERCE_PIN_MAP_UNMAPPED_PIN, ERCE_PIN_TO_PIN_ERROR, ERCE_PIN_TO_PIN_WARNING, ERCE_SAME_LOCAL_GLOBAL_LABEL, ERCE_SAME_LOCAL_GLOBAL_POWER, ERCE_SIMILAR_LABEL_AND_POWER, ERCE_SIMILAR_LABELS, ERCE_SIMILAR_POWER, ERCE_SIMULATION_MODEL, ERCE_SINGLE_GLOBAL_LABEL, ERCE_STACKED_PIN_SYNTAX, ERCE_UNCONNECTED_WIRE_ENDPOINT, ERCE_UNSPECIFIED, ERCE_VARIANT_SYMBOL_INCOMPATIBLE, ERCE_VARIANT_SYMBOL_INVALID, ERCE_WIRED_IMPLICIT_POWER, ercSettingsSchemaVersion, ERC_ITEM::GetItemsWithSeverities(), GetPinMapValue(), ERC_EXCLUSION::GetSortKey(), JSON_SETTINGS::JSON_SETTINGS(), m_ErcExclusions, m_ERCSeverities, m_ERCSortingMetric, JSON_SETTINGS::m_params, m_PinTypeWeights, migrateSchema0to1(), name, NESTED_SETTINGS::NESTED_SETTINGS(), PT_BIDI, PT_INPUT, PT_NC, PT_NIC, PT_OPENCOLLECTOR, PT_OPENEMITTER, PT_OUTPUT, PT_PASSIVE, PT_POWER_IN, PT_POWER_OUT, PT_TRISTATE, PT_UNSPECIFIED, JSON_SETTINGS::registerMigration(), ResetPinMap(), RPT_SEVERITY_ERROR, RPT_SEVERITY_IGNORE, RPT_SEVERITY_UNDEFINED, RPT_SEVERITY_WARNING, SetPinMapValue(), SeverityFromString(), SeverityToString(), SM_HEURISTICS, and UNCONNECTED.

Referenced by operator!=(), and operator==().

◆ ~ERC_SETTINGS()

ERC_SETTINGS::~ERC_SETTINGS ( )

virtual

Definition at line 301 of file erc_settings.cpp.

References NESTED_SETTINGS::m_parent.

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

aSettings is the settings object to take ownership of

Definition at line 934 of file json_settings.cpp.

References GetFilename(), m_nested_settings, NESTED_SETTINGS, and traceSettings.

◆ At()

nlohmann::json & JSON_SETTINGS::At ( const std::string & aPath )

inherited

Wrappers for the underlying JSON API so that most consumers don't need json.hpp All of these functions take a string that is passed to PointerFromString internally.

Definition at line 126 of file json_settings.cpp.

References m_internals.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::migrateBomSettings(), EESCHEMA_SETTINGS::migrateFieldNameTemplates(), GERBVIEW_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::migrateLibTreeWidth(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), and PCBNEW_SETTINGS::PCBNEW_SETTINGS().

◆ Contains()

bool JSON_SETTINGS::Contains ( const std::string & aPath ) const

inherited

Definition at line 132 of file json_settings.cpp.

References m_internals, and JSON_SETTINGS_INTERNALS::PointerFromString().

Referenced by EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), GERBVIEW_SETTINGS::GetFileHistories(), GetFileHistories(), BOARD_DESIGN_SETTINGS::LoadFromFile(), EESCHEMA_SETTINGS::migrateBomSettings(), EESCHEMA_SETTINGS::migrateFieldNameTemplates(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COMMON_SETTINGS::migrateSchema5to6(), COMMON_SETTINGS::migrateSchema6to7(), and SETTINGS_MANAGER::SaveColorSettings().

◆ fetchOrDefault()

template<typename ResultType>

template KICOMMON_API bool JSON_SETTINGS::fetchOrDefault	(	const nlohmann::json &	aJson,
		const std::string &	aKey,
		ResultType	aDefault = ResultType() )

staticprotectedinherited

Helper to retrieve a value from a JSON object (dictionary) as a certain result type.

Template Parameters

ResultType is the type of the retrieved value.

Parameters

aJson	is the object to act on .
aKey	is the object key to retrieve the value for.
aDefault	is the default result type.

Returns: the result, or aDefault if aKey is not found.

Definition at line 987 of file json_settings.cpp.

◆ flushToStore()

bool JSON_SETTINGS::flushToStore ( )

protectedinherited

Flushes nested settings and parameters into the JSON store.

Returns: true if the store holds changes not yet written to the file

Definition at line 543 of file json_settings.cpp.

References m_nested_settings, NESTED_SETTINGS, and Store().

Referenced by SaveToFile(), and PROJECT_FILE::SerializeToString().

◆ FormatAsString()

const std::string JSON_SETTINGS::FormatAsString ( )

inherited

Definition at line 582 of file json_settings.cpp.

References dummy, m_internals, and Store().

◆ formatFileContents()

std::string JSON_SETTINGS::formatFileContents ( )

protectedinherited

Overlays the current store on the original file contents.

May throw a JSON exception.

Returns: the serialized bytes in the on-disk format

Definition at line 560 of file json_settings.cpp.

References dummy, m_internals, m_params, and JSON_SETTINGS_INTERNALS::PointerFromString().

Referenced by SaveToFile(), and PROJECT_FILE::SerializeToString().

◆ fromLegacy()

template<typename ValueType>

template KICOMMON_API 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

ValueType is the basic type of the value

Parameters

aConfig	is the legacy config to read from
aKey	is the key (within the current path) to read
aDest	is a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 849 of file json_settings.cpp.

◆ 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

aConfig	is the legacy config to read from
aKey	is the key (within the current path) to read
aDest	is a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 907 of file json_settings.cpp.

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::COLOR4D::g, KIGFX::COLOR4D::r, and KIGFX::COLOR4D::SetFromWxString().

◆ 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

aConfig	is the legacy config to read from
aKey	is the key (within the current path) to read
aDest	is a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 884 of file json_settings.cpp.

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

◆ Get() [1/3]

template<>

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

inherited

Definition at line 970 of file json_settings.cpp.

References GetJson().

◆ Get() [2/3]

template<typename ValueType>

template KICOMMON_API std::optional< wxAuiPaneInfo > JSON_SETTINGS::Get< wxAuiPaneInfo > ( const std::string & aPath ) const

inherited

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

ValueType is the type to cast to

Parameters

aPath is the path within the document to retrieve

Returns: a value from within this document

Definition at line 646 of file json_settings.cpp.

References GetJson().

Referenced by BITMAP2CMP_SETTINGS::BITMAP2CMP_SETTINGS(), BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), JSON_SETTINGS::Get< KIGFX::COLOR4D >(), JSON_SETTINGS::Get< KIGFX::CROSS_HAIR_MODE >(), JSON_SETTINGS::Get< nlohmann::json >(), JSON_SETTINGS::Get< std::string >(), COLOR_MAP_PARAM::Load(), PARAM< ValueType >::Load(), PARAM_ENUM< EnumType >::Load(), PARAM_LAMBDA< ValueType >::Load(), PARAM_SCALED< ValueType >::Load(), COLOR_MAP_PARAM::MatchesFile(), PARAM< ValueType >::MatchesFile(), PARAM_ENUM< EnumType >::MatchesFile(), PARAM_LAMBDA< ValueType >::MatchesFile(), PARAM_PATH::MatchesFile(), PARAM_SCALED< ValueType >::MatchesFile(), EESCHEMA_SETTINGS::migrateBomSettings(), EESCHEMA_SETTINGS::migrateFieldNameTemplates(), COMMON_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::migrateLibTreeWidth(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_FILE::SaveAs(), and SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS().

◆ Get() [3/3]

template<>

template std::optional< wxAuiPaneInfo > JSON_SETTINGS::Get< wxAuiPaneInfo > ( const std::string & aPath ) const

inherited

References KICOMMON_API.

◆ GetERCSortingMetric()

ERC_PIN_SORTING_METRIC ERC_SETTINGS::GetERCSortingMetric ( ) const

inline

Get the type of sorting metric the ERC checker should use to resolve multi-pin errors.

Definition at line 190 of file erc_settings.h.

References m_ERCSortingMetric.

◆ getFileExt()

virtual wxString JSON_SETTINGS::getFileExt ( ) const

inlineprotectedvirtualinherited

Reimplemented in DATABASE_LIB_SETTINGS, HTTP_LIB_SETTINGS, JOBSET, PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 326 of file json_settings.h.

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

◆ GetFileHistories()

std::map< std::string, nlohmann::json > JSON_SETTINGS::GetFileHistories ( )

virtualinherited

Reimplemented in GERBVIEW_SETTINGS.

Definition at line 406 of file json_settings.cpp.

References Contains(), and GetJson().

Referenced by GERBVIEW_SETTINGS::GetFileHistories().

◆ GetFilename()

wxString JSON_SETTINGS::GetFilename ( ) const

inlineinherited

Definition at line 88 of file json_settings.h.

References m_filename.

Referenced by AddNestedSettings(), SETTINGS_MANAGER::loadAllColorSettings(), SETTINGS_MANAGER::loadColorSettingsByName(), NESTED_SETTINGS::LoadFromFile(), EESCHEMA_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), COLOR_SETTINGS::migrateSchema0to1(), PANEL_COLOR_SETTINGS::OnThemeChanged(), PANEL_EESCHEMA_COLOR_SETTINGS::PANEL_EESCHEMA_COLOR_SETTINGS(), PANEL_GERBVIEW_COLOR_SETTINGS::PANEL_GERBVIEW_COLOR_SETTINGS(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), PCB_PLOTTER::PlotJobToPlotOpts(), DIALOG_PLOT_SCHEMATIC::plotSchematic(), PROJECT_FILE::SaveAs(), SETTINGS_MANAGER::SaveColorSettings(), DIALOG_PRINT::SavePrintOptions(), DIALOG_PRINT_PCBNEW::saveSettings(), NESTED_SETTINGS::SaveToFile(), PANEL_PL_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), and PANEL_SYM_COLOR_SETTINGS::TransferDataFromWindow().

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const

inherited

Definition at line 117 of file json_settings.cpp.

References getFileExt(), and m_filename.

Referenced by JSON_SETTINGS(), LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), SaveToFile(), and PROJECT_FILE::SerializeToString().

◆ GetJson()

std::optional< 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

aPath is a string containing one or more keys separated by '.'

Returns: a JSON object from within this one

Definition at line 626 of file json_settings.cpp.

References m_internals.

Referenced by BOOST_AUTO_TEST_CASE(), Get(), GERBVIEW_SETTINGS::GetFileHistories(), GetFileHistories(), PARAM_LAMBDA< ValueType >::Load(), PARAM_LIST< Type >::Load(), PARAM_MAP< Value >::Load(), PARAM_SET< Type >::Load(), PARAM_WXSTRING_MAP::Load(), PARAM_LAMBDA< ValueType >::MatchesFile(), PARAM_LIST< Type >::MatchesFile(), PARAM_MAP< Value >::MatchesFile(), PARAM_PATH_LIST::MatchesFile(), PARAM_SET< Type >::MatchesFile(), PARAM_WXSTRING_MAP::MatchesFile(), PROJECT_FILE::migrateSchema3To4(), SETTINGS_MANAGER::SaveColorSettings(), and PROJECT_FILE::Store().

◆ getLegacyFileExt()

virtual wxString JSON_SETTINGS::getLegacyFileExt ( ) const

inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 331 of file json_settings.h.

Referenced by LoadFromFile().

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const

inlineinherited

Definition at line 95 of file json_settings.h.

References m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile(), and COLOR_SETTINGS::migrateSchema0to1().

◆ GetOwningProject()

virtual const PROJECT * JSON_SETTINGS::GetOwningProject ( ) const

inlinevirtualinherited

Project-located settings override this to report the project they belong to so their save path is resolved against that project rather than the active one.

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 101 of file json_settings.h.

References PROJECT.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ GetParent()

JSON_SETTINGS * NESTED_SETTINGS::GetParent ( )

inlineinherited

Definition at line 55 of file nested_settings.h.

References JSON_SETTINGS::JSON_SETTINGS(), and m_parent.

Referenced by BOARD_DESIGN_SETTINGS::LoadFromFile().

◆ GetPinMapValue() [1/2]

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

inline

Definition at line 199 of file erc_settings.h.

References m_PinMap.

◆ GetPinMapValue() [2/2]

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

inline

Definition at line 192 of file erc_settings.h.

References ELECTRICAL_PINTYPES_TOTAL, and m_PinMap.

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

◆ GetPinMinDrive()

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

inline

Definition at line 217 of file erc_settings.h.

References m_PinMinDrive.

◆ GetPinTypeWeight()

int ERC_SETTINGS::GetPinTypeWeight ( ELECTRICAL_PINTYPE aPinType ) const

inline

Get the weight for an electrical pin type.

Used for sorting of pins in pin-to-pin erc resolution.

Parameters

aPinType the pin type to check

Returns: the weight for sorting

Definition at line 180 of file erc_settings.h.

References ELECTRICAL_PINTYPES_TOTAL, and m_PinTypeWeights.

◆ GetSeverity()

SEVERITY ERC_SETTINGS::GetSeverity ( int aErrorCode ) const

◆ Internals()

JSON_SETTINGS_INTERNALS * JSON_SETTINGS::Internals ( )

inherited

Definition at line 138 of file json_settings.cpp.

References m_internals.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), NET_SETTINGS::CopyFrom(), COLOR_SETTINGS::migrateSchema0to1(), PCBNEW_JOBS_HANDLER::runPcbMerge(), EESCHEMA_JOBS_HANDLER::runSchMerge(), and SETTINGS_MANAGER::SaveColorSettings().

◆ IsFileSynced()

bool JSON_SETTINGS::IsFileSynced ( ) const

inlineinherited

Returns: true once the in-memory store has been synchronized with an on-disk file, either by loading an existing file or by a successful save

Definition at line 157 of file json_settings.h.

References m_fileSynced.

Referenced by reloadFromFile().

◆ IsReadOnly()

bool JSON_SETTINGS::IsReadOnly ( ) const

inlineinherited

Definition at line 105 of file json_settings.h.

References m_writeFile.

Referenced by PANEL_COLOR_SETTINGS::GetSettingsDropdownName(), PANEL_COLOR_SETTINGS::OnThemeChanged(), APPEARANCE_CONTROLS::rebuildLayers(), SETTINGS_MANAGER::SaveColorSettings(), and APPEARANCE_CONTROLS::syncColorsAndVisibility().

◆ IsTestEnabled()

bool ERC_SETTINGS::IsTestEnabled ( int aErrorCode ) const

inline

Definition at line 163 of file erc_settings.h.

References GetSeverity(), and RPT_SEVERITY_IGNORE.

Referenced by BOOST_FIXTURE_TEST_CASE(), CONNECTION_GRAPH::ercCheckHierSheets(), CONNECTION_GRAPH::ercCheckLabels(), CONNECTION_GRAPH::ercCheckNoConnects(), CONNECTION_GRAPH::RunERC(), and ERC_TESTER::TestConnectivity().

◆ Load()

void JSON_SETTINGS::Load ( )

virtualinherited

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

Definition at line 144 of file json_settings.cpp.

References m_params, m_resetParamsIfMissing, and traceSettings.

◆ LoadFromFile()

bool NESTED_SETTINGS::LoadFromFile ( const wxString & aDirectory = "" )

overridevirtualinherited

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

Parameters

aDirectory

Reimplemented from JSON_SETTINGS.

Definition at line 45 of file nested_settings.cpp.

References JSON_SETTINGS::GetFilename(), JSON_SETTINGS::GetFullFilename(), JSON_SETTINGS::Load(), JSON_SETTINGS::m_filename, JSON_SETTINGS::m_internals, m_parent, m_path, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS::Migrate(), and traceSettings.

Referenced by BOOST_AUTO_TEST_CASE(), BOARD_DESIGN_SETTINGS::LoadFromFile(), MIGRATING_NESTED_SETTINGS::MIGRATING_NESTED_SETTINGS(), DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), PNS::ROUTING_SETTINGS::ROUTING_SETTINGS(), SetParent(), and TEST_NESTED_SETTINGS::TEST_NESTED_SETTINGS().

◆ LoadFromRawFile()

bool JSON_SETTINGS::LoadFromRawFile ( const wxString & aPath )

inherited

Definition at line 595 of file json_settings.cpp.

References ALLOW_EXCEPTIONS, IGNORE_COMMENTS, Load(), m_internals, and traceSettings.

◆ Migrate()

bool JSON_SETTINGS::Migrate ( )

inherited

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

Definition at line 749 of file json_settings.cpp.

References m_internals, m_migrators, m_schemaVersion, and traceSettings.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), LoadFromFile(), and NESTED_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

aLegacyConfig is a wxConfigBase holding a loaded configuration to migrate

Returns: true if migration was successful

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

Definition at line 785 of file json_settings.cpp.

References traceSettings.

Referenced by LoadFromFile().

◆ migrateSchema0to1()

bool ERC_SETTINGS::migrateSchema0to1 ( )

private

Definition at line 266 of file erc_settings.cpp.

References JSON_SETTINGS::Get< nlohmann::json >(), m_ErcExclusionsLegacy, and JSON_SETTINGS::Set().

Referenced by ERC_SETTINGS().

◆ operator!=()

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

inline

Definition at line 158 of file erc_settings.h.

References ERC_SETTINGS().

◆ operator==()

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

inline

Definition at line 153 of file erc_settings.h.

References ERC_SETTINGS(), and m_ERCSeverities.

◆ registerMigration()

void JSON_SETTINGS::registerMigration	(	int	aOldSchemaVersion,
		int	aNewSchemaVersion,
		std::function< bool(void)>	aMigrator )

protectedinherited

Registers a migration from one schema version to another.

If the schema version in the file loaded from disk is less than the schema version of the JSON_SETTINGS class, migration functions will be called one after the other until the data is up-to-date.

Parameters

aOldSchemaVersion	is the starting schema version for this migration
aNewSchemaVersion	is the ending schema version for this migration
aMigrator	is a function that performs the migration and returns true if successful

Definition at line 740 of file json_settings.cpp.

References m_migrators, and m_schemaVersion.

Referenced by BITMAP2CMP_SETTINGS::BITMAP2CMP_SETTINGS(), BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), ERC_SETTINGS::ERC_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), MIGRATING_NESTED_SETTINGS::MIGRATING_NESTED_SETTINGS(), NET_SETTINGS::NET_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_FILE::PROJECT_FILE(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS(), and TUNING_PROFILES::TUNING_PROFILES().

◆ ReleaseNestedSettings()

void JSON_SETTINGS::ReleaseNestedSettings ( NESTED_SETTINGS * aSettings )

inherited

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

Parameters

aSettings is a pointer to a NESTED_SETTINGS that has already been added to this one

Definition at line 941 of file json_settings.cpp.

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

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), ~JSON_SETTINGS(), and SCHEMATIC_SETTINGS::~SCHEMATIC_SETTINGS().

◆ ResetPinMap()

void ERC_SETTINGS::ResetPinMap ( )

Definition at line 362 of file erc_settings.cpp.

References m_defaultPinMap, and m_PinMap.

Referenced by ERC_SETTINGS().

◆ ResetsParamsIfMissing()

bool JSON_SETTINGS::ResetsParamsIfMissing ( ) const

inlineinherited

Returns: true if a param absent from the file is reset to its default on load, meaning an absent key whose value equals the default is a faithful round-trip of the file. When false (e.g. board design settings), an absent key preserves the loaded value, so absent-and-default must still be treated as a change.

Definition at line 114 of file json_settings.h.

References m_resetParamsIfMissing.

Referenced by COLOR_MAP_PARAM::MatchesFile(), PARAM< ValueType >::MatchesFile(), PARAM_ENUM< EnumType >::MatchesFile(), PARAM_LAMBDA< ValueType >::MatchesFile(), PARAM_LIST< Type >::MatchesFile(), PARAM_MAP< Value >::MatchesFile(), PARAM_PATH::MatchesFile(), PARAM_PATH_LIST::MatchesFile(), PARAM_SCALED< ValueType >::MatchesFile(), PARAM_SET< Type >::MatchesFile(), and PARAM_WXSTRING_MAP::MatchesFile().

◆ ResetToDefaults()

void JSON_SETTINGS::ResetToDefaults ( )

inherited

Resets all parameters to default values.

Does NOT write to file or update underlying JSON.

Definition at line 399 of file json_settings.cpp.

References m_params.

Referenced by BOOST_AUTO_TEST_CASE(), PANEL_COMMON_SETTINGS::ResetPanel(), PANEL_MAINTENANCE::ResetPanel(), PANEL_MOUSE_SETTINGS::ResetPanel(), and PANEL_SPACEMOUSE::ResetPanel().

◆ SaveToFile()

bool NESTED_SETTINGS::SaveToFile	(	const wxString &	aDirectory = "",
		bool	aForce = false )

overridevirtualinherited

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

Parameters

aDirectory	is ignored.
aForce	is a flag to force the save.

Returns: true if the document contents were updated.

Reimplemented from JSON_SETTINGS.

Definition at line 129 of file nested_settings.cpp.

References dummy, JSON_SETTINGS::GetFilename(), JSON_SETTINGS::m_filename, JSON_SETTINGS::m_internals, JSON_SETTINGS::m_params, m_parent, m_path, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS_INTERNALS::PointerFromString(), JSON_SETTINGS::Store(), and traceSettings.

Referenced by BOOST_AUTO_TEST_CASE(), PCBNEW_JOBS_HANDLER::runPcbMerge(), SCH_EDIT_FRAME::saveProjectSettings(), and SIMULATOR_FRAME::SaveSettings().

◆ Set() [1/3]

template<typename ValueType>

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

inherited

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

Template Parameters

ValueType is the type to store

Parameters

aPath	is a path to store in the form "key1.key2.key3"
aVal	is the value to store

Definition at line 701 of file json_settings.cpp.

References m_internals.

◆ Set() [2/3]

template<>

void JSON_SETTINGS::Set	(	const std::string &	aPath,
		wxString	aVal )

inherited

Definition at line 980 of file json_settings.cpp.

◆ Set() [3/3]

template<>

KICOMMON_API void JSON_SETTINGS::Set	(	const std::string &	aPath,
		wxString	aVal )

inherited

References KICOMMON_API.

◆ SetFilename()

void JSON_SETTINGS::SetFilename ( const wxString & aFilename )

inlineinherited

Definition at line 92 of file json_settings.h.

References m_filename.

Referenced by SETTINGS_MANAGER::GetColorSettings(), PROJECT_FILE::SaveAs(), PROJECT_LOCAL_SETTINGS::SaveAs(), SETTINGS_MANAGER::SaveProjectAs(), and SETTINGS_MANAGER::SaveProjectCopy().

◆ SetIfPresent() [1/4]

bool JSON_SETTINGS::SetIfPresent	(	const nlohmann::json &	aObj,
		const std::string &	aPath,
		bool &	aTarget )

staticinherited

Sets the given bool if the given key/path is present.

Parameters

aObj	is the source object.
aPath	is the path of aObj.
aTarget	is the storage destination.

Returns: True if set, false if not.

Definition at line 806 of file json_settings.cpp.

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [2/4]

bool JSON_SETTINGS::SetIfPresent	(	const nlohmann::json &	aObj,
		const std::string &	aPath,
		int &	aTarget )

staticinherited

Sets the given int if the given key/path is present.

Parameters

aObj	is the source object.
aPath	is the path of aObj.
aTarget	is the storage destination.

Returns: True if set, false if not.

Definition at line 820 of file json_settings.cpp.

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [3/4]

bool JSON_SETTINGS::SetIfPresent	(	const nlohmann::json &	aObj,
		const std::string &	aPath,
		unsigned int &	aTarget )

staticinherited

Sets the given unsigned int if the given key/path is present.

Parameters

aObj	is the source object.
aPath	is the path of aObj.
aTarget	is the storage destination.

Returns: True if set, false if not.

Definition at line 834 of file json_settings.cpp.

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [4/4]

bool JSON_SETTINGS::SetIfPresent	(	const nlohmann::json &	aObj,
		const std::string &	aPath,
		wxString &	aTarget )

staticinherited

Sets the given string if the given key/path is present.

Parameters

aObj	is the source object
aPath	is the path of aObj.
aTarget	is the storage destination

Returns: True if set, false if not

Definition at line 792 of file json_settings.cpp.

References JSON_SETTINGS_INTERNALS::PointerFromString().

Referenced by FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), and SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetLegacyFilename()

void JSON_SETTINGS::SetLegacyFilename ( const wxString & aFilename )

inlineinherited

Definition at line 103 of file json_settings.h.

References m_legacy_filename.

Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetLocation()

void JSON_SETTINGS::SetLocation ( SETTINGS_LOC aLocation )

inlineinherited

Definition at line 94 of file json_settings.h.

References m_location.

Referenced by COLOR_SETTINGS::COLOR_SETTINGS(), and COLOR_SETTINGS::migrateSchema0to1().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER * aManager )

inlineinherited

Definition at line 228 of file json_settings.h.

References m_manager.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ SetParent()

void NESTED_SETTINGS::SetParent	(	JSON_SETTINGS *	aParent,
		bool	aLoadFromFile = true )

inherited

Definition at line 186 of file nested_settings.cpp.

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

Referenced by NESTED_SETTINGS(), and JSON_SETTINGS::ReleaseNestedSettings().

◆ SetPinMapValue() [1/2]

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

inline

Definition at line 211 of file erc_settings.h.

References m_PinMap.

◆ SetPinMapValue() [2/2]

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

inline

Definition at line 204 of file erc_settings.h.

References ELECTRICAL_PINTYPES_TOTAL, and m_PinMap.

Referenced by BOOST_FIXTURE_TEST_CASE(), ERC_SETTINGS(), and PANEL_SETUP_PINMAP::TransferDataFromWindow().

◆ SetReadOnly()

void JSON_SETTINGS::SetReadOnly ( bool aReadOnly )

inlineinherited

Definition at line 106 of file json_settings.h.

References m_writeFile.

Referenced by SETTINGS_MANAGER::GetColorSettings(), SETTINGS_MANAGER::loadAllColorSettings(), PANEL_COLOR_SETTINGS::OnThemeChanged(), PROJECT_FILE::SaveAs(), PROJECT_LOCAL_SETTINGS::SaveAs(), SETTINGS_MANAGER::SaveProjectAs(), and DIALOG_DATABASE_LIB_SETTINGS::TransferDataFromWindow().

◆ SetSeverity()

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

Definition at line 356 of file erc_settings.cpp.

References m_ERCSeverities.

Referenced by DIALOG_ERC::OnERCItemRClick(), and DIALOG_ERC::OnIgnoredItemRClick().

◆ 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 has been updated since the last save to disk

Reimplemented in PROJECT_FILE.

Definition at line 380 of file json_settings.cpp.

References m_modified, m_params, and traceSettings.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), NET_SETTINGS::CopyFrom(), flushToStore(), FormatAsString(), PANEL_FP_EDITOR_COLOR_SETTINGS::PANEL_FP_EDITOR_COLOR_SETTINGS(), SETTINGS_MANAGER::SaveColorSettings(), NESTED_SETTINGS::SaveToFile(), and PROJECT_FILE::Store().

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 370 of file json_settings.h.

Referenced by JSON_SETTINGS(), and 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 364 of file json_settings.h.

Referenced by JSON_SETTINGS(), and SaveToFile().

◆ m_defaultPinMap

PIN_ERROR ERC_SETTINGS::m_defaultPinMap

staticprivate

Initial value:

=
{
 
 { OK,  OK,   OK,   OK,   OK,   OK,   WAR,  OK,   OK,   OK,   OK,   ERR },
 { OK,  ERR,  OK,   WAR,  OK,   OK,   WAR,  OK,   ERR,  ERR,  ERR,  ERR },
 { OK,  OK,   OK,   OK,   OK,   OK,   WAR,  OK,   WAR,  OK,   WAR,  ERR },
 { OK,  WAR,  OK,   OK,   OK,   OK,   WAR,  WAR,  ERR,  WAR,  WAR,  ERR },
 { OK,  OK,   OK,   OK,   OK,   OK,   WAR,  OK,   OK,   OK,   OK,   ERR },
 { OK,  OK,   OK,   OK,   OK,   OK,   OK,   OK,   OK,   OK,   OK,   ERR },
 { WAR, WAR,  WAR,  WAR,  WAR,  OK,   WAR,  WAR,  WAR,  WAR,  WAR,  ERR },
 { OK,  OK,   OK,   WAR,  OK,   OK,   WAR,  OK,   OK,   OK,   OK,   ERR },
 { OK,  ERR,  WAR,  ERR,  OK,   OK,   WAR,  OK,   ERR,  ERR,  ERR,  ERR },
 { OK,  ERR,  OK,   WAR,  OK,   OK,   WAR,  OK,   ERR,  OK,   OK,   ERR },
 { OK,  ERR,  WAR,  WAR,  OK,   OK,   WAR,  OK,   ERR,  OK,   OK,   ERR },
 { 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 43 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 382 of file json_settings.h.

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

◆ m_ErcExclusions

std::set<ERC_EXCLUSION, ERC_EXCLUSION_COMPARE> ERC_SETTINGS::m_ErcExclusions

Definition at line 229 of file erc_settings.h.

Referenced by SCHEMATIC::ClearUnresolvedERCExclusions(), ERC_SETTINGS(), SCHEMATIC::RecordERCExclusions(), and SCHEMATIC::ResolveERCExclusions().

◆ m_ErcExclusionsLegacy

std::set<std::pair<wxString, wxString> > ERC_SETTINGS::m_ErcExclusionsLegacy

Definition at line 233 of file erc_settings.h.

Referenced by migrateSchema0to1(), and SCHEMATIC::ResolveERCExclusions().

◆ m_ERCSeverities

std::map<int, SEVERITY> ERC_SETTINGS::m_ERCSeverities

Definition at line 228 of file erc_settings.h.

◆ m_ERCSortingMetric

ERC_PIN_SORTING_METRIC ERC_SETTINGS::m_ERCSortingMetric

private

The type of sorting used by the ERC checker to resolve multi-pin errors.

Definition at line 254 of file erc_settings.h.

Referenced by ERC_SETTINGS(), and GetERCSortingMetric().

◆ m_filename

wxString JSON_SETTINGS::m_filename

protectedinherited

The filename (not including path) of this settings file (inicode)

Definition at line 349 of file json_settings.h.

Referenced by APP_SETTINGS_BASE::addParamsForWindow(), COLOR_SETTINGS::COLOR_SETTINGS(), APP_SETTINGS_BASE::DefaultGridSizeList(), APP_SETTINGS_BASE::DefaultZoomList(), GetFilename(), GetFullFilename(), JSON_SETTINGS(), LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), COLOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::operator=(), SaveToFile(), NESTED_SETTINGS::SaveToFile(), and SetFilename().

◆ m_fileSynced

bool JSON_SETTINGS::m_fileSynced

protectedinherited

True once the store has been synchronized with an on-disk file (loaded or saved)

Definition at line 379 of file json_settings.h.

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

◆ m_internals

std::unique_ptr<JSON_SETTINGS_INTERNALS> JSON_SETTINGS::m_internals

protectedinherited

Definition at line 399 of file json_settings.h.

◆ m_isFutureFormat

bool JSON_SETTINGS::m_isFutureFormat

protectedinherited

Set to true if this settings is loaded from a file with a newer schema version than is known.

Definition at line 391 of file json_settings.h.

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

◆ m_legacy_filename

wxString JSON_SETTINGS::m_legacy_filename

protectedinherited

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

Definition at line 352 of file json_settings.h.

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

◆ m_location

SETTINGS_LOC JSON_SETTINGS::m_location

protectedinherited

The location of this settings file (.

See also: SETTINGS_LOC)

Definition at line 355 of file json_settings.h.

Referenced by GetLocation(), JSON_SETTINGS(), and SetLocation().

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager

protectedinherited

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

Definition at line 394 of file json_settings.h.

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

◆ m_migrators

std::map<int, std::pair<int, std::function<bool()> > > JSON_SETTINGS::m_migrators

protectedinherited

A map of starting schema version to a pair of <ending version, migrator function>

Definition at line 397 of file json_settings.h.

Referenced by Migrate(), and registerMigration().

◆ m_modified

bool JSON_SETTINGS::m_modified

protectedinherited

True if the JSON data store has been written to since the last file write.

Definition at line 376 of file json_settings.h.

Referenced by TEST_JSON_SETTINGS::ClearModified(), DISK_SETTINGS::ForceModified(), TEST_JSON_SETTINGS::IsModified(), JSON_SETTINGS(), LoadFromFile(), ReleaseNestedSettings(), SaveToFile(), PROJECT_FILE::SerializeToString(), Store(), and PROJECT_FILE::Store().

◆ 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 361 of file json_settings.h.

Referenced by AddNestedSettings(), flushToStore(), LoadFromFile(), ReleaseNestedSettings(), and ~JSON_SETTINGS().

◆ m_params

std::vector<PARAM_BASE*> JSON_SETTINGS::m_params

protectedinherited

The list of parameters (owned by this object)

Definition at line 358 of file json_settings.h.

Referenced by PCB_VIEWERS_SETTINGS_BASE::addMatchPropertiesParam(), APP_SETTINGS_BASE::addParamsForWindow(), APP_SETTINGS_BASE::APP_SETTINGS_BASE(), BITMAP2CMP_SETTINGS::BITMAP2CMP_SETTINGS(), BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), COMMON_SETTINGS::COMMON_SETTINGS(), COMPONENT_CLASS_SETTINGS::COMPONENT_CLASS_SETTINGS(), COLOR_SETTINGS::CreateBuiltinColorSettings(), CVPCB_SETTINGS::CVPCB_SETTINGS(), DATABASE_LIB_SETTINGS::DATABASE_LIB_SETTINGS(), DISK_PARENT_SETTINGS::DISK_PARENT_SETTINGS(), DISK_SETTINGS::DISK_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), ERC_SETTINGS::ERC_SETTINGS(), FLUSH_TEST_SETTINGS::FLUSH_TEST_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), formatFileContents(), GERBVIEW_SETTINGS::GERBVIEW_SETTINGS(), COLOR_SETTINGS::GetDefaultColor(), HTTP_LIB_SETTINGS::HTTP_LIB_SETTINGS(), COLOR_SETTINGS::initFromOther(), JOBSET::JOBSET(), JSON_SETTINGS(), KICAD_SETTINGS::KICAD_SETTINGS(), Load(), NET_SETTINGS::NET_SETTINGS(), NGSPICE_SETTINGS::NGSPICE_SETTINGS(), PCB_CALCULATOR_SETTINGS::PCB_CALCULATOR_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PL_EDITOR_SETTINGS::PL_EDITOR_SETTINGS(), PROJECT_FILE::PROJECT_FILE(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), ResetToDefaults(), PNS::ROUTING_SETTINGS::ROUTING_SETTINGS(), NESTED_SETTINGS::SaveToFile(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), SPICE_SETTINGS::SPICE_SETTINGS(), Store(), SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS(), TEST_NESTED_SETTINGS::TEST_NESTED_SETTINGS(), TOOLBAR_SETTINGS::TOOLBAR_SETTINGS(), TUNING_PROFILES::TUNING_PROFILES(), and ~JSON_SETTINGS().

◆ m_parent

JSON_SETTINGS* NESTED_SETTINGS::m_parent

protectedinherited

A pointer to the parent object to load and store from.

Definition at line 63 of file nested_settings.h.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), GetParent(), LoadFromFile(), NESTED_SETTINGS(), SaveToFile(), SetParent(), BOARD_DESIGN_SETTINGS::~BOARD_DESIGN_SETTINGS(), COMPONENT_CLASS_SETTINGS::~COMPONENT_CLASS_SETTINGS(), ERC_SETTINGS::~ERC_SETTINGS(), MIGRATING_NESTED_SETTINGS::~MIGRATING_NESTED_SETTINGS(), ~NESTED_SETTINGS(), NET_SETTINGS::~NET_SETTINGS(), SCHEMATIC_SETTINGS::~SCHEMATIC_SETTINGS(), TEST_NESTED_SETTINGS::~TEST_NESTED_SETTINGS(), and TUNING_PROFILES::~TUNING_PROFILES().

◆ 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 66 of file nested_settings.h.

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

◆ m_PinMap

PIN_ERROR ERC_SETTINGS::m_PinMap[ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]

Definition at line 235 of file erc_settings.h.

Referenced by GetPinMapValue(), GetPinMapValue(), DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), ResetPinMap(), SetPinMapValue(), and SetPinMapValue().

◆ m_PinMinDrive

int ERC_SETTINGS::m_PinMinDrive

static

Initial value:

=
{
 
 { NOD,  DRV,  DRV,  DRV,  DRV,  NOD,  DRV,  NOD,  DRV,  DRV,  DRV,  NPI },
 { DRV,  DRV,  DRV,  DRV,  DRV,  NOD,  DRV,  DRV,  DRV,  DRV,  DRV,  NPI },
 { DRV,  DRV,  DRV,  DRV,  DRV,  NOD,  DRV,  NOD,  DRV,  DRV,  DRV,  NPI },
 { DRV,  DRV,  DRV,  DRV,  DRV,  NOD,  DRV,  NOD,  DRV,  DRV,  DRV,  NPI },
 { DRV,  DRV,  DRV,  DRV,  DRV,  NOD,  DRV,  NOD,  DRV,  DRV,  DRV,  NPI },
 { NOD,  NOD,  NOD,  NOD,  NOD,  NOD,  NOD,  NOD,  NOD,  NOD,  NOD,  NPI },
 { DRV,  DRV,  DRV,  DRV,  DRV,  NOD,  DRV,  NOD,  DRV,  DRV,  DRV,  NPI },
 { NOD,  DRV,  NOD,  NOD,  NOD,  NOD,  NOD,  NOD,  DRV,  NOD,  NOD,  NPI },
 { DRV,  DRV,  DRV,  DRV,  DRV,  NOD,  DRV,  DRV,  DRV,  DRV,  DRV,  NPI },
 { DRV,  DRV,  DRV,  DRV,  DRV,  NOD,  DRV,  NOD,  DRV,  DRV,  DRV,  NPI },
 { DRV,  DRV,  DRV,  DRV,  DRV,  NOD,  DRV,  NOD,  DRV,  DRV,  DRV,  NPI },
 { 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 71 of file erc_settings.h.

Referenced by GetPinMinDrive().

◆ m_PinTypeWeights

std::map<ELECTRICAL_PINTYPE, int> ERC_SETTINGS::m_PinTypeWeights

private

Weights for electrical pins used in ERC to decide which pin gets the marker in case of a multi-pin erc pin-to-pin error.

Definition at line 248 of file erc_settings.h.

Referenced by ERC_SETTINGS(), and GetPinTypeWeight().

◆ 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 385 of file json_settings.h.

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

◆ m_schemaVersion

int JSON_SETTINGS::m_schemaVersion

protectedinherited

Version of this settings schema.

Definition at line 388 of file json_settings.h.

Referenced by JSON_SETTINGS(), LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), Migrate(), registerMigration(), and NESTED_SETTINGS::SaveToFile().

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile

protectedinherited

Whether or not the backing store file should be written.

Definition at line 373 of file json_settings.h.

Referenced by COLOR_SETTINGS::CreateBuiltinColorSettings(), COLOR_SETTINGS::initFromOther(), IsReadOnly(), JSON_SETTINGS(), LoadFromFile(), SaveToFile(), and SetReadOnly().

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

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ERC_SETTINGS()

◆ ~ERC_SETTINGS()

Member Function Documentation

◆ AddNestedSettings()

◆ At()

◆ Contains()

◆ fetchOrDefault()

◆ flushToStore()

◆ FormatAsString()

◆ formatFileContents()

◆ fromLegacy()

◆ fromLegacyColor()

◆ fromLegacyString()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetERCSortingMetric()

◆ getFileExt()

◆ GetFileHistories()

◆ GetFilename()

◆ GetFullFilename()

◆ GetJson()

◆ getLegacyFileExt()

◆ GetLocation()

◆ GetOwningProject()

◆ GetParent()

◆ GetPinMapValue() [1/2]

◆ GetPinMapValue() [2/2]

◆ GetPinMinDrive()

◆ GetPinTypeWeight()

◆ GetSeverity()

◆ Internals()

◆ IsFileSynced()

◆ IsReadOnly()

◆ IsTestEnabled()

◆ Load()

◆ LoadFromFile()

◆ LoadFromRawFile()

◆ Migrate()

◆ MigrateFromLegacy()

◆ migrateSchema0to1()

◆ operator!=()

◆ operator==()

◆ registerMigration()

◆ ReleaseNestedSettings()

◆ ResetPinMap()

◆ ResetsParamsIfMissing()

◆ ResetToDefaults()

◆ SaveToFile()

◆ Set() [1/3]

◆ Set() [2/3]

◆ Set() [3/3]

◆ SetFilename()

◆ SetIfPresent() [1/4]

◆ SetIfPresent() [2/4]

◆ SetIfPresent() [3/4]

◆ SetIfPresent() [4/4]

◆ SetLegacyFilename()

◆ SetLocation()

◆ SetManager()

◆ SetParent()

◆ SetPinMapValue() [1/2]

◆ SetPinMapValue() [2/2]

◆ SetReadOnly()

◆ SetSeverity()

◆ Store()

Member Data Documentation

◆ m_createIfDefault