KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Attributes | List of all members
PNS::ROUTING_SETTINGS Class Reference

Contain all persistent settings of the router, such as the mode, optimization effort, etc. More...

#include <pns_routing_settings.h>

Inheritance diagram for PNS::ROUTING_SETTINGS:
NESTED_SETTINGS JSON_SETTINGS

Public Member Functions

 ROUTING_SETTINGS (JSON_SETTINGS *aParent, const std::string &aPath)
 Return the routing mode.
 
PNS_MODE Mode () const
 Set the routing mode.
 
void SetMode (PNS_MODE aMode)
 Return the optimizer effort. Bigger means cleaner traces, but slower routing.
 
PNS_OPTIMIZATION_EFFORT OptimizerEffort () const
 Set the optimizer effort. Bigger means cleaner traces, but slower routing.
 
void SetOptimizerEffort (PNS_OPTIMIZATION_EFFORT aEffort)
 Return true if shoving vias is enabled.
 
bool ShoveVias () const
 Enable/disable shoving vias.
 
void SetShoveVias (bool aShoveVias)
 Return true if loop (redundant track) removal is on.
 
bool RemoveLoops () const
 Enable/disable loop (redundant track) removal.
 
void SetRemoveLoops (bool aRemoveLoops)
 Return true if suggesting the finish of currently placed track is on.
 
bool SuggestFinish ()
 Enable displaying suggestions for finishing the currently placed track.
 
void SetSuggestFinish (bool aSuggestFinish)
 Return true if Smart Pads (optimized connections) is enabled.
 
bool SmartPads () const
 Enable/disable Smart Pads (optimized connections).
 
void SetSmartPads (bool aSmartPads)
 Return true if follow mouse mode is active (permanently on for the moment).
 
bool FollowMouse () const
 Return true if smoothing segments during dragging is enabled.
 
bool SmoothDraggedSegments () const
 Enable/disable smoothing segments during dragging.
 
void SetSmoothDraggedSegments (bool aSmooth)
 Return true if jumping over unmovable obstacles is on.
 
bool JumpOverObstacles () const
 
void SetJumpOverObstacles (bool aJump)
 
void SetStartDiagonal (bool aStartDiagonal)
 
bool AllowDRCViolations () const
 
bool GetAllowDRCViolationsSetting () const
 
void SetAllowDRCViolations (bool aViolate)
 
bool GetFreeAngleMode () const
 
void SetFreeAngleMode (bool aEnable)
 
const DIRECTION_45 InitialDirection () const
 
int ShoveIterationLimit () const
 
TIME_LIMIT ShoveTimeLimit () const
 
int WalkaroundIterationLimit () const
 
TIME_LIMIT WalkaroundTimeLimit () const
 
void SetSnapToTracks (bool aSnap)
 
void SetSnapToPads (bool aSnap)
 
bool GetSnapToTracks () const
 
bool GetSnapToPads () const
 
DIRECTION_45::CORNER_MODE GetCornerMode () const
 
void SetCornerMode (DIRECTION_45::CORNER_MODE aMode)
 
bool GetOptimizeEntireDraggedTrack () const
 
void SetOptimizeEntireDraggedTrack (bool aEnable)
 
bool GetAutoPosture () const
 
void SetAutoPosture (bool aEnable)
 
bool GetFixAllSegments () const
 
void SetFixAllSegments (bool aEnable)
 
double WalkaroundHugLengthThreshold () const
 
int ViaForcePropIterationLimit () const
 
void SetViaForcePropIterationLimit (int aLimit)
 
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 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 Attributes

bool m_shoveVias
 
bool m_startDiagonal
 
bool m_removeLoops
 
bool m_smartPads
 
bool m_suggestFinish
 
bool m_followMouse
 
bool m_jumpOverObstacles
 
bool m_smoothDraggedSegments
 
bool m_allowDRCViolations
 
bool m_freeAngleMode
 
bool m_snapToTracks
 
bool m_snapToPads
 
bool m_optimizeEntireDraggedTrack
 
bool m_autoPosture
 
bool m_fixAllSegments
 
DIRECTION_45::CORNER_MODE m_cornerMode
 
PNS_MODE m_routingMode
 
PNS_OPTIMIZATION_EFFORT m_optimizerEffort
 
int m_walkaroundIterationLimit
 
int m_shoveIterationLimit
 
int m_viaForcePropIterationLimit
 
double m_walkaroundHugLengthThreshold
 
TIME_LIMIT m_shoveTimeLimit
 
TIME_LIMIT m_walkaroundTimeLimit
 

Detailed Description

