KiCad PCB EDA Suite
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. More...
 
PNS_MODE Mode () const
 Set the routing mode. More...
 
void SetMode (PNS_MODE aMode)
 Return the optimizer effort. Bigger means cleaner traces, but slower routing. More...
 
PNS_OPTIMIZATION_EFFORT OptimizerEffort () const
 Set the optimizer effort. Bigger means cleaner traces, but slower routing. More...
 
void SetOptimizerEffort (PNS_OPTIMIZATION_EFFORT aEffort)
 Return true if shoving vias is enabled. More...
 
bool ShoveVias () const
 Enable/disable shoving vias. More...
 
void SetShoveVias (bool aShoveVias)
 Return true if loop (redundant track) removal is on. More...
 
bool RemoveLoops () const
 Enable/disable loop (redundant track) removal. More...
 
void SetRemoveLoops (bool aRemoveLoops)
 Return true if suggesting the finish of currently placed track is on. More...
 
bool SuggestFinish ()
 Enable displaying suggestions for finishing the currently placed track. More...
 
void SetSuggestFinish (bool aSuggestFinish)
 Return true if Smart Pads (optimized connections) is enabled. More...
 
bool SmartPads () const
 Enable/disable Smart Pads (optimized connections). More...
 
void SetSmartPads (bool aSmartPads)
 Return true if follow mouse mode is active (permanently on for the moment). More...
 
bool FollowMouse () const
 Return true if smoothing segments during dragging is enabled. More...
 
bool SmoothDraggedSegments () const
 Enable/disable smoothing segments during dragging. More...
 
void SetSmoothDraggedSegments (bool aSmooth)
 Return true if jumping over unmovable obstacles is on. More...
 
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
 
bool LoadFromFile (const wxString &aDirectory="") override
 Loads the JSON document from the parent and then calls Load() More...
 
bool SaveToFile (const wxString &aDirectory="", bool aForce=false) override
 Calls Store() and then saves the JSON document contents into the parent JSON_SETTINGS. More...
 
void SetParent (JSON_SETTINGS *aParent, bool aLoadFromFile=true)
 
JSON_SETTINGSGetParent ()
 
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::jsonAt (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. More...
 
bool Contains (const std::string &aPath) const
 
size_t Count (const std::string &aPath) const
 
JSON_SETTINGS_INTERNALSInternals ()
 
virtual void Load ()
 Updates the parameters of this object based on the current JSON document contents. More...
 
virtual bool Store ()
 Stores the current parameters into the JSON document represented by this object Note: this doesn't do any writing to disk; that's handled by SETTINGS_MANAGER. More...
 
void ResetToDefaults ()
 Resets all parameters to default values. More...
 
OPT< nlohmann::jsonGetJson (const std::string &aPath) const
 Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1.key2.key3" to refer to nested objects. More...
 
template<typename ValueType >
OPT< ValueType > Get (const std::string &aPath) const
 Fetches a value from within the JSON document. More...
 
template<>
OPT< wxString > Get (const std::string &aPath) const
 
template<typename ValueType >
void Set (const std::string &aPath, ValueType aVal)
 Stores a value into the JSON document Will throw an exception if ValueType isn't something that the library can handle. More...
 
template<>
void Set (const std::string &aPath, wxString aVal)
 
template<>
void Set (const std::string &aPath, wxString aVal)
 
bool Migrate ()
 Migrates the schema of this settings from the version in the file to the latest version. More...
 
virtual bool MigrateFromLegacy (wxConfigBase *aLegacyConfig)
 Migrates from wxConfig to JSON-based configuration. More...
 
void AddNestedSettings (NESTED_SETTINGS *aSettings)
 Transfers ownership of a given NESTED_SETTINGS to this object. More...
 
void ReleaseNestedSettings (NESTED_SETTINGS *aSettings)
 Saves and frees a nested settings object, if it exists within this one. More...
 
void SetManager (SETTINGS_MANAGER *aManager)
 

Static Public Member Functions

static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, wxString &aTarget)
 Sets the given string if the given key/path is present. More...
 
static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, bool &aTarget)
 Sets the given bool if the given key/path is present. More...
 
