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 Calling user is responsible for resetting the effective netclass calculation caches. | |
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 Calling user is responsible for resetting the effective netclass calculation caches. | |
void | SetNetclasses (const std::map< wxString, std::shared_ptr< NETCLASS > > &netclasses) |
Sets all netclass Calling this method will reset the effective netclass calculation caches. | |
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 Calling this method will reset the effective netclass calculation caches. | |
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 Calling user is responsible for resetting the effective netclass calculation caches. | |
void | ClearNetclassLabelAssignment (const wxString &netName) |
Clears a specific net name to netclass assignment Calling user is responsible for resetting the effective netclass calculation caches. | |
void | SetNetclassLabelAssignment (const wxString &netName, const std::set< wxString > &netclasses) |
Sets a net name to netclasses assignment Calling user is responsible for resetting the effective netclass calculation caches. | |
void | AppendNetclassLabelAssignment (const wxString &netName, const std::set< wxString > &netclasses) |
Apppends to a net name to netclasses assignment Calling user is responsible for resetting the effective netclass calculation caches. | |
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 Calling this method will reset the effective netclass calculation caches. | |
void | SetNetclassPatternAssignments (std::vector< std::pair< std::unique_ptr< EDA_COMBINED_MATCHER >, wxString > > &&netclassPatterns) |
Sets all netclass pattern assignments Calling user is responsible for resetting the effective netclass calculation caches. | |
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 () |
Clears the effective netclass cache for all nets. | |
void | SetNetColorAssignment (const wxString &netName, const KIGFX::COLOR4D &color) |
Sets a net to color assignment Calling user is responsible for resetting the effective netclass calculation caches. | |
const std::map< wxString, KIGFX::COLOR4D > & | GetNetColorAssignments () const |
Gets all net name to color assignments. | |
void | ClearNetColorAssignments () |
Clears all net name to color assignments Calling user is responsible for resetting the effective netclass calculation caches. | |
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 Called when a value of a user-defined netclass changes, but the whole netclass list is not being recomputed. | |
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<> | |
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 | 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. | |
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 () |
bool | migrateSchema1to2 () |
bool | migrateSchema2to3 () |
bool | migrateSchema3to4 () |
bool | migrateSchema4to5 () |
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 63 of file net_settings.cpp.
References _, color, CTX_NETCLASS, NETCLASS::Default, getInPcbUnits(), getInSchUnits(), JSON_SETTINGS::JSON_SETTINGS(), m_defaultNetClass, m_netClasses, m_netClassLabelAssignments, m_netClassPatternAssignments, m_netColorAssignments, JSON_SETTINGS::m_params, migrateSchema0to1(), migrateSchema1to2(), migrateSchema2to3(), migrateSchema3to4(), migrateSchema4to5(), name, NESTED_SETTINGS::NESTED_SETTINGS(), netSettingsSchemaVersion, pcbIUScale, JSON_SETTINGS::registerMigration(), and schIUScale.
Referenced by operator!=(), and operator==().
|
virtual |
Definition at line 339 of file net_settings.cpp.
References NESTED_SETTINGS::m_parent.
|
private |
Adds any missing fields to the given netclass from the default netclass.
Definition at line 941 of file net_settings.cpp.
References NETCLASS::HasBusWidth(), NETCLASS::HasClearance(), NETCLASS::HasDelayProfile(), 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::SetDelayProfile(), NETCLASS::SetDelayProfileParent(), 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 907 of file json_settings.cpp.
References GetFilename(), m_nested_settings, NESTED_SETTINGS, and traceSettings.
void NET_SETTINGS::AppendNetclassLabelAssignment | ( | const wxString & | netName, |
const std::set< wxString > & | netclasses ) |
Apppends to a net name to netclasses assignment Calling user is responsible for resetting the effective netclass calculation caches.
Definition at line 566 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 119 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(), GERBVIEW_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::migrateLibTreeWidth(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), and FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1().
void NET_SETTINGS::ClearAllCaches | ( | ) |
Clears the effective netclass cache for all nets.
Definition at line 629 of file net_settings.cpp.
References m_compositeNetClasses, and m_effectiveNetclassCache.
Referenced by ClearNetclasses(), SetNetclasses(), SetNetclassPatternAssignment(), SetNetclassPatternAssignments(), and BOARD::SynchronizeNetsAndNetClasses().
void NET_SETTINGS::ClearCacheForNet | ( | const wxString & | netName | ) |
Clears effective netclass cache for the given net.
Definition at line 618 of file net_settings.cpp.
References m_compositeNetClasses, and m_effectiveNetclassCache.
void NET_SETTINGS::ClearNetclasses | ( | ) |
Clears all netclasses Calling this method will reset the effective netclass calculation caches.
Definition at line 533 of file net_settings.cpp.
References ClearAllCaches(), m_impicitNetClasses, and m_netClasses.
Referenced by PCB_CONTROL::AppendBoard().
void NET_SETTINGS::ClearNetclassLabelAssignment | ( | const wxString & | netName | ) |
Clears a specific net name to netclass assignment Calling user is responsible for resetting the effective netclass calculation caches.
Definition at line 553 of file net_settings.cpp.
References m_netClassLabelAssignments.
void NET_SETTINGS::ClearNetclassLabelAssignments | ( | ) |
Clears all net name to netclasses assignments Calling user is responsible for resetting the effective netclass calculation caches.
Definition at line 547 of file net_settings.cpp.
References m_netClassLabelAssignments.
void NET_SETTINGS::ClearNetclassPatternAssignments | ( | ) |
Clears all netclass pattern assignments.
Definition at line 612 of file net_settings.cpp.
References m_netClassPatternAssignments.
void NET_SETTINGS::ClearNetColorAssignments | ( | ) |
Clears all net name to color assignments Calling user is responsible for resetting the effective netclass calculation caches.
Definition at line 648 of file net_settings.cpp.
References m_netColorAssignments.
|
inherited |
Definition at line 125 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(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_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 955 of file json_settings.cpp.
|
inherited |
Definition at line 538 of file json_settings.cpp.
References dummy, m_internals, and Store().
|
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 816 of file json_settings.cpp.
Referenced by APP_SETTINGS_BASE::MigrateFromLegacy(), BITMAP2CMP_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), CVPCB_SETTINGS::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), KICAD_SETTINGS::MigrateFromLegacy(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), PL_EDITOR_SETTINGS::MigrateFromLegacy(), PROJECT_FILE::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), and APP_SETTINGS_BASE::migrateWindowConfig().
|
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 879 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 855 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(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), and APP_SETTINGS_BASE::migrateWindowConfig().
|
inherited |
Definition at line 938 of file json_settings.cpp.
References 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 603 of file json_settings.cpp.
References GetJson().
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(), 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(), COMMON_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::migrateLibTreeWidth(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), PROJECT_FILE::SaveAs(), and SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS().
|
inherited |
References KICOMMON_API.
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 660 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 527 of file net_settings.cpp.
References m_compositeNetClasses.
Referenced by DRC_ENGINE::loadImplicitRules().
std::shared_ptr< NETCLASS > NET_SETTINGS::GetDefaultNetclass | ( | ) |
Gets the default netclass for the project.
Definition at line 496 of file net_settings.cpp.
References m_defaultNetClass.
Referenced by BOARD::BOARD(), EVT_GRID_CMD_CELL_CHANGED(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), BOARD_CONNECTED_ITEM::GetEffectiveNetClass(), SCH_EDIT_FRAME::GetSchematicJunctionSize(), PCB_IO_EASYEDA::LoadBoard(), PCB_IO_EAGLE::loadClasses(), CADSTAR_PCB_ARCHIVE_LOADER::loadDesignRules(), DRC_ENGINE::loadImplicitRules(), PCB_IO_KICAD_LEGACY::loadSETUP(), NETINFO_ITEM::NETINFO_ITEM(), PCB_IO_KICAD_SEXPR_PARSER::parseSetup(), BOARD::SynchronizeNetsAndNetClasses(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), BOARD_EDITOR_CONTROL::ViaSizeDec(), and BOARD_EDITOR_CONTROL::ViaSizeInc().
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 666 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.
Referenced by BOARD::SynchronizeNetsAndNetClasses().
|
inlineprotectedvirtualinherited |
Reimplemented in DATABASE_LIB_SETTINGS, HTTP_LIB_SETTINGS, JOBSET, PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.
Definition at line 291 of file json_settings.h.
Referenced by GetFullFilename(), LoadFromFile(), and SaveToFile().
|
virtualinherited |
Reimplemented in GERBVIEW_SETTINGS.
Definition at line 400 of file json_settings.cpp.
References Contains(), and GetJson().
Referenced by GERBVIEW_SETTINGS::GetFileHistories().
|
inlineinherited |
Definition at line 87 of file json_settings.h.
References m_filename.
Referenced by AddNestedSettings(), 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().
|
inherited |
Definition at line 110 of file json_settings.cpp.
References getFileExt(), and m_filename.
Referenced by JSON_SETTINGS(), LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), and SaveToFile().
|
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 583 of file json_settings.cpp.
References m_internals.
Referenced by 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(), and SETTINGS_MANAGER::SaveColorSettings().
|
inlineprotectedvirtualinherited |
Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.
Definition at line 296 of file json_settings.h.
Referenced by LoadFromFile().
|
inlineinherited |
Definition at line 94 of file json_settings.h.
References m_location.
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 1035 of file net_settings.cpp.
References m_defaultNetClass, and m_netClasses.
const std::map< wxString, std::shared_ptr< NETCLASS > > & NET_SETTINGS::GetNetclasses | ( | ) | const |
Gets all netclasses.
Definition at line 521 of file net_settings.cpp.
References m_netClasses.
Referenced by DRC_ENGINE::loadImplicitRules().
const std::map< wxString, std::set< wxString > > & NET_SETTINGS::GetNetclassLabelAssignments | ( | ) | const |
Gets all current net name to netclasses assignments.
Definition at line 541 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 606 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 642 of file net_settings.cpp.
References m_netColorAssignments.
|
inlineinherited |
Definition at line 54 of file nested_settings.h.
References JSON_SETTINGS::JSON_SETTINGS(), and m_parent.
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 654 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 502 of file net_settings.cpp.
References m_netClasses.
Referenced by PANEL_SETUP_RULES::checkPlausibility().
bool NET_SETTINGS::HasNetclassLabelAssignment | ( | const wxString & | netName | ) | const |
Determines if a given net name has netclasses assigned.
Definition at line 573 of file net_settings.cpp.
References m_netClassLabelAssignments.
|
inherited |
Definition at line 131 of file json_settings.cpp.
References m_internals.
Referenced by COLOR_SETTINGS::migrateSchema0to1(), and SETTINGS_MANAGER::SaveColorSettings().
|
inlineinherited |
Definition at line 98 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().
|
virtualinherited |
Updates the parameters of this object based on the current JSON document contents.
Definition at line 137 of file json_settings.cpp.
References m_params, m_resetParamsIfMissing, and traceSettings.
Referenced by COLOR_SETTINGS::CreateBuiltinColorSettings(), BOARD_DESIGN_SETTINGS::LoadFromFile(), LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), LoadFromRawFile(), PCB_TEST_FRAME_BASE::LoadSettings(), PCBNEW_SETTINGS::MigrateFromLegacy(), COLOR_SETTINGS::migrateSchema0to1(), PANEL_3D_DISPLAY_OPTIONS::ResetPanel(), PANEL_3D_OPENGL_OPTIONS::ResetPanel(), PANEL_3D_RAYTRACING_OPTIONS::ResetPanel(), PANEL_DISPLAY_OPTIONS::ResetPanel(), PANEL_EDIT_OPTIONS::ResetPanel(), PANEL_EESCHEMA_DISPLAY_OPTIONS::ResetPanel(), PANEL_EESCHEMA_EDITING_OPTIONS::ResetPanel(), PANEL_FP_EDITOR_FIELD_DEFAULTS::ResetPanel(), PANEL_FP_EDITOR_GRAPHICS_DEFAULTS::ResetPanel(), PANEL_GERBVIEW_DISPLAY_OPTIONS::ResetPanel(), PANEL_PCBNEW_DISPLAY_ORIGIN::ResetPanel(), PANEL_PL_EDITOR_DISPLAY_OPTIONS::ResetPanel(), PANEL_SYM_DISPLAY_OPTIONS::ResetPanel(), PANEL_SYM_EDITING_OPTIONS::ResetPanel(), and SETTINGS_MANAGER::SaveColorSettings().
|
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, m_parent, 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 SetParent().
|
inherited |
Definition at line 551 of file json_settings.cpp.
References Load(), 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 815 of file net_settings.cpp.
References addMissingDefaults(), NETCLASS::GetBusWidth(), NETCLASS::GetClearance(), NETCLASS::GetDelayProfile(), 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::HasDelayProfile(), NETCLASS::HasDiffPairGap(), NETCLASS::HasDiffPairViaGap(), NETCLASS::HasDiffPairWidth(), NETCLASS::HasLineStyle(), NETCLASS::HasTrackWidth(), NETCLASS::HasuViaDiameter(), NETCLASS::HasuViaDrill(), NETCLASS::HasViaDiameter(), NETCLASS::HasViaDrill(), NETCLASS::HasWireWidth(), m_defaultNetClass, and COLOR4D::UNSPECIFIED.
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 706 of file json_settings.cpp.
References m_internals, m_migrators, m_schemaVersion, and traceSettings.
Referenced by 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 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 747 of file json_settings.cpp.
References traceSettings.
Referenced by LoadFromFile().
|
private |
Definition at line 375 of file net_settings.cpp.
References ConvertToNewOverbarNotation(), and JSON_SETTINGS::m_internals.
Referenced by NET_SETTINGS().
|
private |
Definition at line 397 of file net_settings.cpp.
Referenced by NET_SETTINGS().
|
private |
Definition at line 403 of file net_settings.cpp.
References JSON_SETTINGS::m_internals.
Referenced by NET_SETTINGS().
|
private |
Definition at line 436 of file net_settings.cpp.
References NETCLASS::Default, and JSON_SETTINGS::m_internals.
Referenced by NET_SETTINGS().
|
private |
Definition at line 475 of file net_settings.cpp.
References JSON_SETTINGS::m_internals.
Referenced by NET_SETTINGS().
|
inline |
Definition at line 47 of file net_settings.h.
References NET_SETTINGS(), and operator==().
bool NET_SETTINGS::operator== | ( | const NET_SETTINGS & | aOther | ) | const |
Definition at line 350 of file net_settings.cpp.
References m_netClasses, m_netClassLabelAssignments, m_netClassPatternAssignments, m_netColorAssignments, and NET_SETTINGS().
|
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 1183 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 1052 of file net_settings.cpp.
References end, 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 Called when a value of a user-defined netclass changes, but the whole netclass list is not being recomputed.
Definition at line 792 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 697 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(), NET_SETTINGS::NET_SETTINGS(), PROJECT_FILE::PROJECT_FILE(), 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 914 of file json_settings.cpp.
References JSON_SETTINGS(), m_manager, m_modified, m_nested_settings, NESTED_SETTINGS, NESTED_SETTINGS::SetParent(), and traceSettings.
Referenced by SCHEMATIC_SETTINGS::~SCHEMATIC_SETTINGS().
|
inherited |
Resets all parameters to default values.
Does NOT write to file or update underlying JSON.
Definition at line 393 of file json_settings.cpp.
References m_params.
Referenced by PANEL_COMMON_SETTINGS::ResetPanel(), PANEL_MAINTENANCE::ResetPanel(), PANEL_MOUSE_SETTINGS::ResetPanel(), and PANEL_SPACEMOUSE::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::m_filename, JSON_SETTINGS::m_internals, m_parent, m_path, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS::Store(), and traceSettings.
Referenced by SCH_EDIT_FRAME::saveProjectSettings(), and SIMULATOR_FRAME::SaveSettings().
|
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 658 of file json_settings.cpp.
References m_internals.
Referenced by BITMAP2CMP_SETTINGS::BITMAP2CMP_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), JSON_SETTINGS::Set< KIGFX::COLOR4D >(), JSON_SETTINGS::Set< KIGFX::CROSS_HAIR_MODE >(), JSON_SETTINGS::Set< nlohmann::json >(), JSON_SETTINGS::Set< std::string >(), BOARD_DESIGN_SETTINGS::LoadFromFile(), APP_SETTINGS_BASE::migrateFindReplace(), APP_SETTINGS_BASE::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), KICAD_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), PROJECT_FILE::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), 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_ENUM< EnumType >::Store(), PARAM_LAMBDA< ValueType >::Store(), PARAM_LIST< Type >::Store(), PARAM_MAP< Value >::Store(), PARAM_PATH::Store(), PARAM_PATH_LIST::Store(), PARAM_SCALED< ValueType >::Store(), PARAM_SET< Type >::Store(), and PARAM_WXSTRING_MAP::Store().
|
inherited |
Definition at line 948 of file json_settings.cpp.
|
inherited |
References KICOMMON_API.
void NET_SETTINGS::SetDefaultNetclass | ( | std::shared_ptr< NETCLASS > | netclass | ) |
Sets the default netclass for the project Calling user is responsible for resetting the effective netclass calculation caches.
Definition at line 490 of file net_settings.cpp.
References m_defaultNetClass.
Referenced by BOARD::BOARD().
|
inlineinherited |
Definition at line 91 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().
|
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 770 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 785 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 800 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 755 of file json_settings.cpp.
References JSON_SETTINGS_INTERNALS::PointerFromString().
Referenced by PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), and SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().
|
inlineinherited |
Definition at line 96 of file json_settings.h.
References m_legacy_filename.
Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().
|
inlineinherited |
Definition at line 93 of file json_settings.h.
References m_location.
Referenced by COLOR_SETTINGS::COLOR_SETTINGS(), and COLOR_SETTINGS::migrateSchema0to1().
|
inlineinherited |
Definition at line 207 of file json_settings.h.
References m_manager.
void NET_SETTINGS::SetNetclass | ( | const wxString & | netclassName, |
std::shared_ptr< NETCLASS > & | netclass ) |
Sets the given netclass Calling user is responsible for resetting the effective netclass calculation caches.
Definition at line 508 of file net_settings.cpp.
References m_netClasses.
Referenced by PCB_IO_EAGLE::loadClasses().
void NET_SETTINGS::SetNetclasses | ( | const std::map< wxString, std::shared_ptr< NETCLASS > > & | netclasses | ) |
Sets all netclass Calling this method will reset the effective netclass calculation caches.
Definition at line 514 of file net_settings.cpp.
References ClearAllCaches(), and m_netClasses.
void NET_SETTINGS::SetNetclassLabelAssignment | ( | const wxString & | netName, |
const std::set< wxString > & | netclasses ) |
Sets a net name to netclasses assignment Calling user is responsible for resetting the effective netclass calculation caches.
Definition at line 559 of file net_settings.cpp.
References m_netClassLabelAssignments.
void NET_SETTINGS::SetNetclassPatternAssignment | ( | const wxString & | pattern, |
const wxString & | netclass ) |
Sets a netclass pattern assignment Calling this method will reset the effective netclass calculation caches.
Definition at line 579 of file net_settings.cpp.
References ClearAllCaches(), CTX_NETCLASS, and m_netClassPatternAssignments.
Referenced by PCB_IO_EAGLE::loadSignals().
void NET_SETTINGS::SetNetclassPatternAssignments | ( | std::vector< std::pair< std::unique_ptr< EDA_COMBINED_MATCHER >, wxString > > && | netclassPatterns | ) |
Sets all netclass pattern assignments Calling user is responsible for resetting the effective netclass calculation caches.
Definition at line 597 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 Calling user is responsible for resetting the effective netclass calculation caches.
Definition at line 636 of file net_settings.cpp.
References color, and m_netColorAssignments.
|
inherited |
Definition at line 169 of file nested_settings.cpp.
References JSON_SETTINGS::JSON_SETTINGS(), LoadFromFile(), and m_parent.
Referenced by BOARD::ClearProject(), NESTED_SETTINGS(), and JSON_SETTINGS::ReleaseNestedSettings().
|
inlineinherited |
Definition at line 99 of file json_settings.h.
References m_writeFile.
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 381 of file json_settings.cpp.
References m_modified, and m_params.
Referenced by FormatAsString(), PANEL_FP_EDITOR_COLOR_SETTINGS::PANEL_FP_EDITOR_COLOR_SETTINGS(), SETTINGS_MANAGER::SaveColorSettings(), SaveToFile(), and NESTED_SETTINGS::SaveToFile().
|
private |
Map of netclass names to netclass definitions for.
Definition at line 223 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 334 of file json_settings.h.
Referenced by JSON_SETTINGS(), and SaveToFile().
|
protectedinherited |
Whether or not the backing store file should be created it if doesn't exist.
Definition at line 328 of file json_settings.h.
Referenced by JSON_SETTINGS(), and SaveToFile().
|
private |
The default netclass.
Definition at line 209 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 343 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 234 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 313 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().
|
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 231 of file net_settings.h.
Referenced by ClearNetclasses(), and GetEffectiveNetClass().
|
protectedinherited |
Definition at line 360 of file json_settings.h.
Referenced by At(), Contains(), FormatAsString(), GetJson(), Internals(), JSON_SETTINGS(), LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), LoadFromRawFile(), Migrate(), COMMON_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), COLOR_SETTINGS::migrateSchema0to1(), COMMON_SETTINGS::migrateSchema0to1(), EDA_3D_VIEWER_SETTINGS::migrateSchema0to1(), NET_SETTINGS::migrateSchema0to1(), PROJECT_FILE::migrateSchema1To2(), COMMON_SETTINGS::migrateSchema1to2(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema2To3(), PROJECT_FILE::migrateSchema2To3(), NET_SETTINGS::migrateSchema2to3(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema3To4(), COMMON_SETTINGS::migrateSchema3to4(), NET_SETTINGS::migrateSchema3to4(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema4To5(), NET_SETTINGS::migrateSchema4to5(), SaveToFile(), NESTED_SETTINGS::SaveToFile(), and Set().
|
protectedinherited |
Set to true if this settings is loaded from a file with a newer schema version than is known.
Definition at line 352 of file json_settings.h.
Referenced by JSON_SETTINGS(), LoadFromFile(), PROJECT_FILE::ShouldAutoSave(), and PROJECT_LOCAL_SETTINGS::ShouldAutoSave().
|
protectedinherited |
The filename of the wxConfig legacy file (if different from m_filename)
Definition at line 316 of file json_settings.h.
Referenced by JSON_SETTINGS(), LoadFromFile(), and SetLegacyFilename().
|
protectedinherited |
The location of this settings file (.
Definition at line 319 of file json_settings.h.
Referenced by GetLocation(), JSON_SETTINGS(), and SetLocation().
|
protectedinherited |
A pointer to the settings manager managing this file (may be null)
Definition at line 355 of file json_settings.h.
Referenced by JSON_SETTINGS(), COLOR_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), ReleaseNestedSettings(), and SetManager().
|
protectedinherited |
A map of starting schema version to a pair of <ending version, migrator function>
Definition at line 358 of file json_settings.h.
Referenced by Migrate(), and registerMigration().
|
protectedinherited |
True if the JSON data store has been written to since the last file write.
Definition at line 340 of file json_settings.h.
Referenced by JSON_SETTINGS(), LoadFromFile(), ReleaseNestedSettings(), SaveToFile(), and Store().
|
protectedinherited |
Nested settings files that live inside this one, if any.
Definition at line 325 of file json_settings.h.
Referenced by AddNestedSettings(), LoadFromFile(), ReleaseNestedSettings(), and SaveToFile().
|
private |
Map of netclass names to netclass definitions.
Definition at line 212 of file net_settings.h.
Referenced by ClearNetclasses(), GetEffectiveNetClass(), GetNetClassByName(), GetNetclasses(), HasNetclass(), NET_SETTINGS(), operator==(), SetNetclass(), and SetNetclasses().
|
private |
Map of net names to resolved netclasses.
Definition at line 215 of file net_settings.h.
Referenced by AppendNetclassLabelAssignment(), ClearNetclassLabelAssignment(), ClearNetclassLabelAssignments(), GetEffectiveNetClass(), GetNetclassLabelAssignments(), HasNetclassLabelAssignment(), NET_SETTINGS(), operator==(), and SetNetclassLabelAssignment().
|
private |
List of net class pattern assignments.
Definition at line 219 of file net_settings.h.
Referenced by ClearNetclassPatternAssignments(), GetEffectiveNetClass(), GetNetclassPatternAssignments(), NET_SETTINGS(), 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 242 of file net_settings.h.
Referenced by ClearNetColorAssignments(), GetNetColorAssignments(), NET_SETTINGS(), operator==(), and SetNetColorAssignment().
|
protectedinherited |
The list of parameters (owned by this object)
Definition at line 322 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(), COMPONENT_CLASS_SETTINGS::COMPONENT_CLASS_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(), 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(), SaveToFile(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), SPICE_SETTINGS::SPICE_SETTINGS(), Store(), SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS(), TIME_DOMAIN_PARAMETERS::TIME_DOMAIN_PARAMETERS(), TOOLBAR_SETTINGS::TOOLBAR_SETTINGS(), and ~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 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(), ~NESTED_SETTINGS(), NET_SETTINGS::~NET_SETTINGS(), SCHEMATIC_SETTINGS::~SCHEMATIC_SETTINGS(), and TIME_DOMAIN_PARAMETERS::~TIME_DOMAIN_PARAMETERS().
|
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 BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), LoadFromFile(), NESTED_SETTINGS(), and SaveToFile().
|
protectedinherited |
Whether or not to set parameters to their default value if missing from JSON on Load()
Definition at line 346 of file json_settings.h.
Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), JSON_SETTINGS(), and Load().
|
protectedinherited |
Version of this settings schema.
Definition at line 349 of file json_settings.h.
Referenced by JSON_SETTINGS(), LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), Migrate(), registerMigration(), and NESTED_SETTINGS::SaveToFile().
|
protectedinherited |
Whether or not the backing store file should be written.
Definition at line 337 of file json_settings.h.
Referenced by COLOR_SETTINGS::CreateBuiltinColorSettings(), COLOR_SETTINGS::initFromOther(), IsReadOnly(), JSON_SETTINGS(), LoadFromFile(), SaveToFile(), and SetReadOnly().