Contain all persistent settings of the router, such as the mode, optimization effort, etc.

Definition at line 58 of file pns_routing_settings.h.

Constructor & Destructor Documentation

◆ ROUTING_SETTINGS()

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

Return the routing mode.

Definition at line 32 of file pns_routing_settings.cpp.

References PNS::TIME_LIMIT::Get(), NESTED_SETTINGS::LoadFromFile(), m_allowDRCViolations, m_autoPosture, m_cornerMode, m_fixAllSegments, m_followMouse, m_freeAngleMode, m_jumpOverObstacles, m_optimizeEntireDraggedTrack, m_optimizerEffort, JSON_SETTINGS::m_params, m_removeLoops, m_routingMode, m_shoveIterationLimit, m_shoveTimeLimit, m_shoveVias, m_smartPads, m_smoothDraggedSegments, m_snapToPads, m_snapToTracks, m_startDiagonal, m_suggestFinish, m_viaForcePropIterationLimit, m_walkaroundHugLengthThreshold, m_walkaroundIterationLimit, DIRECTION_45::MITERED_45, PNS::OE_MEDIUM, PNS::RM_Walkaround, DIRECTION_45::ROUNDED_90, and PNS::TIME_LIMIT::Set().

Member Function Documentation

◆ AddNestedSettings()

void JSON_SETTINGS::AddNestedSettings ( NESTED_SETTINGS *  aSettings)
inherited

Transfers ownership of a given NESTED_SETTINGS to this object.

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

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

Definition at line 870 of file json_settings.cpp.

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

Referenced by NESTED_SETTINGS::SetParent().

◆ AllowDRCViolations()

bool PNS::ROUTING_SETTINGS::AllowDRCViolations ( ) const
inline

Definition at line 117 of file pns_routing_settings.h.

References m_allowDRCViolations, m_routingMode, and PNS::RM_MarkObstacles.

Referenced by DRAWING_TOOL::DrawVia().

◆ At()

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

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

Definition at line 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().

◆ Contains()

bool JSON_SETTINGS::Contains ( const std::string &  aPath) const
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().

◆ fetchOrDefault()

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

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

Template Parameters
ResultTypeis the type of the retrieved value.
Parameters
aJsonis the object to act on .
aKeyis the object key to retrieve the value for.
Returns
the result, or aDefault if aKey is not found.

Definition at line 916 of file json_settings.cpp.

◆ FollowMouse()

bool PNS::ROUTING_SETTINGS::FollowMouse ( ) const
inline

Return true if smoothing segments during dragging is enabled.

Definition at line 100 of file pns_routing_settings.h.

References m_followMouse, Mode(), and PNS::RM_MarkObstacles.

◆ FormatAsString()

const std::string JSON_SETTINGS::FormatAsString ( )
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().

◆ fromLegacy()

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

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

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

Definition at line 782 of file json_settings.cpp.

◆ fromLegacyColor()

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

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

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

Definition at line 842 of file json_settings.cpp.

References color.

Referenced by APP_SETTINGS_BASE::migrateWindowConfig().

◆ fromLegacyString()

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

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

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

Definition at line 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().

◆ Get() [1/2]

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

Definition at line 900 of file json_settings.cpp.

References JSON_SETTINGS::GetJson().

◆ Get() [2/2]

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

Fetches a value from within the JSON document.

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

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

Definition at line 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().

◆ GetAllowDRCViolationsSetting()

bool PNS::ROUTING_SETTINGS::GetAllowDRCViolationsSetting ( ) const
inline

Definition at line 122 of file pns_routing_settings.h.

References m_allowDRCViolations.

Referenced by DIALOG_PNS_SETTINGS::DIALOG_PNS_SETTINGS().

◆ GetAutoPosture()

bool PNS::ROUTING_SETTINGS::GetAutoPosture ( ) const
inline

Definition at line 149 of file pns_routing_settings.h.

References m_autoPosture.

Referenced by DIALOG_PNS_SETTINGS::DIALOG_PNS_SETTINGS().

◆ GetCornerMode()

DIRECTION_45::CORNER_MODE PNS::ROUTING_SETTINGS::GetCornerMode ( ) const
inline

Definition at line 143 of file pns_routing_settings.h.

References m_cornerMode.

Referenced by PNS::LINE_PLACER::buildInitialLine(), PNS::OPTIMIZER::fanoutCleanup(), PNS::OPTIMIZER::mergeStep(), PNS::NODE::NearestObstacle(), PNS::LINE_PLACER::rhMarkObstacles(), PNS::LINE_PLACER::rhShoveOnly(), PNS::LINE_PLACER::rhWalkOnly(), PNS::SHOVE::runOptimizer(), PNS::WALKAROUND::singleStep(), PNS::ROUTER::ToggleCornerMode(), and ROUTER_TOOL::UpdateMessagePanel().

