KiCad PCB EDA Suite
|
NET_SETTINGS stores various net-related settings in a project context. More...
#include <net_settings.h>
Public Member Functions | |
NET_SETTINGS (JSON_SETTINGS *aParent, const std::string &aPath) | |
virtual | ~NET_SETTINGS () |
bool | operator== (const NET_SETTINGS &aOther) const |
bool | operator!= (const NET_SETTINGS &aOther) const |
void | SetDefaultNetclass (std::shared_ptr< NETCLASS > netclass) |
Sets the default netclass for the project. | |
std::shared_ptr< NETCLASS > | GetDefaultNetclass () |
Gets the default netclass for the project. | |
bool | HasNetclass (const wxString &netclassName) const |
Determines if the given netclass exists. | |
void | SetNetclass (const wxString &netclassName, std::shared_ptr< NETCLASS > &netclass) |
Sets the given netclass. | |
void | SetNetclasses (const std::map< wxString, std::shared_ptr< NETCLASS > > &netclasses) |
Sets all netclass. | |
const std::map< wxString, std::shared_ptr< NETCLASS > > & | GetNetclasses () const |
Gets all netclasses. | |
const std::map< wxString, std::shared_ptr< NETCLASS > > & | GetCompositeNetclasses () const |
Gets all composite (multiple assignment / missing defaults) netclasses. | |
void | ClearNetclasses () |
Clears all netclasses. | |
const std::map< wxString, std::set< wxString > > & | GetNetclassLabelAssignments () const |
Gets all current net name to netclasses assignments. | |
void | ClearNetclassLabelAssignments () |
Clears all net name to netclasses assignments. | |
void | ClearNetclassLabelAssignment (const wxString &netName) |
Clears a specific net name to netclass assignment. | |
void | SetNetclassLabelAssignment (const wxString &netName, const std::set< wxString > &netclasses) |
Sets a net name to netclasses assignment. | |
void | AppendNetclassLabelAssignment (const wxString &netName, const std::set< wxString > &netclasses) |
Apppends to a net name to netclasses assignment. | |
bool | HasNetclassLabelAssignment (const wxString &netName) const |
Determines if a given net name has netclasses assigned. | |
void | SetNetclassPatternAssignment (const wxString &pattern, const wxString &netclass) |
Sets a netclass pattern assignment. | |
void | SetNetclassPatternAssignments (std::vector< std::pair< std::unique_ptr< EDA_COMBINED_MATCHER >, wxString > > &&netclassPatterns) |
Sets all netclass pattern assignments. | |
std::vector< std::pair< std::unique_ptr< EDA_COMBINED_MATCHER >, wxString > > & | GetNetclassPatternAssignments () |
Gets the netclass pattern assignments. | |
void | ClearNetclassPatternAssignments () |
Clears all netclass pattern assignments. | |
void | ClearCacheForNet (const wxString &netName) |
Clears effective netclass cache for the given net. | |
void | ClearAllCaches () |
void | SetNetColorAssignment (const wxString &netName, const KIGFX::COLOR4D &color) |
Sets a net to color assignment. | |
const std::map< wxString, KIGFX::COLOR4D > & | GetNetColorAssignments () const |
Gets all net name to color assignments. | |
void | ClearNetColorAssignments () |
Clears all net name to color assignments. | |
bool | HasEffectiveNetClass (const wxString &aNetName) const |
Determines if an effective netclass for the given net name has been cached. | |
std::shared_ptr< NETCLASS > | GetCachedEffectiveNetClass (const wxString &aNetName) const |
Returns an already cached effective netclass for the given net name. | |
std::shared_ptr< NETCLASS > | GetEffectiveNetClass (const wxString &aNetName) |
Fetches the effective (may be aggregate) netclass for the given net name. | |
void | RecomputeEffectiveNetclasses () |
Recomputes the internal values of all aggregate effective netclasses. | |
std::shared_ptr< NETCLASS > | GetNetClassByName (const wxString &aNetName) const |
Get a NETCLASS object from a given Netclass name string. | |
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 |
void | SetLegacyFilename (const wxString &aFilename) |
bool | IsReadOnly () const |
void | SetReadOnly (bool aReadOnly) |
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. | |
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<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) |
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 | ParseBusVector (const wxString &aBus, wxString *aName, std::vector< wxString > *aMemberList) |
Parse a bus vector (e.g. | |
static bool | ParseBusGroup (const wxString &aGroup, wxString *name, std::vector< wxString > *aMemberList) |
Parse a bus group label into the name and a list of components. | |
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. | |
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. | |
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_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. | |
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 () |
bool | migrateSchema1to2 () |
bool | migrateSchema2to3 () |
bool | migrateSchema3to4 () |
void | makeEffectiveNetclass (std::shared_ptr< NETCLASS > &effectiveNetclass, std::vector< NETCLASS * > &netclasses) const |
Creates an effective aggregate netclass from the given constituent netclasses. | |
bool | addMissingDefaults (NETCLASS *nc) const |
Adds any missing fields to the given netclass from the default netclass. | |
Private Attributes | |
std::shared_ptr< NETCLASS > | m_defaultNetClass |
The default netclass. | |
std::map< wxString, std::shared_ptr< NETCLASS > > | m_netClasses |
Map of netclass names to netclass definitions. | |
std::map< wxString, std::set< wxString > > | m_netClassLabelAssignments |
Map of net names to resolved netclasses. | |
std::vector< std::pair< std::unique_ptr< EDA_COMBINED_MATCHER >, wxString > > | m_netClassPatternAssignments |
List of net class pattern assignments. | |
std::map< wxString, std::shared_ptr< NETCLASS > > | m_compositeNetClasses |
Map of netclass names to netclass definitions for. | |
std::map< wxString, std::shared_ptr< NETCLASS > > | m_impicitNetClasses |
Map of netclass names to netclass definitions for implicit netclasses. | |
std::map< wxString, std::shared_ptr< NETCLASS > > | m_effectiveNetclassCache |
Cache of nets to pattern-matched netclasses. | |
std::map< wxString, KIGFX::COLOR4D > | m_netColorAssignments |
A map of fully-qualified net names to colors used in the board context. | |
NET_SETTINGS stores various net-related settings in a project context.
These settings are accessible and editable from both the schematic and PCB editors.
Definition at line 38 of file net_settings.h.
NET_SETTINGS::NET_SETTINGS | ( | JSON_SETTINGS * | aParent, |
const std::string & | aPath | ||
) |
Definition at line 61 of file net_settings.cpp.
References _, NETCLASS::Default, EDA_IU_SCALE::IUToMils(), EDA_IU_SCALE::IUTomm(), m_defaultNetClass, pcbIUScale, and schIUScale.
|
virtual |
Definition at line 332 of file net_settings.cpp.
References NESTED_SETTINGS::m_parent, and JSON_SETTINGS::ReleaseNestedSettings().
|
private |
Adds any missing fields to the given netclass from the default netclass.
Definition at line 916 of file net_settings.cpp.
References NETCLASS::HasBusWidth(), NETCLASS::HasClearance(), NETCLASS::HasDiffPairGap(), NETCLASS::HasDiffPairWidth(), NETCLASS::HasTrackWidth(), NETCLASS::HasuViaDiameter(), NETCLASS::HasuViaDrill(), NETCLASS::HasViaDiameter(), NETCLASS::HasViaDrill(), NETCLASS::HasWireWidth(), m_defaultNetClass, NETCLASS::SetBusWidth(), NETCLASS::SetBusWidthParent(), NETCLASS::SetClearance(), NETCLASS::SetClearanceParent(), NETCLASS::SetDiffPairGap(), NETCLASS::SetDiffPairGapParent(), NETCLASS::SetDiffPairWidth(), NETCLASS::SetDiffPairWidthParent(), NETCLASS::SetTrackWidth(), NETCLASS::SetTrackWidthParent(), NETCLASS::SetuViaDiameter(), NETCLASS::SetuViaDiameterParent(), NETCLASS::SetuViaDrill(), NETCLASS::SetuViaDrillParent(), NETCLASS::SetViaDiameter(), NETCLASS::SetViaDiameterParent(), NETCLASS::SetViaDrill(), NETCLASS::SetViaDrillParent(), NETCLASS::SetWireWidth(), and NETCLASS::SetWireWidthParent().
Referenced by makeEffectiveNetclass().
|
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;
aSettings | is the settings object to take ownership of |
aTarget | is a pointer to update to the passed in settings |
Definition at line 870 of file json_settings.cpp.
References JSON_SETTINGS::GetFilename(), JSON_SETTINGS::m_nested_settings, and traceSettings.
Referenced by NESTED_SETTINGS::SetParent().
void NET_SETTINGS::AppendNetclassLabelAssignment | ( | const wxString & | netName, |
const std::set< wxString > & | netclasses | ||
) |
Apppends to a net name to netclasses assignment.
Definition at line 542 of file net_settings.cpp.
References m_netClassLabelAssignments.
|
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 118 of file json_settings.cpp.
References JSON_SETTINGS::m_internals.
Referenced by EESCHEMA_SETTINGS::migrateBomSettings(), GERBVIEW_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::migrateLibTreeWidth(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), and PCBNEW_SETTINGS::PCBNEW_SETTINGS().
void NET_SETTINGS::ClearAllCaches | ( | ) |
Definition at line 609 of file net_settings.cpp.
References m_compositeNetClasses, and m_effectiveNetclassCache.
Referenced by SetNetclassPatternAssignment(), and SetNetclassPatternAssignments().
void NET_SETTINGS::ClearCacheForNet | ( | const wxString & | netName | ) |
Clears effective netclass cache for the given net.
Definition at line 597 of file net_settings.cpp.
References m_compositeNetClasses, and m_effectiveNetclassCache.
void NET_SETTINGS::ClearNetclasses | ( | ) |
Clears all netclasses.
Definition at line 510 of file net_settings.cpp.
References m_impicitNetClasses, and m_netClasses.
void NET_SETTINGS::ClearNetclassLabelAssignment | ( | const wxString & | netName | ) |
Clears a specific net name to netclass assignment.
Definition at line 529 of file net_settings.cpp.
References m_netClassLabelAssignments.
void NET_SETTINGS::ClearNetclassLabelAssignments | ( | ) |
Clears all net name to netclasses assignments.
Definition at line 523 of file net_settings.cpp.
References m_netClassLabelAssignments.
void NET_SETTINGS::ClearNetclassPatternAssignments | ( | ) |
Clears all netclass pattern assignments.
Definition at line 591 of file net_settings.cpp.
References m_netClassPatternAssignments.
void NET_SETTINGS::ClearNetColorAssignments | ( | ) |
Clears all net name to color assignments.
Definition at line 628 of file net_settings.cpp.
References m_netColorAssignments.
|
inherited |
Definition at line 124 of file json_settings.cpp.
References JSON_SETTINGS::m_internals, and JSON_SETTINGS_INTERNALS::PointerFromString().
Referenced by BOARD_DESIGN_SETTINGS::LoadFromFile(), EESCHEMA_SETTINGS::migrateBomSettings(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), and SETTINGS_MANAGER::SaveColorSettings().
|
staticprotectedinherited |
Helper to retrieve a value from a JSON object (dictionary) as a certain result type.
ResultType | is the type of the retrieved value. |
aJson | is the object to act on . |
aKey | is the object key to retrieve the value for. |
Definition at line 916 of file json_settings.cpp.
|
inherited |
Definition at line 515 of file json_settings.cpp.
References dummy, JSON_SETTINGS::m_internals, and JSON_SETTINGS::Store().
Referenced by ROUTER_TOOL::saveRouterDebugLog().
|
protectedinherited |
Translates a legacy wxConfig value to a given JSON pointer value.
ValueType | is the basic type of the value |
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 782 of file json_settings.cpp.
|
protectedinherited |
Translates a legacy COLOR4D stored in a wxConfig string to a given JSON pointer value.
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 842 of file json_settings.cpp.
References color.
Referenced by APP_SETTINGS_BASE::migrateWindowConfig().
|
protectedinherited |
Translates a legacy wxConfig string value to a given JSON pointer value.
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 818 of file json_settings.cpp.
Referenced by PROJECT_FILE::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), BITMAP2CMP_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), and APP_SETTINGS_BASE::migrateWindowConfig().
|
inherited |
Definition at line 900 of file json_settings.cpp.
References JSON_SETTINGS::GetJson().
|
inherited |
Fetches a value from within the JSON document.
Will return an empty optional if the value is not found or a mismatching type.
ValueType | is the type to cast to |
aPath | is the path within the document to retrieve |
Definition at line 580 of file json_settings.cpp.
References JSON_SETTINGS::GetJson().
Referenced by 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_PATH::MatchesFile(), PARAM_ENUM< EnumType >::MatchesFile(), PARAM_LAMBDA< ValueType >::MatchesFile(), and PARAM_SCALED< ValueType >::MatchesFile().
std::shared_ptr< NETCLASS > NET_SETTINGS::GetCachedEffectiveNetClass | ( | const wxString & | aNetName | ) | const |
Returns an already cached effective netclass for the given net name.
Definition at line 640 of file net_settings.cpp.
References m_effectiveNetclassCache.
Referenced by PNS_KICAD_IFACE::DisplayRatline(), and RATSNEST_VIEW_ITEM::ViewDraw().
const std::map< wxString, std::shared_ptr< NETCLASS > > & NET_SETTINGS::GetCompositeNetclasses | ( | ) | const |
Gets all composite (multiple assignment / missing defaults) netclasses.
Definition at line 504 of file net_settings.cpp.
References m_compositeNetClasses.
std::shared_ptr< NETCLASS > NET_SETTINGS::GetDefaultNetclass | ( | ) |
Gets the default netclass for the project.
Definition at line 474 of file net_settings.cpp.
References m_defaultNetClass.
std::shared_ptr< NETCLASS > NET_SETTINGS::GetEffectiveNetClass | ( | const wxString & | aNetName | ) |
Fetches the effective (may be aggregate) netclass for the given net name.
Definition at line 646 of file net_settings.cpp.
References NETCLASS::Default, m_compositeNetClasses, m_defaultNetClass, m_effectiveNetclassCache, m_impicitNetClasses, m_netClasses, m_netClassLabelAssignments, m_netClassPatternAssignments, makeEffectiveNetclass(), and name.
|
inlineprotectedvirtualinherited |
Reimplemented in JOBSET, DATABASE_LIB_SETTINGS, HTTP_LIB_SETTINGS, PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.
Definition at line 282 of file json_settings.h.
Referenced by JSON_SETTINGS::GetFullFilename(), JSON_SETTINGS::LoadFromFile(), and JSON_SETTINGS::SaveToFile().
|
inlineinherited |
Definition at line 80 of file json_settings.h.
Referenced by JSON_SETTINGS::AddNestedSettings(), DIALOG_PLOT_SCHEMATIC::getPlotOptions(), SETTINGS_MANAGER::loadColorSettingsByName(), NESTED_SETTINGS::LoadFromFile(), EESCHEMA_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), COLOR_SETTINGS::migrateSchema0to1(), PANEL_COLOR_SETTINGS::OnLeftDownTheme(), PANEL_COLOR_SETTINGS::OnThemeChanged(), DIALOG_PLOT_SCHEMATIC::plotSchematic(), PROJECT_FILE::SaveAs(), SETTINGS_MANAGER::SaveColorSettings(), PANEL_COLOR_SETTINGS::saveCurrentTheme(), DIALOG_PRINT_USING_PRINTER::SavePrintOptions(), DIALOG_PRINT_PCBNEW::saveSettings(), NESTED_SETTINGS::SaveToFile(), PANEL_EESCHEMA_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_SYM_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_GERBVIEW_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_PL_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_FP_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), and PANEL_PCBNEW_COLOR_SETTINGS::TransferDataFromWindow().
|
inherited |
Definition at line 109 of file json_settings.cpp.
References JSON_SETTINGS::getFileExt(), and JSON_SETTINGS::m_filename.
Referenced by JSON_SETTINGS::JSON_SETTINGS(), JSON_SETTINGS::LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::SaveToFile(), and SETTINGS_MANAGER::SETTINGS_MANAGER().
|
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.
aPath | is a string containing one or more keys separated by '.' |
Definition at line 560 of file json_settings.cpp.
References JSON_SETTINGS::m_internals.
Referenced by JSON_SETTINGS::Get(), PARAM_LAMBDA< ValueType >::Load(), PARAM_LIST< Type >::Load(), PARAM_SET< Type >::Load(), PARAM_MAP< Value >::Load(), PARAM_WXSTRING_MAP::Load(), PARAM_LAMBDA< ValueType >::MatchesFile(), PARAM_LIST< Type >::MatchesFile(), PARAM_SET< Type >::MatchesFile(), PARAM_PATH_LIST::MatchesFile(), PARAM_MAP< Value >::MatchesFile(), PARAM_WXSTRING_MAP::MatchesFile(), SETTINGS_MANAGER::SaveColorSettings(), and NESTED_SETTINGS::SaveToFile().
|
inlineprotectedvirtualinherited |
Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.
Definition at line 287 of file json_settings.h.
Referenced by JSON_SETTINGS::LoadFromFile().
|
inlineinherited |
Definition at line 87 of file json_settings.h.
Referenced by SETTINGS_MANAGER::GetPathForSettingsFile(), and COLOR_SETTINGS::migrateSchema0to1().
std::shared_ptr< NETCLASS > NET_SETTINGS::GetNetClassByName | ( | const wxString & | aNetName | ) | const |
Get a NETCLASS object from a given Netclass name string.
aNetClassName | the Netclass name to resolve |
Definition at line 1002 of file net_settings.cpp.
References m_defaultNetClass, and m_netClasses.
const std::map< wxString, std::shared_ptr< NETCLASS > > & NET_SETTINGS::GetNetclasses | ( | ) | const |
const std::map< wxString, std::set< wxString > > & NET_SETTINGS::GetNetclassLabelAssignments | ( | ) | const |
Gets all current net name to netclasses assignments.
Definition at line 517 of file net_settings.cpp.
References m_netClassLabelAssignments.
std::vector< std::pair< std::unique_ptr< EDA_COMBINED_MATCHER >, wxString > > & NET_SETTINGS::GetNetclassPatternAssignments | ( | ) |
Gets the netclass pattern assignments.
Definition at line 585 of file net_settings.cpp.
References m_netClassPatternAssignments.
const std::map< wxString, KIGFX::COLOR4D > & NET_SETTINGS::GetNetColorAssignments | ( | ) | const |
Gets all net name to color assignments.
Definition at line 622 of file net_settings.cpp.
References m_netColorAssignments.
|
inlineinherited |
Definition at line 54 of file nested_settings.h.
Referenced by BOARD_DESIGN_SETTINGS::LoadFromFile().
bool NET_SETTINGS::HasEffectiveNetClass | ( | const wxString & | aNetName | ) | const |
Determines if an effective netclass for the given net name has been cached.
Definition at line 634 of file net_settings.cpp.
References m_effectiveNetclassCache.
Referenced by PNS_KICAD_IFACE::DisplayRatline(), and RATSNEST_VIEW_ITEM::ViewDraw().
bool NET_SETTINGS::HasNetclass | ( | const wxString & | netclassName | ) | const |
Determines if the given netclass exists.
Definition at line 480 of file net_settings.cpp.
References m_netClasses.
bool NET_SETTINGS::HasNetclassLabelAssignment | ( | const wxString & | netName | ) | const |
Determines if a given net name has netclasses assigned.
Definition at line 549 of file net_settings.cpp.
References m_netClassLabelAssignments.
|
inherited |
Definition at line 130 of file json_settings.cpp.
References JSON_SETTINGS::m_internals.
Referenced by COLOR_SETTINGS::migrateSchema0to1(), and SETTINGS_MANAGER::SaveColorSettings().
|
inlineinherited |
Definition at line 91 of file json_settings.h.
Referenced by PANEL_COLOR_SETTINGS::GetSettingsDropdownName(), PANEL_COLOR_SETTINGS::OnThemeChanged(), APPEARANCE_CONTROLS::rebuildLayers(), PANEL_COLOR_SETTINGS::ResetPanel(), SETTINGS_MANAGER::SaveColorSettings(), PANEL_COLOR_SETTINGS::saveCurrentTheme(), PANEL_COLOR_SETTINGS::ShowColorContextMenu(), APPEARANCE_CONTROLS::syncColorsAndVisibility(), and PANEL_COLOR_SETTINGS::updateSwatches().
|
virtualinherited |
Updates the parameters of this object based on the current JSON document contents.
Definition at line 136 of file json_settings.cpp.
References JSON_SETTINGS::m_params, JSON_SETTINGS::m_resetParamsIfMissing, and traceSettings.
Referenced by COLOR_SETTINGS::CreateBuiltinColorSettings(), JSON_SETTINGS::LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromRawFile(), PCB_TEST_FRAME_BASE::LoadSettings(), COLOR_SETTINGS::migrateSchema0to1(), PANEL_3D_DISPLAY_OPTIONS::ResetPanel(), PANEL_3D_OPENGL_OPTIONS::ResetPanel(), PANEL_3D_RAYTRACING_OPTIONS::ResetPanel(), PANEL_EESCHEMA_ANNOTATION_OPTIONS::ResetPanel(), PANEL_EESCHEMA_DISPLAY_OPTIONS::ResetPanel(), PANEL_EESCHEMA_EDITING_OPTIONS::ResetPanel(), PANEL_SYM_DISPLAY_OPTIONS::ResetPanel(), PANEL_SYM_EDITING_OPTIONS::ResetPanel(), PANEL_GERBVIEW_DISPLAY_OPTIONS::ResetPanel(), PANEL_PL_EDITOR_DISPLAY_OPTIONS::ResetPanel(), PANEL_EDIT_OPTIONS::ResetPanel(), PANEL_FP_EDITOR_DEFAULTS::ResetPanel(), PANEL_PCB_DISPLAY_OPTIONS::ResetPanel(), PANEL_PCBNEW_DISPLAY_ORIGIN::ResetPanel(), SETTINGS_MANAGER::SaveColorSettings(), and SETTINGS_MANAGER::SETTINGS_MANAGER().
|
overridevirtualinherited |
Loads the JSON document from the parent and then calls Load()
aDirectory |
Reimplemented from JSON_SETTINGS.
Definition at line 44 of file nested_settings.cpp.
References JSON_SETTINGS::GetFilename(), JSON_SETTINGS::GetFullFilename(), JSON_SETTINGS::Load(), JSON_SETTINGS::m_filename, JSON_SETTINGS::m_internals, NESTED_SETTINGS::m_parent, NESTED_SETTINGS::m_path, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS::Migrate(), and traceSettings.
Referenced by BOARD_DESIGN_SETTINGS::LoadFromFile(), DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), PNS::ROUTING_SETTINGS::ROUTING_SETTINGS(), and NESTED_SETTINGS::SetParent().
|
inherited |
Definition at line 528 of file json_settings.cpp.
References JSON_SETTINGS::Load(), JSON_SETTINGS::m_internals, and traceSettings.
|
private |
Creates an effective aggregate netclass from the given constituent netclasses.
Takes the aggregate parameters from the constituent netclasses in priority order. If any parameters are missing from the overall union, then they are filled from the default netclass. Note that the netclasses vector will have the default netclass added if it is used to provide missing defaults. The netclasses vector will be sorted by priority 1st and then name alphabetically
Definition at line 796 of file net_settings.cpp.
References addMissingDefaults(), NETCLASS::GetBusWidth(), NETCLASS::GetClearance(), NETCLASS::GetDiffPairGap(), NETCLASS::GetDiffPairViaGap(), NETCLASS::GetDiffPairWidth(), NETCLASS::GetLineStyle(), NETCLASS::GetPcbColor(), NETCLASS::GetSchematicColor(), NETCLASS::GetTrackWidth(), NETCLASS::GetuViaDiameter(), NETCLASS::GetuViaDrill(), NETCLASS::GetViaDiameter(), NETCLASS::GetViaDrill(), NETCLASS::GetWireWidth(), NETCLASS::HasBusWidth(), NETCLASS::HasClearance(), NETCLASS::HasDiffPairGap(), NETCLASS::HasDiffPairViaGap(), NETCLASS::HasDiffPairWidth(), NETCLASS::HasLineStyle(), NETCLASS::HasTrackWidth(), NETCLASS::HasuViaDiameter(), NETCLASS::HasuViaDrill(), NETCLASS::HasViaDiameter(), NETCLASS::HasViaDrill(), NETCLASS::HasWireWidth(), m_defaultNetClass, and NETCLASS::SetClearance().
Referenced by GetEffectiveNetClass(), and RecomputeEffectiveNetclasses().
|
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
Definition at line 677 of file json_settings.cpp.
References JSON_SETTINGS::m_internals, JSON_SETTINGS::m_migrators, JSON_SETTINGS::m_schemaVersion, and traceSettings.
Referenced by JSON_SETTINGS::LoadFromFile(), and NESTED_SETTINGS::LoadFromFile().
|
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.
aLegacyConfig | is a wxConfigBase holding a loaded configuration to migrate |
Reimplemented in PROJECT_FILE, APP_SETTINGS_BASE, COLOR_SETTINGS, EDA_3D_VIEWER_SETTINGS, BITMAP2CMP_SETTINGS, EESCHEMA_SETTINGS, SYMBOL_EDITOR_SETTINGS, GERBVIEW_SETTINGS, FOOTPRINT_EDITOR_SETTINGS, PROJECT_LOCAL_SETTINGS, COMMON_SETTINGS, CVPCB_SETTINGS, KICAD_SETTINGS, PL_EDITOR_SETTINGS, PCB_CALCULATOR_SETTINGS, and PCBNEW_SETTINGS.
Definition at line 713 of file json_settings.cpp.
References traceSettings.
Referenced by JSON_SETTINGS::LoadFromFile().
|
private |
Definition at line 368 of file net_settings.cpp.
References ConvertToNewOverbarNotation(), and JSON_SETTINGS::m_internals.
|
private |
Definition at line 390 of file net_settings.cpp.
|
private |
Definition at line 396 of file net_settings.cpp.
References JSON_SETTINGS::m_internals.
|
private |
Definition at line 429 of file net_settings.cpp.
References NETCLASS::Default, and JSON_SETTINGS::m_internals.
|
inline |
Definition at line 47 of file net_settings.h.
References operator==().
bool NET_SETTINGS::operator== | ( | const NET_SETTINGS & | aOther | ) | const |
Definition at line 343 of file net_settings.cpp.
References m_netClasses, m_netClassLabelAssignments, m_netClassPatternAssignments, and m_netColorAssignments.
|
static |
Parse a bus group label into the name and a list of components.
aGroup | is the input label, e.g. "USB{DP DM}" |
name | is the output group name, e.g. "USB" |
aMemberList | is a list of member strings, e.g. "DP", "DM" |
Definition at line 1150 of file net_settings.cpp.
References CTX_NETNAME, EscapeString(), and isSuperSubOverbar().
Referenced by SCH_CONNECTION::AppendInfoToMsgPanel(), SCH_EDITOR_CONTROL::AssignNetclass(), SCH_EDIT_TOOL::ChangeTextType(), SCH_CONNECTION::ConfigureFromLabel(), SCH_CONNECTION::IsBusLabel(), and SCH_NETNAME_VALIDATOR::IsValid().
|
static |
Parse a bus vector (e.g.
A[7..0]) into name, begin, and end.
Ensure that begin and end are positive and that end > begin.
aBus | is a bus vector label string |
aName | out is the bus name, e.g. "A" |
aMemberList | is a list of member strings, e.g. "A7", "A6", and so on |
Definition at line 1019 of file net_settings.cpp.
References isDigit(), and isSuperSubOverbar().
Referenced by SCH_EDITOR_CONTROL::AssignNetclass(), SCH_CONNECTION::ConfigureFromLabel(), SCH_CONNECTION::IsBusLabel(), SCH_NETNAME_VALIDATOR::IsValid(), and SCH_IO_EAGLE::translateEagleBusName().
void NET_SETTINGS::RecomputeEffectiveNetclasses | ( | ) |
Recomputes the internal values of all aggregate effective netclasses.
Definition at line 773 of file net_settings.cpp.
References NETCLASS::Default, m_compositeNetClasses, and makeEffectiveNetclass().
|
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.
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 668 of file json_settings.cpp.
References JSON_SETTINGS::m_migrators, and JSON_SETTINGS::m_schemaVersion.
Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), and SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().
|
inherited |
Saves and frees a nested settings object, if it exists within this one.
aSettings | is a pointer to a NESTED_SETTINGS that has already been added to this one |
Definition at line 877 of file json_settings.cpp.
References JSON_SETTINGS::m_manager, JSON_SETTINGS::m_modified, JSON_SETTINGS::m_nested_settings, NESTED_SETTINGS::SetParent(), and traceSettings.
Referenced by BOARD_DESIGN_SETTINGS::~BOARD_DESIGN_SETTINGS(), ERC_SETTINGS::~ERC_SETTINGS(), NESTED_SETTINGS::~NESTED_SETTINGS(), ~NET_SETTINGS(), and SCHEMATIC_SETTINGS::~SCHEMATIC_SETTINGS().
|
inherited |
Resets all parameters to default values.
Does NOT write to file or update underlying JSON.
Definition at line 387 of file json_settings.cpp.
References JSON_SETTINGS::m_params.
Referenced by EDA_3D_VIEWER_FRAME::Process_Special_Functions(), PANEL_COMMON_SETTINGS::ResetPanel(), and PANEL_MOUSE_SETTINGS::ResetPanel().
|
overridevirtualinherited |
Calls Store() and then saves the JSON document contents into the parent JSON_SETTINGS.
aDirectory | is ignored |
Reimplemented from JSON_SETTINGS.
Definition at line 128 of file nested_settings.cpp.
References dummy, JSON_SETTINGS::GetFilename(), JSON_SETTINGS::GetJson(), JSON_SETTINGS::m_filename, JSON_SETTINGS::m_internals, NESTED_SETTINGS::m_parent, NESTED_SETTINGS::m_path, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS::Store(), and traceSettings.
|
inherited |
Stores a value into the JSON document Will throw an exception if ValueType isn't something that the library can handle.
ValueType | is the type to store |
aPath | is a path to store in the form "key1.key2.key3" |
aVal | is the value to store |
Definition at line 631 of file json_settings.cpp.
References JSON_SETTINGS::m_internals.
Referenced by COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), BOARD_DESIGN_SETTINGS::LoadFromFile(), APP_SETTINGS_BASE::migrateFindReplace(), PROJECT_FILE::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), KICAD_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_FILE::SaveAs(), PROJECT_LOCAL_SETTINGS::SaveAs(), PROJECT_FILE::SaveToFile(), PROJECT_LOCAL_SETTINGS::SaveToFile(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), COLOR_MAP_PARAM::Store(), PARAM< ValueType >::Store(), PARAM_PATH::Store(), PARAM_ENUM< EnumType >::Store(), PARAM_LAMBDA< ValueType >::Store(), PARAM_SCALED< ValueType >::Store(), PARAM_LIST< Type >::Store(), PARAM_SET< Type >::Store(), PARAM_PATH_LIST::Store(), PARAM_MAP< Value >::Store(), and PARAM_WXSTRING_MAP::Store().
|
inherited |
Definition at line 909 of file json_settings.cpp.
|
inherited |
void NET_SETTINGS::SetDefaultNetclass | ( | std::shared_ptr< NETCLASS > | netclass | ) |
Sets the default netclass for the project.
Definition at line 468 of file net_settings.cpp.
References m_defaultNetClass.
|
inlineinherited |
Definition at line 84 of file json_settings.h.
Referenced by SETTINGS_MANAGER::GetColorSettings(), PROJECT_FILE::SaveAs(), PROJECT_LOCAL_SETTINGS::SaveAs(), SETTINGS_MANAGER::SaveProjectAs(), and SETTINGS_MANAGER::SaveProjectCopy().
|
staticinherited |
Sets the given bool if the given key/path is present.
aObj | is the source object |
aTarget | is the storage destination |
Definition at line 736 of file json_settings.cpp.
References JSON_SETTINGS_INTERNALS::PointerFromString().
|
staticinherited |
Sets the given int if the given key/path is present.
aObj | is the source object |
aTarget | is the storage destination |
Definition at line 751 of file json_settings.cpp.
References JSON_SETTINGS_INTERNALS::PointerFromString().
|
staticinherited |
Sets the given unsigned int if the given key/path is present.
aObj | is the source object |
aTarget | is the storage destination |
Definition at line 766 of file json_settings.cpp.
References JSON_SETTINGS_INTERNALS::PointerFromString().
|
staticinherited |
Sets the given string if the given key/path is present.
aObj | is the source object |
aTarget | is the storage destination |
Definition at line 721 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().
|
inlineinherited |
Definition at line 89 of file json_settings.h.
Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().
|
inlineinherited |
Definition at line 86 of file json_settings.h.
Referenced by COLOR_SETTINGS::COLOR_SETTINGS(), and COLOR_SETTINGS::migrateSchema0to1().
|
inlineinherited |
Definition at line 198 of file json_settings.h.
void NET_SETTINGS::SetNetclass | ( | const wxString & | netclassName, |
std::shared_ptr< NETCLASS > & | netclass | ||
) |
void NET_SETTINGS::SetNetclasses | ( | const std::map< wxString, std::shared_ptr< NETCLASS > > & | netclasses | ) |
void NET_SETTINGS::SetNetclassLabelAssignment | ( | const wxString & | netName, |
const std::set< wxString > & | netclasses | ||
) |
Sets a net name to netclasses assignment.
Definition at line 535 of file net_settings.cpp.
References m_netClassLabelAssignments.
void NET_SETTINGS::SetNetclassPatternAssignment | ( | const wxString & | pattern, |
const wxString & | netclass | ||
) |
Sets a netclass pattern assignment.
Definition at line 555 of file net_settings.cpp.
References ClearAllCaches(), CTX_NETCLASS, and m_netClassPatternAssignments.
void NET_SETTINGS::SetNetclassPatternAssignments | ( | std::vector< std::pair< std::unique_ptr< EDA_COMBINED_MATCHER >, wxString > > && | netclassPatterns | ) |
Sets all netclass pattern assignments.
Definition at line 576 of file net_settings.cpp.
References ClearAllCaches(), and m_netClassPatternAssignments.
void NET_SETTINGS::SetNetColorAssignment | ( | const wxString & | netName, |
const KIGFX::COLOR4D & | color | ||
) |
Sets a net to color assignment.
Definition at line 616 of file net_settings.cpp.
References color, and m_netColorAssignments.
|
inherited |
Definition at line 169 of file nested_settings.cpp.
References JSON_SETTINGS::AddNestedSettings(), NESTED_SETTINGS::LoadFromFile(), and NESTED_SETTINGS::m_parent.
Referenced by BOARD::ClearProject(), NESTED_SETTINGS::NESTED_SETTINGS(), and JSON_SETTINGS::ReleaseNestedSettings().
|
inlineinherited |
Definition at line 92 of file json_settings.h.
Referenced by SETTINGS_MANAGER::GetColorSettings(), SETTINGS_MANAGER::loadAllColorSettings(), PANEL_COLOR_SETTINGS::OnThemeChanged(), PROJECT_FILE::SaveAs(), and SETTINGS_MANAGER::SaveProjectAs().
|
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.
Definition at line 375 of file json_settings.cpp.
References JSON_SETTINGS::m_modified, and JSON_SETTINGS::m_params.
Referenced by JSON_SETTINGS::FormatAsString(), PANEL_FP_EDITOR_COLOR_SETTINGS::PANEL_FP_EDITOR_COLOR_SETTINGS(), SETTINGS_MANAGER::SaveColorSettings(), JSON_SETTINGS::SaveToFile(), and NESTED_SETTINGS::SaveToFile().
|
private |
Map of netclass names to netclass definitions for.
Definition at line 210 of file net_settings.h.
Referenced by ClearAllCaches(), ClearCacheForNet(), GetCompositeNetclasses(), GetEffectiveNetClass(), and RecomputeEffectiveNetclasses().
|
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 325 of file json_settings.h.
Referenced by JSON_SETTINGS::SaveToFile().
|
protectedinherited |
Whether or not the backing store file should be created it if doesn't exist.
Definition at line 319 of file json_settings.h.
Referenced by JSON_SETTINGS::SaveToFile().
|
private |
The default netclass.
Definition at line 196 of file net_settings.h.
Referenced by addMissingDefaults(), GetDefaultNetclass(), GetEffectiveNetClass(), GetNetClassByName(), makeEffectiveNetclass(), NET_SETTINGS(), and SetDefaultNetclass().
|
protectedinherited |
Whether or not to delete legacy file after migration.
Definition at line 334 of file json_settings.h.
Referenced by JSON_SETTINGS::LoadFromFile(), PROJECT_FILE::PROJECT_FILE(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().
|
private |
Cache of nets to pattern-matched netclasses.
Definition at line 221 of file net_settings.h.
Referenced by ClearAllCaches(), ClearCacheForNet(), GetCachedEffectiveNetClass(), GetEffectiveNetClass(), and HasEffectiveNetClass().
|
protectedinherited |
The filename (not including path) of this settings file (inicode)
Definition at line 304 of file json_settings.h.
Referenced by APP_SETTINGS_BASE::addParamsForWindow(), APP_SETTINGS_BASE::APP_SETTINGS_BASE(), APP_SETTINGS_BASE::DefaultGridSizeList(), JSON_SETTINGS::GetFullFilename(), JSON_SETTINGS::LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), COLOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::operator=(), JSON_SETTINGS::SaveToFile(), and NESTED_SETTINGS::SaveToFile().
|
private |
Map of netclass names to netclass definitions for implicit netclasses.
Implicit netclasses are those which are in a netclass label, but which do not have a netclass definition in the netclass setup panel. They contribute as a constituent netclass to enable DRC rules and name resolution, but do not contribute parameters
Definition at line 218 of file net_settings.h.
Referenced by ClearNetclasses(), and GetEffectiveNetClass().
|
protectedinherited |
Definition at line 348 of file json_settings.h.
Referenced by JSON_SETTINGS::At(), JSON_SETTINGS::Contains(), JSON_SETTINGS::FormatAsString(), JSON_SETTINGS::GetJson(), JSON_SETTINGS::Internals(), JSON_SETTINGS::JSON_SETTINGS(), JSON_SETTINGS::LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromRawFile(), JSON_SETTINGS::Migrate(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::migrateSchema0to1(), migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), COMMON_SETTINGS::migrateSchema0to1(), COMMON_SETTINGS::migrateSchema1to2(), migrateSchema2to3(), migrateSchema3to4(), JSON_SETTINGS::SaveToFile(), NESTED_SETTINGS::SaveToFile(), and JSON_SETTINGS::Set().
|
protectedinherited |
The filename of the wxConfig legacy file (if different from m_filename)
Definition at line 307 of file json_settings.h.
Referenced by JSON_SETTINGS::LoadFromFile().
|
protectedinherited |
The location of this settings file (.
Definition at line 310 of file json_settings.h.
|
protectedinherited |
A pointer to the settings manager managing this file (may be null)
Definition at line 343 of file json_settings.h.
Referenced by FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), and JSON_SETTINGS::ReleaseNestedSettings().
|
protectedinherited |
A map of starting schema version to a pair of <ending version, migrator function>
Definition at line 346 of file json_settings.h.
Referenced by JSON_SETTINGS::Migrate(), and JSON_SETTINGS::registerMigration().
|
protectedinherited |
True if the JSON data store has been written to since the last file write.
Definition at line 331 of file json_settings.h.
Referenced by JSON_SETTINGS::LoadFromFile(), JSON_SETTINGS::ReleaseNestedSettings(), JSON_SETTINGS::SaveToFile(), and JSON_SETTINGS::Store().
|
protectedinherited |
Nested settings files that live inside this one, if any.
Definition at line 316 of file json_settings.h.
Referenced by JSON_SETTINGS::AddNestedSettings(), JSON_SETTINGS::LoadFromFile(), JSON_SETTINGS::ReleaseNestedSettings(), and JSON_SETTINGS::SaveToFile().
|
private |
Map of netclass names to netclass definitions.
Definition at line 199 of file net_settings.h.
Referenced by ClearNetclasses(), GetEffectiveNetClass(), GetNetClassByName(), GetNetclasses(), HasNetclass(), operator==(), SetNetclass(), and SetNetclasses().
|
private |
Map of net names to resolved netclasses.
Definition at line 202 of file net_settings.h.
Referenced by AppendNetclassLabelAssignment(), ClearNetclassLabelAssignment(), ClearNetclassLabelAssignments(), GetEffectiveNetClass(), GetNetclassLabelAssignments(), HasNetclassLabelAssignment(), operator==(), and SetNetclassLabelAssignment().
|
private |
List of net class pattern assignments.
Definition at line 206 of file net_settings.h.
Referenced by ClearNetclassPatternAssignments(), GetEffectiveNetClass(), GetNetclassPatternAssignments(), operator==(), SetNetclassPatternAssignment(), and SetNetclassPatternAssignments().
|
private |
A map of fully-qualified net names to colors used in the board context.
Since these color overrides are for the board, buses are not included here. Only nets that the user has assigned custom colors to will be in this list. Nets that no longer exist will be deleted during a netlist read in Pcbnew.
Definition at line 229 of file net_settings.h.
Referenced by ClearNetColorAssignments(), GetNetColorAssignments(), operator==(), and SetNetColorAssignment().
|
protectedinherited |
The list of parameters (owned by this object)
Definition at line 313 of file json_settings.h.
Referenced by 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(), COLOR_SETTINGS::CreateBuiltinColorSettings(), CVPCB_SETTINGS::CVPCB_SETTINGS(), DATABASE_LIB_SETTINGS::DATABASE_LIB_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), ERC_SETTINGS::ERC_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), GERBVIEW_SETTINGS::GERBVIEW_SETTINGS(), COLOR_SETTINGS::GetDefaultColor(), HTTP_LIB_SETTINGS::HTTP_LIB_SETTINGS(), COLOR_SETTINGS::initFromOther(), JOBSET::JOBSET(), JSON_SETTINGS::JSON_SETTINGS(), KICAD_SETTINGS::KICAD_SETTINGS(), JSON_SETTINGS::Load(), 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(), JSON_SETTINGS::ResetToDefaults(), PNS::ROUTING_SETTINGS::ROUTING_SETTINGS(), JSON_SETTINGS::SaveToFile(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), SPICE_SETTINGS::SPICE_SETTINGS(), JSON_SETTINGS::Store(), SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS(), and JSON_SETTINGS::~JSON_SETTINGS().
|
protectedinherited |
A pointer to the parent object to load and store from.
Definition at line 62 of file nested_settings.h.
Referenced by NESTED_SETTINGS::LoadFromFile(), NESTED_SETTINGS::SaveToFile(), NESTED_SETTINGS::SetParent(), BOARD_DESIGN_SETTINGS::~BOARD_DESIGN_SETTINGS(), ERC_SETTINGS::~ERC_SETTINGS(), NESTED_SETTINGS::~NESTED_SETTINGS(), ~NET_SETTINGS(), and SCHEMATIC_SETTINGS::~SCHEMATIC_SETTINGS().
|
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().
|
protectedinherited |
Whether or not to set parameters to their default value if missing from JSON on Load()
Definition at line 337 of file json_settings.h.
Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), and JSON_SETTINGS::Load().
|
protectedinherited |
Version of this settings schema.
Definition at line 340 of file json_settings.h.
Referenced by JSON_SETTINGS::JSON_SETTINGS(), JSON_SETTINGS::LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::Migrate(), JSON_SETTINGS::registerMigration(), and NESTED_SETTINGS::SaveToFile().
|
protectedinherited |
Whether or not the backing store file should be written.
Definition at line 328 of file json_settings.h.
Referenced by COLOR_SETTINGS::CreateBuiltinColorSettings(), COLOR_SETTINGS::initFromOther(), JSON_SETTINGS::LoadFromFile(), and JSON_SETTINGS::SaveToFile().