static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, int &aTarget)
 Sets the given int if the given key/path is present. More...
 
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. More...
 

Protected Member Functions

void registerMigration (int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
 Registers a migration from one schema version to another. More...
 
template<typename ValueType >
bool fromLegacy (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy wxConfig value to a given JSON pointer value. More...
 
bool fromLegacyString (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy wxConfig string value to a given JSON pointer value. More...
 
bool fromLegacyColor (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy COLOR4D stored in a wxConfig string to a given JSON pointer value. More...
 
virtual wxString getFileExt () const
 
virtual wxString getLegacyFileExt () const
 

Protected Attributes

JSON_SETTINGSm_parent
 A pointer to the parent object to load and store from. More...
 
std::string m_path
 The path (in pointer format) of where to store this document in the parent. More...
 
wxString m_filename
 The filename (not including path) of this settings file (inicode) More...
 
wxString m_legacy_filename
 The filename of the wxConfig legacy file (if different from m_filename) More...
 
SETTINGS_LOC m_location
 The location of this settings file (. More...
 
std::vector< PARAM_BASE * > m_params
 The list of parameters (owned by this object) More...
 
std::vector< NESTED_SETTINGS * > m_nested_settings
 Nested settings files that live inside this one, if any. More...
 
bool m_createIfMissing
 Whether or not the backing store file should be created it if doesn't exist. More...
 
bool m_createIfDefault
 Whether or not the backing store file should be created if all parameters are still at their default values. More...
 
bool m_writeFile
 Whether or not the backing store file should be written. More...
 
bool m_deleteLegacyAfterMigration
 Whether or not to delete legacy file after migration. More...
 
bool m_resetParamsIfMissing
 Whether or not to set parameters to their default value if missing from JSON on Load() More...
 
int m_schemaVersion
 Version of this settings schema. More...
 
SETTINGS_MANAGERm_manager
 A pointer to the settings manager managing this file (may be null) More...
 
std::map< int, std::pair< int, std::function< bool()> > > m_migrators
 A map of starting schema version to a pair of <ending version, migrator function> More...
 
std::unique_ptr< JSON_SETTINGS_INTERNALSm_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
 
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.

32 :
33 NESTED_SETTINGS( "pns", pnsSchemaVersion, aParent, aPath )
34{
37 m_removeLoops = true;
38 m_smartPads = true;
39 m_shoveVias = true;
40 m_suggestFinish = false;
41 m_followMouse = true;
42 m_startDiagonal = false;
44 m_shoveTimeLimit = 1000;
46 m_jumpOverObstacles = false;
49 m_freeAngleMode = false;
50 m_snapToTracks = false;
51 m_snapToPads = false;
53 m_cornerMode = DIRECTION_45::CORNER_MODE::MITERED_45;
55 m_autoPosture = true;
56 m_fixAllSegments = true;
57
58 m_params.emplace_back( new PARAM<int>( "mode", reinterpret_cast<int*>( &m_routingMode ),
59 static_cast<int>( RM_Walkaround ) ) );
60
61 m_params.emplace_back( new PARAM<int>( "effort", reinterpret_cast<int*>( &m_optimizerEffort ),
62 static_cast<int>( OE_MEDIUM ) ) );
63
64 m_params.emplace_back( new PARAM<bool>( "remove_loops", &m_removeLoops, true ) );
65 m_params.emplace_back( new PARAM<bool>( "smart_pads", &m_smartPads, true ) );
66 m_params.emplace_back( new PARAM<bool>( "shove_vias", &m_shoveVias, true ) );
67 m_params.emplace_back( new PARAM<bool>( "suggest_finish", &m_suggestFinish, false ) );
68 m_params.emplace_back( new PARAM<bool>( "follow_mouse", &m_followMouse, true ) );
69 m_params.emplace_back( new PARAM<bool>( "start_diagonal", &m_startDiagonal, false ) );
70 m_params.emplace_back( new PARAM<int>( "shove_iteration_limit", &m_shoveIterationLimit, 250 ) );
71
72 m_params.emplace_back( new PARAM_LAMBDA<int>( "shove_time_limit",
73 [this] () -> int
74 {
75 return m_shoveTimeLimit.Get();
76 },
77 [this] ( int aVal )
78 {
79 m_shoveTimeLimit.Set( aVal );
80 },
81 1000 ) );
82
83 m_params.emplace_back( new PARAM<int>( "walkaround_iteration_limit", &m_walkaroundIterationLimit, 40 ) );
84 m_params.emplace_back( new PARAM<bool>( "jump_over_obstacles", &m_jumpOverObstacles, false ) );
85
86 m_params.emplace_back( new PARAM<bool>( "smooth_dragged_segments", &m_smoothDraggedSegments, true ) );
87
88 m_params.emplace_back( new PARAM<bool>( "can_violate_drc", &m_allowDRCViolations, false ) );
89 m_params.emplace_back( new PARAM<bool>( "free_angle_mode", &m_freeAngleMode, false ) );
90 m_params.emplace_back( new PARAM<bool>( "snap_to_tracks", &m_snapToTracks, false ) );
91 m_params.emplace_back( new PARAM<bool>( "snap_to_pads", &m_snapToPads, false ) );
92 m_params.emplace_back( new PARAM<bool>( "optimize_dragged_track",
94
95 m_params.emplace_back( new PARAM<bool>( "auto_posture", &m_autoPosture, true ) );
96 m_params.emplace_back( new PARAM<bool>( "fix_all_segments", &m_fixAllSegments, true ) );
97
99 "corner_mode", &m_cornerMode, DIRECTION_45::CORNER_MODE::MITERED_45,
100 DIRECTION_45::CORNER_MODE::ROUNDED_90, DIRECTION_45::CORNER_MODE::MITERED_45 ) );
101
102 m_params.emplace_back( new PARAM<double>( "walkaround_hug_length_threshold", &m_walkaroundHugLengthThreshold, 1.5 ) );
103
104 LoadFromFile();
105}
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
friend class NESTED_SETTINGS
Definition: json_settings.h:61
bool LoadFromFile(const wxString &aDirectory="") override
Loads the JSON document from the parent and then calls Load()
Stores an enum as an integer.
Definition: parameters.h:216
Like a normal param, but with custom getter and setter functions.
Definition: parameters.h:281
DIRECTION_45::CORNER_MODE m_cornerMode
PNS_OPTIMIZATION_EFFORT m_optimizerEffort
void Set(int aMilliseconds)
Definition: time_limit.cpp:51
int Get() const
Definition: time_limit.h:39
@ RM_Walkaround
Only walk around.
const int pnsSchemaVersion

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_walkaroundHugLengthThreshold, m_walkaroundIterationLimit, PNS::OE_MEDIUM, PNS::RM_Walkaround, 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 743 of file json_settings.cpp.

744{
745 wxLogTrace( traceSettings, wxT( "AddNestedSettings %s" ), aSettings->GetFilename() );
746 m_nested_settings.push_back( aSettings );
747}
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
wxString GetFilename() const
Definition: json_settings.h:72
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.

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.

118 {
120 }
@ RM_MarkObstacles
Ignore collisions, mark obstacles.

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 111 of file json_settings.cpp.

112{
113 return m_internals->At( aPath );
114}
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals

References JSON_SETTINGS::m_internals.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), EESCHEMA_SETTINGS::migrateBomSettings(), GERBVIEW_SETTINGS::MigrateFromLegacy(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().

◆ Contains()

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

◆ Count()

size_t JSON_SETTINGS::Count ( const std::string &  aPath) const
inherited

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

◆ fromLegacy()

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

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

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

Definition at line 655 of file json_settings.cpp.

657{
658 ValueType val;
659
660 if( aConfig->Read( aKey, &val ) )
661 {
662 try
663 {
664 ( *m_internals )[aDest] = val;
665 }
666 catch( ... )
667 {
668 wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
669 return false;
670 }
671
672 return true;
673 }
674
675 return false;
676}

◆ 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 715 of file json_settings.cpp.

717{
718 wxString str;
719
720 if( aConfig->Read( aKey, &str ) )
721 {
723 color.SetFromWxString( str );
724
725 try
726 {
727 nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
728 ( *m_internals )[aDest] = js;
729 }
730 catch( ... )
731 {
732 wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
733 return false;
734 }
735
736 return true;
737 }
738
739 return false;
740}
int color
Definition: DXF_plotter.cpp:57
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
nlohmann::json json
Definition: gerbview.cpp:43

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 691 of file json_settings.cpp.

693{
694 wxString str;
695
696 if( aConfig->Read( aKey, &str ) )
697 {
698 try
699 {
700 ( *m_internals )[aDest] = str.ToUTF8();
701 }
702 catch( ... )
703 {
704 wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
705 return false;
706 }
707
708 return true;
709 }
710
711 return false;
712}

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<>
OPT< wxString > JSON_SETTINGS::Get ( const std::string &  aPath) const
inherited

Definition at line 773 of file json_settings.cpp.

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

References JSON_SETTINGS::GetJson(), and NULLOPT.

◆ Get() [2/2]

template<typename ValueType >
template OPT< unsigned long long > JSON_SETTINGS::Get< unsigned long long > ( 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 494 of file json_settings.cpp.

495{
496 if( OPT<nlohmann::json> ret = GetJson( aPath ) )
497 {
498 try
499 {
500 return ret->get<ValueType>();
501 }
502 catch( ... )
503 {
504 }
505 }
506
507 return NULLOPT;
508}

References JSON_SETTINGS::GetJson(), and NULLOPT.

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

◆ GetAutoPosture()

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

Definition at line 149 of file pns_routing_settings.h.

149{ return m_autoPosture; }

References m_autoPosture.

Referenced by DIALOG_PNS_SETTINGS::DIALOG_PNS_SETTINGS().

◆ GetCornerMode()

◆ getFileExt()

virtual wxString JSON_SETTINGS::getFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 270 of file json_settings.h.

271 {
272 return wxT( "json" );
273 }

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

◆ GetFilename()

◆ GetFixAllSegments()

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

◆ GetFreeAngleMode()

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

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const
inherited

Definition at line 105 of file json_settings.cpp.

106{
107 return wxString( m_filename + "." + getFileExt() );
108}
virtual wxString getFileExt() const

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

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

◆ GetJson()

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

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

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

Definition at line 474 of file json_settings.cpp.

475{
476 nlohmann::json::json_pointer ptr = m_internals->PointerFromString( aPath );
477
478 if( m_internals->contains( ptr ) )
479 {
480 try
481 {
482 return OPT<nlohmann::json>{ m_internals->at( ptr ) };
483 }
484 catch( ... )
485 {
486 }
487 }
488
489 return OPT<nlohmann::json>{};
490}

References JSON_SETTINGS::m_internals.

Referenced by JSON_SETTINGS::Get(), PARAM_LAMBDA< ValueType >::Load(), PARAM_LIST< Type >::Load(), PARAM_MAP< Value >::Load(), PARAM_WXSTRING_MAP::Load(), PARAM_LAMBDA< ValueType >::MatchesFile(), PARAM_LIST< 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 275 of file json_settings.h.

276 {
277 return wxEmptyString;
278 }

Referenced by JSON_SETTINGS::LoadFromFile().

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 79 of file json_settings.h.

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

References JSON_SETTINGS::m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ GetOptimizeEntireDraggedTrack()

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

◆ GetParent()

JSON_SETTINGS * NESTED_SETTINGS::GetParent ( void  )
inlineinherited

Definition at line 54 of file nested_settings.h.

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

References NESTED_SETTINGS::m_parent.

Referenced by BOARD_DESIGN_SETTINGS::LoadFromFile().

◆ GetSnapToPads()

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

Definition at line 141 of file pns_routing_settings.h.

141{ return m_snapToPads; }

References m_snapToPads.

◆ GetSnapToTracks()

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

Definition at line 140 of file pns_routing_settings.h.

140{ return m_snapToTracks; }

References m_snapToTracks.

◆ InitialDirection()

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

Definition at line 108 of file pns_routing_settings.cpp.

109{
110 if( m_startDiagonal )
112 else
114}
Represent route directions & corner angles in a 45-degree metric.
Definition: direction45.h:37

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

◆ Internals()

JSON_SETTINGS_INTERNALS * JSON_SETTINGS::Internals ( )
inherited

Definition at line 129 of file json_settings.cpp.

130{
131 return m_internals.get();
132}

References JSON_SETTINGS::m_internals.

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

◆ IsReadOnly()

◆ JumpOverObstacles()

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

Definition at line 112 of file pns_routing_settings.h.

112{ return m_jumpOverObstacles; }

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 135 of file json_settings.cpp.

136{
137 for( auto param : m_params )
138 {
139 try
140 {
141 param->Load( this, m_resetParamsIfMissing );
142 }
143 catch( ... )
144 {
145 // Skip unreadable parameters in file
146 wxLogTrace( traceSettings, wxT( "param '%s' load err" ), param->GetJsonPath().c_str() );
147 }
148 }
149}
bool m_resetParamsIfMissing
Whether or not to set parameters to their default value if missing from JSON on Load()

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(), 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_DISPLAY_OPTIONS::ResetPanel(), PANEL_EDIT_OPTIONS::ResetPanel(), PANEL_FP_EDITOR_DEFAULTS::ResetPanel(), PANEL_PCBNEW_DISPLAY_ORIGIN::ResetPanel(), and SETTINGS_MANAGER::SaveColorSettings().

◆ 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 42 of file nested_settings.cpp.

43{
44 m_internals->clear();
45 bool success = false;
46
47 if( m_parent )
48 {
49 nlohmann::json::json_pointer ptr = m_internals->PointerFromString( m_path );
50
51 if( m_parent->m_internals->contains( ptr ) )
52 {
53 try
54 {
55 m_internals->update( m_parent->m_internals->at( ptr ) );
56
57 wxLogTrace( traceSettings, wxT( "Loaded NESTED_SETTINGS %s" ), GetFilename() );
58
59 success = true;
60 }
61 catch( ... )
62 {
63 wxLogTrace( traceSettings, wxT( "NESTED_SETTINGS %s: Could not load from %s at %s" ),
65 }
66 }
67 }
68
69 if( success )
70 {
71 int filever = -1;
72
73 try
74 {
75 filever = m_internals->Get<int>( "meta.version" );
76 }
77 catch( ... )
78 {
79 wxLogTrace( traceSettings, wxT( "%s: nested settings version could not be read!" ),
80 m_filename );
81 success = false;
82 }
83
84 if( filever >= 0 && filever < m_schemaVersion )
85 {
86 wxLogTrace( traceSettings, wxT( "%s: attempting migration from version %d to %d" ),
87 m_filename, filever, m_schemaVersion );
88
89 if( !Migrate() )
90 {
91 wxLogTrace( traceSettings, wxT( "%s: migration failed!" ), GetFullFilename() );
92 success = false;
93 }
94 }
95 else if( filever > m_schemaVersion )
96 {
97 wxLogTrace( traceSettings,
98 wxT( "%s: warning: nested settings version %d is newer than latest (%d)" ),
99 m_filename, filever, m_schemaVersion );
100 }
101 else if( filever >= 0 )
102 {
103 wxLogTrace( traceSettings, wxT( "%s: schema version %d is current" ),
104 m_filename, filever );
105 }
106 }
107
108 Load();
109
110 return success;
111}
virtual void Load()
Updates the parameters of this object based on the current JSON document contents.
wxString GetFullFilename() const
bool Migrate()
Migrates the schema of this settings from the version in the file to the latest version.
int m_schemaVersion
Version of this settings schema.
std::string m_path
The path (in pointer format) of where to store this document in the parent.

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

◆ 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 552 of file json_settings.cpp.

553{
554 int filever = m_internals->Get<int>( "meta.version" );
555
556 while( filever < m_schemaVersion )
557 {
558 if( !m_migrators.count( filever ) )
559 {
560 wxLogTrace( traceSettings, wxT( "Migrator missing for %s version %d!" ),
561 typeid( *this ).name(), filever );
562 return false;
563 }
564
565 std::pair<int, std::function<bool()>> pair = m_migrators.at( filever );
566
567 if( pair.second() )
568 {
569 wxLogTrace( traceSettings, wxT( "Migrated %s from %d to %d" ), typeid( *this ).name(),
570 filever, pair.first );
571 filever = pair.first;
572 m_internals->At( "meta.version" ) = filever;
573 }
574 else
575 {
576 wxLogTrace( traceSettings, wxT( "Migration failed for %s from %d to %d" ),
577 typeid( *this ).name(), filever, pair.first );
578 return false;
579 }
580 }
581
582 return true;
583}
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>

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 586 of file json_settings.cpp.

587{
588 wxLogTrace( traceSettings,
589 wxT( "MigrateFromLegacy() not implemented for %s" ), typeid( *this ).name() );
590 return false;
591}

References traceSettings.

Referenced by JSON_SETTINGS::LoadFromFile().

◆ Mode()

◆ 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 543 of file json_settings.cpp.

545{
546 wxASSERT( aNewSchemaVersion > aOldSchemaVersion );
547 wxASSERT( aNewSchemaVersion <= m_schemaVersion );
548 m_migrators[aOldSchemaVersion] = std::make_pair( aNewSchemaVersion, aMigrator );
549}

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(), NET_SETTINGS::NET_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), and SCHEMATIC_SETTINGS::SCHEMATIC_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 750 of file json_settings.cpp.

751{
752 if( !aSettings )
753 return;
754
755 auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
756 [&aSettings]( const JSON_SETTINGS* aPtr ) {
757 return aPtr == aSettings;
758 } );
759
760 if( it != m_nested_settings.end() )
761 {
762 wxLogTrace( traceSettings, wxT( "Flush and release %s" ), ( *it )->GetFilename() );
763 ( *it )->SaveToFile();
764 m_nested_settings.erase( it );
765 }
766
767 aSettings->SetParent( nullptr );
768}
void SetParent(JSON_SETTINGS *aParent, bool aLoadFromFile=true)

References 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(), and ROUTER_TOOL::saveRouterDebugLog().

◆ ResetToDefaults()

void JSON_SETTINGS::ResetToDefaults ( )
inherited

Resets all parameters to default values.

Does NOT write to file or update underlying JSON.

Definition at line 367 of file json_settings.cpp.

368{
369 for( auto param : m_params )
370 param->SetDefault();
371}

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 114 of file nested_settings.cpp.

115{
116 if( !m_parent )
117 return false;
118
119 try
120 {
121 bool modified = Store();
122
123 auto jsonObjectInParent = m_parent->GetJson( m_path );
124
125 if( !jsonObjectInParent )
126 modified = true;
127 else if( !nlohmann::json::diff( *m_internals, jsonObjectInParent.value() ).empty() )
128 modified = true;
129
130 if( modified || aForce )
131 {
132 ( *m_parent->m_internals )[m_path].update( *m_internals );
133
134 wxLogTrace( traceSettings, "Stored NESTED_SETTINGS %s with schema %d",
135 GetFilename(),
137 }
138
139 return modified;
140 }
141 catch( ... )
142 {
143 wxLogTrace( traceSettings, "NESTED_SETTINGS %s: Could not store to %s at %s",
146 m_path );
147
148 return false;
149 }
150}
virtual bool Store()
Stores the current parameters into the JSON document represented by this object Note: this doesn't do...

References 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 void JSON_SETTINGS::Set< const char * > ( 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 524 of file json_settings.cpp.

525{
526 m_internals->SetFromString( aPath, aVal );
527}

References JSON_SETTINGS::m_internals.

Referenced by COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_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_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 782 of file json_settings.cpp.

783{
784 ( *m_internals )[aPath] = aVal.ToUTF8();
785}

◆ Set() [3/3]

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

◆ SetAllowDRCViolations()

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

◆ SetAutoPosture()

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

Definition at line 150 of file pns_routing_settings.h.

150{ m_autoPosture = aEnable; }

References m_autoPosture.

Referenced by DIALOG_PNS_SETTINGS::OnOkClick().

◆ SetCornerMode()

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

Definition at line 144 of file pns_routing_settings.h.

144{ m_cornerMode = aMode; }

References m_cornerMode.

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

◆ SetFilename()

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

◆ SetFixAllSegments()

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

Definition at line 153 of file pns_routing_settings.h.

153{ m_fixAllSegments = aEnable; }

References m_fixAllSegments.

Referenced by DIALOG_PNS_SETTINGS::OnOkClick().

◆ SetFreeAngleMode()

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

Definition at line 127 of file pns_routing_settings.h.

127{ m_freeAngleMode = aEnable; }

References m_freeAngleMode.

Referenced by DIALOG_PNS_SETTINGS::onModeChange(), and DIALOG_PNS_SETTINGS::OnOkClick().

◆ 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 609 of file json_settings.cpp.

611{
612 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
613
614 if( aObj.contains( ptr ) && aObj.at( ptr ).is_boolean() )
615 {
616 aTarget = aObj.at( ptr ).get<bool>();
617 return true;
618 }
619
620 return false;
621}

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 624 of file json_settings.cpp.

626{
627 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
628
629 if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_integer() )
630 {
631 aTarget = aObj.at( ptr ).get<int>();
632 return true;
633 }
634
635 return false;
636}

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 639 of file json_settings.cpp.

641{
642 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
643
644 if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_unsigned() )
645 {
646 aTarget = aObj.at( ptr ).get<unsigned int>();
647 return true;
648 }
649
650 return false;
651}

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 594 of file json_settings.cpp.

596{
597 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
598
599 if( aObj.contains( ptr ) && aObj.at( ptr ).is_string() )
600 {
601 aTarget = aObj.at( ptr ).get<wxString>();
602 return true;
603 }
604
605 return false;
606}

References JSON_SETTINGS_INTERNALS::PointerFromString().

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

◆ SetJumpOverObstacles()

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

Definition at line 113 of file pns_routing_settings.h.

113{ m_jumpOverObstacles = aJump; }

References m_jumpOverObstacles.

Referenced by DIALOG_PNS_SETTINGS::OnOkClick().

◆ SetLegacyFilename()

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

Definition at line 81 of file json_settings.h.

81{ m_legacy_filename = aFilename; }
wxString m_legacy_filename
The filename of the wxConfig legacy file (if different from m_filename)

References JSON_SETTINGS::m_legacy_filename.

Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetLocation()

void JSON_SETTINGS::SetLocation ( SETTINGS_LOC  aLocation)
inlineinherited

Definition at line 78 of file json_settings.h.

78{ m_location = aLocation; }

References JSON_SETTINGS::m_location.

Referenced by COLOR_SETTINGS::COLOR_SETTINGS().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER aManager)
inlineinherited

Definition at line 191 of file json_settings.h.

192 {
193 m_manager = aManager;
194 }
SETTINGS_MANAGER * m_manager
A pointer to the settings manager managing this file (may be null)

References JSON_SETTINGS::m_manager.

◆ 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::OnOkClick().

◆ SetOptimizeEntireDraggedTrack()

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

Definition at line 147 of file pns_routing_settings.h.

147{ m_optimizeEntireDraggedTrack = aEnable; }

References m_optimizeEntireDraggedTrack.

Referenced by DIALOG_PNS_SETTINGS::OnOkClick().

◆ 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 153 of file nested_settings.cpp.

154{
155 m_parent = aParent;
156
157 if( m_parent )
158 {
160
161 // In case we were created after the parent's ctor
162 if( aLoadFromFile )
163 LoadFromFile();
164 }
165}
void AddNestedSettings(NESTED_SETTINGS *aSettings)
Transfers ownership of a given NESTED_SETTINGS to this object.

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

◆ 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::OnOkClick().

◆ 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::OnOkClick().

◆ 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::OnOkClick().

◆ 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::OnOkClick().

◆ SetSnapToPads()

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

Definition at line 138 of file pns_routing_settings.h.

138{ m_snapToPads = aSnap; }

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.

137{ m_snapToTracks = aSnap; }

References m_snapToTracks.

◆ SetStartDiagonal()

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

Definition at line 115 of file pns_routing_settings.h.

115{ m_startDiagonal = aStartDiagonal; }

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

◆ ShoveIterationLimit()

int PNS::ROUTING_SETTINGS::ShoveIterationLimit ( ) const

Definition at line 123 of file pns_routing_settings.cpp.

124{
126}

References m_shoveIterationLimit.

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

◆ ShoveTimeLimit()

TIME_LIMIT PNS::ROUTING_SETTINGS::ShoveTimeLimit ( ) const

Definition at line 117 of file pns_routing_settings.cpp.

118{
119 return TIME_LIMIT ( m_shoveTimeLimit );
120}

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::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 was updated

Definition at line 353 of file json_settings.cpp.

354{
355 bool modified = false;
356
357 for( auto param : m_params )
358 {
359 modified |= !param->MatchesFile( this );
360 param->Store( this );
361 }
362
363 return modified;
364}

References JSON_SETTINGS::m_params.

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

◆ WalkaroundHugLengthThreshold()

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

◆ WalkaroundIterationLimit()

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

Definition at line 134 of file pns_routing_settings.h.

References m_walkaroundIterationLimit.

◆ WalkaroundTimeLimit()

TIME_LIMIT PNS::ROUTING_SETTINGS::WalkaroundTimeLimit ( ) const

Member Data Documentation

◆ m_allowDRCViolations

bool PNS::ROUTING_SETTINGS::m_allowDRCViolations
private

◆ m_autoPosture

bool PNS::ROUTING_SETTINGS::m_autoPosture
private

Definition at line 171 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 174 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 302 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 296 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 308 of file json_settings.h.

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

◆ m_filename

◆ m_fixAllSegments

bool PNS::ROUTING_SETTINGS::m_fixAllSegments
private

Definition at line 172 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 163 of file pns_routing_settings.h.

Referenced by FollowMouse(), and ROUTING_SETTINGS().

◆ m_freeAngleMode

bool PNS::ROUTING_SETTINGS::m_freeAngleMode
private

Definition at line 167 of file pns_routing_settings.h.

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

◆ m_internals

◆ m_jumpOverObstacles

bool PNS::ROUTING_SETTINGS::m_jumpOverObstacles
private

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

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

◆ m_location

SETTINGS_LOC JSON_SETTINGS::m_location
protectedinherited

The location of this settings file (.

See also
SETTINGS_LOC)

Definition at line 287 of file json_settings.h.

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

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager
protectedinherited

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

Definition at line 317 of file json_settings.h.

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

◆ m_migrators

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

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

Definition at line 320 of file json_settings.h.

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

◆ 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 293 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

◆ m_optimizerEffort

PNS_OPTIMIZATION_EFFORT PNS::ROUTING_SETTINGS::m_optimizerEffort
private

Definition at line 177 of file pns_routing_settings.h.

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

◆ m_params

◆ m_parent

◆ m_path

std::string NESTED_SETTINGS::m_path
protectedinherited

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

Definition at line 65 of file nested_settings.h.

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

◆ m_removeLoops

bool PNS::ROUTING_SETTINGS::m_removeLoops
private

Definition at line 160 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 311 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 176 of file pns_routing_settings.h.

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

◆ m_schemaVersion

int JSON_SETTINGS::m_schemaVersion
protectedinherited

◆ m_shoveIterationLimit

int PNS::ROUTING_SETTINGS::m_shoveIterationLimit
private

Definition at line 180 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 183 of file pns_routing_settings.h.

Referenced by ROUTING_SETTINGS(), and ShoveTimeLimit().

◆ m_shoveVias

bool PNS::ROUTING_SETTINGS::m_shoveVias
private

Definition at line 158 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 161 of file pns_routing_settings.h.

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

◆ m_smoothDraggedSegments

bool PNS::ROUTING_SETTINGS::m_smoothDraggedSegments
private

◆ m_snapToPads

bool PNS::ROUTING_SETTINGS::m_snapToPads
private

Definition at line 169 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 168 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 159 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 162 of file pns_routing_settings.h.

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

◆ m_walkaroundHugLengthThreshold

double PNS::ROUTING_SETTINGS::m_walkaroundHugLengthThreshold
private

Definition at line 181 of file pns_routing_settings.h.

Referenced by ROUTING_SETTINGS(), and WalkaroundHugLengthThreshold().

◆ m_walkaroundIterationLimit

int PNS::ROUTING_SETTINGS::m_walkaroundIterationLimit
private

Definition at line 179 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 184 of file pns_routing_settings.h.

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile
protectedinherited

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