◆ getFileExt()

virtual wxString JSON_SETTINGS::getFileExt ( ) const
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().

◆ GetFilename()

wxString JSON_SETTINGS::GetFilename ( ) const
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_FP_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), and PANEL_PCBNEW_COLOR_SETTINGS::TransferDataFromWindow().

◆ GetFixAllSegments()

bool PNS::ROUTING_SETTINGS::GetFixAllSegments ( ) const
inline

Definition at line 152 of file pns_routing_settings.h.

References m_fixAllSegments.

Referenced by DIALOG_PNS_SETTINGS::DIALOG_PNS_SETTINGS(), and PNS::LINE_PLACER::FixRoute().

◆ GetFreeAngleMode()

bool PNS::ROUTING_SETTINGS::GetFreeAngleMode ( ) const
inline

Definition at line 125 of file pns_routing_settings.h.

References m_freeAngleMode.

Referenced by DIALOG_PNS_SETTINGS::DIALOG_PNS_SETTINGS(), and ROUTER_TOOL::UpdateMessagePanel().

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const
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().

◆ GetJson()

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

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

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

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().

◆ getLegacyFileExt()

virtual wxString JSON_SETTINGS::getLegacyFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 287 of file json_settings.h.

Referenced by JSON_SETTINGS::LoadFromFile().

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 87 of file json_settings.h.

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

◆ GetOptimizeEntireDraggedTrack()

bool PNS::ROUTING_SETTINGS::GetOptimizeEntireDraggedTrack ( ) const
inline

Definition at line 146 of file pns_routing_settings.h.

References m_optimizeEntireDraggedTrack.

Referenced by DIALOG_PNS_SETTINGS::DIALOG_PNS_SETTINGS().

◆ GetParent()

JSON_SETTINGS * NESTED_SETTINGS::GetParent ( )
inlineinherited

Definition at line 54 of file nested_settings.h.

Referenced by BOARD_DESIGN_SETTINGS::LoadFromFile().

◆ GetSnapToPads()

bool PNS::ROUTING_SETTINGS::GetSnapToPads ( ) const
inline

Definition at line 141 of file pns_routing_settings.h.

References m_snapToPads.

Referenced by PNS::TOOL_BASE::checkSnap().

◆ GetSnapToTracks()

bool PNS::ROUTING_SETTINGS::GetSnapToTracks ( ) const
inline

Definition at line 140 of file pns_routing_settings.h.

References m_snapToTracks.

Referenced by PNS::TOOL_BASE::checkSnap().

◆ InitialDirection()

const DIRECTION_45 PNS::ROUTING_SETTINGS::InitialDirection ( ) const

Definition at line 110 of file pns_routing_settings.cpp.

References m_startDiagonal, DIRECTION_45::N, and DIRECTION_45::NE.

◆ Internals()

JSON_SETTINGS_INTERNALS * JSON_SETTINGS::Internals ( )
inherited

Definition at line 130 of file json_settings.cpp.

References JSON_SETTINGS::m_internals.

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

◆ IsReadOnly()

bool JSON_SETTINGS::IsReadOnly ( ) const
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().

◆ JumpOverObstacles()

bool PNS::ROUTING_SETTINGS::JumpOverObstacles ( ) const
inline

Definition at line 112 of file pns_routing_settings.h.

References m_jumpOverObstacles.

Referenced by DIALOG_PNS_SETTINGS::DIALOG_PNS_SETTINGS().

◆ Load()

void JSON_SETTINGS::Load ( )
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(), PCBNEW_SETTINGS::MigrateFromLegacy(), 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().

◆ LoadFromFile()

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

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

Parameters
aDirectory

Reimplemented from JSON_SETTINGS.

Definition at line 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(), ROUTING_SETTINGS(), and NESTED_SETTINGS::SetParent().

◆ LoadFromRawFile()

bool JSON_SETTINGS::LoadFromRawFile ( const wxString &  aPath)
inherited

Definition at line 528 of file json_settings.cpp.

References JSON_SETTINGS::Load(), JSON_SETTINGS::m_internals, and traceSettings.

◆ Migrate()

bool JSON_SETTINGS::Migrate ( )
inherited

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

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

Returns
true if migration was successful

Definition at line 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().

◆ MigrateFromLegacy()

bool JSON_SETTINGS::MigrateFromLegacy ( wxConfigBase *  aLegacyConfig)
virtualinherited

Migrates from wxConfig to JSON-based configuration.

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

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

Reimplemented in 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().

◆ Mode()

PNS_MODE PNS::ROUTING_SETTINGS::Mode ( ) const
inline

Set the routing mode.

Definition at line 64 of file pns_routing_settings.h.

References m_routingMode.

Referenced by PNS::LINE_PLACER::buildInitialLine(), ROUTER_TOOL::CycleRouterMode(), DIALOG_PNS_SETTINGS::DIALOG_PNS_SETTINGS(), PNS::LINE_PLACER::FixRoute(), FollowMouse(), ROUTER_TOOL::GetRouterMode(), PNS::TOOL_BASE::pickSingleItem(), PNS::DRAGGER::Start(), PNS::TOOL_BASE::updateEndItem(), and ROUTER_TOOL::UpdateMessagePanel().

◆ OptimizerEffort()

PNS_OPTIMIZATION_EFFORT PNS::ROUTING_SETTINGS::OptimizerEffort ( ) const
inline

Set the optimizer effort. Bigger means cleaner traces, but slower routing.

Definition at line 70 of file pns_routing_settings.h.

References m_optimizerEffort.

Referenced by PNS::SHOVE::runOptimizer().

◆ registerMigration()

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

Registers a migration from one schema version to another.

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

Parameters
aOldSchemaVersionis the starting schema version for this migration
aNewSchemaVersionis the ending schema version for this migration
aMigratoris 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(), PROJECT_FILE::PROJECT_FILE(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), and SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ ReleaseNestedSettings()

void JSON_SETTINGS::ReleaseNestedSettings ( NESTED_SETTINGS *  aSettings)
inherited

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

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

Definition at line 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::~NET_SETTINGS(), and SCHEMATIC_SETTINGS::~SCHEMATIC_SETTINGS().

◆ RemoveLoops()

bool PNS::ROUTING_SETTINGS::RemoveLoops ( ) const
inline

Enable/disable loop (redundant track) removal.

Definition at line 82 of file pns_routing_settings.h.

References m_removeLoops.

Referenced by DIALOG_PNS_SETTINGS::DIALOG_PNS_SETTINGS().

◆ ResetToDefaults()

void JSON_SETTINGS::ResetToDefaults ( )
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().

◆ SaveToFile()

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

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

Parameters
aDirectoryis ignored
Returns
true if the document contents were updated

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.

◆ Set() [1/3]

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

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

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

Definition at line 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().

◆ Set() [2/3]

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

Definition at line 909 of file json_settings.cpp.

◆ Set() [3/3]

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

◆ SetAllowDRCViolations()

void PNS::ROUTING_SETTINGS::SetAllowDRCViolations ( bool  aViolate)
inline

Definition at line 123 of file pns_routing_settings.h.

References m_allowDRCViolations.

Referenced by DIALOG_PNS_SETTINGS::TransferDataFromWindow().

◆ SetAutoPosture()

void PNS::ROUTING_SETTINGS::SetAutoPosture ( bool  aEnable)
inline

Definition at line 150 of file pns_routing_settings.h.

References m_autoPosture.

Referenced by DIALOG_PNS_SETTINGS::TransferDataFromWindow().

◆ SetCornerMode()

void PNS::ROUTING_SETTINGS::SetCornerMode ( DIRECTION_45::CORNER_MODE  aMode)
inline

Definition at line 144 of file pns_routing_settings.h.

References m_cornerMode.

Referenced by PNS::ROUTER::ToggleCornerMode().

◆ SetFilename()

void JSON_SETTINGS::SetFilename ( const wxString &  aFilename)
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().

◆ SetFixAllSegments()

void PNS::ROUTING_SETTINGS::SetFixAllSegments ( bool  aEnable)
inline

Definition at line 153 of file pns_routing_settings.h.

References m_fixAllSegments.

Referenced by DIALOG_PNS_SETTINGS::TransferDataFromWindow().

◆ SetFreeAngleMode()

void PNS::ROUTING_SETTINGS::SetFreeAngleMode ( bool  aEnable)
inline

Definition at line 127 of file pns_routing_settings.h.

References m_freeAngleMode.

Referenced by DIALOG_PNS_SETTINGS::TransferDataFromWindow().

◆ SetIfPresent() [1/4]

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

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

Parameters
aObjis the source object
aTargetis the storage destination
Returns
True if set, false if not

Definition at line 736 of file json_settings.cpp.

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [2/4]

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

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

Parameters
aObjis the source object
aTargetis the storage destination
Returns
True if set, false if not

Definition at line 751 of file json_settings.cpp.

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [3/4]

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

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

Parameters
aObjis the source object
aTargetis the storage destination
Returns
True if set, false if not

Definition at line 766 of file json_settings.cpp.

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [4/4]

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

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

Parameters
aObjis the source object
aTargetis the storage destination
Returns
True if set, false if not

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().

◆ SetJumpOverObstacles()

void PNS::ROUTING_SETTINGS::SetJumpOverObstacles ( bool  aJump)
inline

Definition at line 113 of file pns_routing_settings.h.

References m_jumpOverObstacles.

Referenced by DIALOG_PNS_SETTINGS::TransferDataFromWindow().

◆ SetLegacyFilename()

void JSON_SETTINGS::SetLegacyFilename ( const wxString &  aFilename)
inlineinherited

Definition at line 89 of file json_settings.h.

Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetLocation()

void JSON_SETTINGS::SetLocation ( SETTINGS_LOC  aLocation)
inlineinherited

Definition at line 86 of file json_settings.h.

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

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER *  aManager)
inlineinherited

Definition at line 198 of file json_settings.h.

◆ SetMode()

void PNS::ROUTING_SETTINGS::SetMode ( PNS_MODE  aMode)
inline

Return the optimizer effort. Bigger means cleaner traces, but slower routing.

Definition at line 67 of file pns_routing_settings.h.

References m_routingMode.

Referenced by ROUTER_TOOL::ChangeRouterMode(), ROUTER_TOOL::CycleRouterMode(), and DIALOG_PNS_SETTINGS::TransferDataFromWindow().

◆ SetOptimizeEntireDraggedTrack()

void PNS::ROUTING_SETTINGS::SetOptimizeEntireDraggedTrack ( bool  aEnable)
inline

Definition at line 147 of file pns_routing_settings.h.

References m_optimizeEntireDraggedTrack.

Referenced by DIALOG_PNS_SETTINGS::TransferDataFromWindow().

◆ SetOptimizerEffort()

void PNS::ROUTING_SETTINGS::SetOptimizerEffort ( PNS_OPTIMIZATION_EFFORT  aEffort)
inline

Return true if shoving vias is enabled.

Definition at line 73 of file pns_routing_settings.h.

References m_optimizerEffort.

◆ SetParent()

void NESTED_SETTINGS::SetParent ( JSON_SETTINGS *  aParent,
bool  aLoadFromFile = true 
)
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().

◆ SetReadOnly()

void JSON_SETTINGS::SetReadOnly ( bool  aReadOnly)
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().

◆ SetRemoveLoops()

void PNS::ROUTING_SETTINGS::SetRemoveLoops ( bool  aRemoveLoops)
inline

Return true if suggesting the finish of currently placed track is on.

Definition at line 85 of file pns_routing_settings.h.

References m_removeLoops.

Referenced by DIALOG_PNS_SETTINGS::TransferDataFromWindow().

◆ SetShoveVias()

void PNS::ROUTING_SETTINGS::SetShoveVias ( bool  aShoveVias)
inline

Return true if loop (redundant track) removal is on.

Definition at line 79 of file pns_routing_settings.h.

References m_shoveVias.

Referenced by DIALOG_PNS_SETTINGS::TransferDataFromWindow().

◆ SetSmartPads()

void PNS::ROUTING_SETTINGS::SetSmartPads ( bool  aSmartPads)
inline

Return true if follow mouse mode is active (permanently on for the moment).

Definition at line 97 of file pns_routing_settings.h.

References m_smartPads.

Referenced by DIALOG_PNS_SETTINGS::TransferDataFromWindow().

◆ SetSmoothDraggedSegments()

void PNS::ROUTING_SETTINGS::SetSmoothDraggedSegments ( bool  aSmooth)
inline

Return true if jumping over unmovable obstacles is on.

Definition at line 109 of file pns_routing_settings.h.

References m_smoothDraggedSegments.

Referenced by DIALOG_PNS_SETTINGS::TransferDataFromWindow().

◆ SetSnapToPads()

void PNS::ROUTING_SETTINGS::SetSnapToPads ( bool  aSnap)
inline

Definition at line 138 of file pns_routing_settings.h.

References m_snapToPads.

Referenced by PNS::TOOL_BASE::checkSnap().

◆ SetSnapToTracks()

void PNS::ROUTING_SETTINGS::SetSnapToTracks ( bool  aSnap)
inline

Definition at line 137 of file pns_routing_settings.h.

References m_snapToTracks.

Referenced by PNS::TOOL_BASE::checkSnap().

◆ SetStartDiagonal()

void PNS::ROUTING_SETTINGS::SetStartDiagonal ( bool  aStartDiagonal)
inline

Definition at line 115 of file pns_routing_settings.h.

References m_startDiagonal.

◆ SetSuggestFinish()

void PNS::ROUTING_SETTINGS::SetSuggestFinish ( bool  aSuggestFinish)
inline

Return true if Smart Pads (optimized connections) is enabled.

Definition at line 91 of file pns_routing_settings.h.

References m_suggestFinish.

Referenced by DIALOG_PNS_SETTINGS::TransferDataFromWindow().

◆ SetViaForcePropIterationLimit()

void PNS::ROUTING_SETTINGS::SetViaForcePropIterationLimit ( int  aLimit)
inline

Definition at line 158 of file pns_routing_settings.h.

References m_viaForcePropIterationLimit.

◆ ShoveIterationLimit()

int PNS::ROUTING_SETTINGS::ShoveIterationLimit ( ) const

Definition at line 125 of file pns_routing_settings.cpp.

References m_shoveIterationLimit.

Referenced by PNS::SHOVE::shoveMainLoop().

◆ ShoveTimeLimit()

TIME_LIMIT PNS::ROUTING_SETTINGS::ShoveTimeLimit ( ) const

Definition at line 119 of file pns_routing_settings.cpp.

References m_shoveTimeLimit.

Referenced by PNS::SHOVE::shoveMainLoop().

◆ ShoveVias()

bool PNS::ROUTING_SETTINGS::ShoveVias ( ) const
inline

Enable/disable shoving vias.

Definition at line 76 of file pns_routing_settings.h.

References m_shoveVias.

Referenced by DIALOG_PNS_SETTINGS::DIALOG_PNS_SETTINGS().

◆ SmartPads()

bool PNS::ROUTING_SETTINGS::SmartPads ( ) const
inline

Enable/disable Smart Pads (optimized connections).

Definition at line 94 of file pns_routing_settings.h.

References m_smartPads.

Referenced by DIALOG_PNS_SETTINGS::DIALOG_PNS_SETTINGS().

◆ SmoothDraggedSegments()

bool PNS::ROUTING_SETTINGS::SmoothDraggedSegments ( ) const
inline

Enable/disable smoothing segments during dragging.

Definition at line 106 of file pns_routing_settings.h.

References m_smoothDraggedSegments.

Referenced by DIALOG_PNS_SETTINGS::DIALOG_PNS_SETTINGS(), PNS::MULTI_DRAGGER::Drag(), PNS::DRAGGER::dragMarkObstacles(), PNS::DRAGGER::dragShove(), and PNS::DRAGGER::dragWalkaround().

◆ Store()

bool JSON_SETTINGS::Store ( )
virtualinherited

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

Returns
true if any part of the JSON document has been updated since the last save to disk

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().

◆ SuggestFinish()

bool PNS::ROUTING_SETTINGS::SuggestFinish ( )
inline

Enable displaying suggestions for finishing the currently placed track.

Definition at line 88 of file pns_routing_settings.h.

References m_suggestFinish.

Referenced by DIALOG_PNS_SETTINGS::DIALOG_PNS_SETTINGS().

◆ ViaForcePropIterationLimit()

int PNS::ROUTING_SETTINGS::ViaForcePropIterationLimit ( ) const
inline

Definition at line 157 of file pns_routing_settings.h.

References m_viaForcePropIterationLimit.

Referenced by PNS::LINE_PLACER::buildInitialLine(), and PNS::DRAGGER::propagateViaForces().

◆ WalkaroundHugLengthThreshold()

double PNS::ROUTING_SETTINGS::WalkaroundHugLengthThreshold ( ) const
inline

Definition at line 155 of file pns_routing_settings.h.

References m_walkaroundHugLengthThreshold.

Referenced by PNS::LINE_PLACER::rhWalkBase().

◆ WalkaroundIterationLimit()

int PNS::ROUTING_SETTINGS::WalkaroundIterationLimit ( ) const
inline

Definition at line 134 of file pns_routing_settings.h.

References m_walkaroundIterationLimit.

Referenced by PNS::WALKAROUND::WALKAROUND().

◆ WalkaroundTimeLimit()

TIME_LIMIT PNS::ROUTING_SETTINGS::WalkaroundTimeLimit ( ) const

Member Data Documentation

◆ m_allowDRCViolations

bool PNS::ROUTING_SETTINGS::m_allowDRCViolations
private

Definition at line 169 of file pns_routing_settings.h.

Referenced by AllowDRCViolations(), GetAllowDRCViolationsSetting(), ROUTING_SETTINGS(), and SetAllowDRCViolations().

◆ m_autoPosture

bool PNS::ROUTING_SETTINGS::m_autoPosture
private

Definition at line 174 of file pns_routing_settings.h.

Referenced by GetAutoPosture(), ROUTING_SETTINGS(), and SetAutoPosture().

◆ m_cornerMode

DIRECTION_45::CORNER_MODE PNS::ROUTING_SETTINGS::m_cornerMode
private

Definition at line 177 of file pns_routing_settings.h.

Referenced by GetCornerMode(), ROUTING_SETTINGS(), and SetCornerMode().

◆ m_createIfDefault

bool JSON_SETTINGS::m_createIfDefault
protectedinherited

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

Ignored if m_createIfMissing is false or m_writeFile is false.

Definition at line 325 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_createIfMissing

bool JSON_SETTINGS::m_createIfMissing
protectedinherited

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

Definition at line 319 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_deleteLegacyAfterMigration

bool JSON_SETTINGS::m_deleteLegacyAfterMigration
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().

◆ m_filename

wxString JSON_SETTINGS::m_filename
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().

◆ m_fixAllSegments

bool PNS::ROUTING_SETTINGS::m_fixAllSegments
private

Definition at line 175 of file pns_routing_settings.h.

Referenced by GetFixAllSegments(), ROUTING_SETTINGS(), and SetFixAllSegments().

◆ m_followMouse

bool PNS::ROUTING_SETTINGS::m_followMouse
private

Definition at line 166 of file pns_routing_settings.h.

Referenced by FollowMouse(), and ROUTING_SETTINGS().

◆ m_freeAngleMode

bool PNS::ROUTING_SETTINGS::m_freeAngleMode
private

Definition at line 170 of file pns_routing_settings.h.

Referenced by GetFreeAngleMode(), ROUTING_SETTINGS(), and SetFreeAngleMode().

◆ m_internals

std::unique_ptr<JSON_SETTINGS_INTERNALS> JSON_SETTINGS::m_internals
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(), NET_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), COMMON_SETTINGS::migrateSchema0to1(), PROJECT_FILE::migrateSchema1To2(), COMMON_SETTINGS::migrateSchema1to2(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema2To3(), NET_SETTINGS::migrateSchema2to3(), NET_SETTINGS::migrateSchema3to4(), JSON_SETTINGS::SaveToFile(), NESTED_SETTINGS::SaveToFile(), and JSON_SETTINGS::Set().

◆ m_jumpOverObstacles

bool PNS::ROUTING_SETTINGS::m_jumpOverObstacles
private

Definition at line 167 of file pns_routing_settings.h.

Referenced by JumpOverObstacles(), ROUTING_SETTINGS(), and SetJumpOverObstacles().

◆ m_legacy_filename

wxString JSON_SETTINGS::m_legacy_filename
protectedinherited

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

Definition at line 307 of file json_settings.h.

Referenced by JSON_SETTINGS::LoadFromFile().

◆ m_location

SETTINGS_LOC JSON_SETTINGS::m_location
protectedinherited

The location of this settings file (.

See also
SETTINGS_LOC)

Definition at line 310 of file json_settings.h.

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager
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().

◆ m_migrators

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

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

Definition at line 346 of file json_settings.h.

Referenced by JSON_SETTINGS::Migrate(), and JSON_SETTINGS::registerMigration().

◆ m_modified

bool JSON_SETTINGS::m_modified
protectedinherited

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

Definition at line 331 of file json_settings.h.

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

◆ m_nested_settings

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

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

Definition at line 316 of file json_settings.h.

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

◆ m_optimizeEntireDraggedTrack

bool PNS::ROUTING_SETTINGS::m_optimizeEntireDraggedTrack
private

Definition at line 173 of file pns_routing_settings.h.

Referenced by GetOptimizeEntireDraggedTrack(), ROUTING_SETTINGS(), and SetOptimizeEntireDraggedTrack().

◆ m_optimizerEffort

PNS_OPTIMIZATION_EFFORT PNS::ROUTING_SETTINGS::m_optimizerEffort
private

Definition at line 180 of file pns_routing_settings.h.

Referenced by OptimizerEffort(), ROUTING_SETTINGS(), and SetOptimizerEffort().

◆ m_params

std::vector<PARAM_BASE*> JSON_SETTINGS::m_params
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(), 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().

◆ m_parent

JSON_SETTINGS* NESTED_SETTINGS::m_parent
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::~NET_SETTINGS(), and SCHEMATIC_SETTINGS::~SCHEMATIC_SETTINGS().

◆ m_path

std::string NESTED_SETTINGS::m_path
protectedinherited

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

Definition at line 65 of file nested_settings.h.

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

◆ m_removeLoops

bool PNS::ROUTING_SETTINGS::m_removeLoops
private

Definition at line 163 of file pns_routing_settings.h.

Referenced by RemoveLoops(), ROUTING_SETTINGS(), and SetRemoveLoops().

◆ m_resetParamsIfMissing

bool JSON_SETTINGS::m_resetParamsIfMissing
protectedinherited

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

Definition at line 337 of file json_settings.h.

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

◆ m_routingMode

PNS_MODE PNS::ROUTING_SETTINGS::m_routingMode
private

Definition at line 179 of file pns_routing_settings.h.

Referenced by AllowDRCViolations(), Mode(), ROUTING_SETTINGS(), and SetMode().

◆ m_schemaVersion

int JSON_SETTINGS::m_schemaVersion
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().

◆ m_shoveIterationLimit

int PNS::ROUTING_SETTINGS::m_shoveIterationLimit
private

Definition at line 183 of file pns_routing_settings.h.

Referenced by ROUTING_SETTINGS(), and ShoveIterationLimit().

◆ m_shoveTimeLimit

TIME_LIMIT PNS::ROUTING_SETTINGS::m_shoveTimeLimit
private

Definition at line 187 of file pns_routing_settings.h.

Referenced by ROUTING_SETTINGS(), and ShoveTimeLimit().

◆ m_shoveVias

bool PNS::ROUTING_SETTINGS::m_shoveVias
private

Definition at line 161 of file pns_routing_settings.h.

Referenced by ROUTING_SETTINGS(), SetShoveVias(), and ShoveVias().

◆ m_smartPads

bool PNS::ROUTING_SETTINGS::m_smartPads
private

Definition at line 164 of file pns_routing_settings.h.

Referenced by ROUTING_SETTINGS(), SetSmartPads(), and SmartPads().

◆ m_smoothDraggedSegments

bool PNS::ROUTING_SETTINGS::m_smoothDraggedSegments
private

Definition at line 168 of file pns_routing_settings.h.

Referenced by ROUTING_SETTINGS(), SetSmoothDraggedSegments(), and SmoothDraggedSegments().

◆ m_snapToPads

bool PNS::ROUTING_SETTINGS::m_snapToPads
private

Definition at line 172 of file pns_routing_settings.h.

Referenced by GetSnapToPads(), ROUTING_SETTINGS(), and SetSnapToPads().

◆ m_snapToTracks

bool PNS::ROUTING_SETTINGS::m_snapToTracks
private

Definition at line 171 of file pns_routing_settings.h.

Referenced by GetSnapToTracks(), ROUTING_SETTINGS(), and SetSnapToTracks().

◆ m_startDiagonal

bool PNS::ROUTING_SETTINGS::m_startDiagonal
private

Definition at line 162 of file pns_routing_settings.h.

Referenced by InitialDirection(), ROUTING_SETTINGS(), and SetStartDiagonal().

◆ m_suggestFinish

bool PNS::ROUTING_SETTINGS::m_suggestFinish
private

Definition at line 165 of file pns_routing_settings.h.

Referenced by ROUTING_SETTINGS(), SetSuggestFinish(), and SuggestFinish().

◆ m_viaForcePropIterationLimit

int PNS::ROUTING_SETTINGS::m_viaForcePropIterationLimit
private

Definition at line 184 of file pns_routing_settings.h.

Referenced by ROUTING_SETTINGS(), SetViaForcePropIterationLimit(), and ViaForcePropIterationLimit().

◆ m_walkaroundHugLengthThreshold

double PNS::ROUTING_SETTINGS::m_walkaroundHugLengthThreshold
private

Definition at line 185 of file pns_routing_settings.h.

Referenced by ROUTING_SETTINGS(), and WalkaroundHugLengthThreshold().

◆ m_walkaroundIterationLimit

int PNS::ROUTING_SETTINGS::m_walkaroundIterationLimit
private

Definition at line 182 of file pns_routing_settings.h.

Referenced by ROUTING_SETTINGS(), and WalkaroundIterationLimit().

◆ m_walkaroundTimeLimit

TIME_LIMIT PNS::ROUTING_SETTINGS::m_walkaroundTimeLimit
private

Definition at line 188 of file pns_routing_settings.h.

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile
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().

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