KiCad PCB EDA Suite
PNS::ROUTING_SETTINGS Class Reference

ROUTING_SETTINGS. 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)
 
PNS_MODE Mode () const
 

Returns the routing mode.

More...
 
void SetMode (PNS_MODE aMode)
 

Sets the routing mode.

More...
 
PNS_OPTIMIZATION_EFFORT OptimizerEffort () const
 

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

More...
 
void SetOptimizerEffort (PNS_OPTIMIZATION_EFFORT aEffort)
 

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

More...
 
bool ShoveVias () const
 

Returns true if shoving vias is enbled.

More...
 
void SetShoveVias (bool aShoveVias)
 

Enables/disables shoving vias.

More...
 
bool RemoveLoops () const
 

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

More...
 
void SetRemoveLoops (bool aRemoveLoops)
 

Enables/disables loop (redundant track) removal.

More...
 
bool SuggestFinish ()
 

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

More...
 
void SetSuggestFinish (bool aSuggestFinish)
 

Enables displaying suggestions for finishing the currently placed track.

More...
 
bool SmartPads () const
 

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

More...
 
void SetSmartPads (bool aSmartPads)
 

Enables/disables Smart Pads (optimized connections).

More...
 
bool FollowMouse () const
 

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

More...
 
bool SmoothDraggedSegments () const
 

Returns true if smoothing segments durign dragging is enabled.

More...
 
void SetSmoothDraggedSegments (bool aSmooth)
 

Enables/disabled smoothing segments during dragging.

More...
 
bool JumpOverObstacles () const
 

Returns true if jumping over unmovable obstacles is on.

More...
 
void SetJumpOverObstacles (bool aJumpOverObstacles)
 

Enables/disables jumping over unmovable obstacles.

More...
 
void SetStartDiagonal (bool aStartDiagonal)
 
bool CanViolateDRC () const
 
void SetCanViolateDRC (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 SetInlineDragEnabled (bool aEnable)
 
bool InlineDragEnabled () const
 
void SetSnapToTracks (bool aSnap)
 
void SetSnapToPads (bool aSnap)
 
bool GetSnapToTracks () const
 
bool GetSnapToPads () const
 
bool GetRounded () const
 
void SetRounded (bool aRound)
 
bool GetOptimizeDraggedTrack () const
 
void SetOptimizeDraggedTrack (bool aEnable)
 
void SetMinRadius (int aRadius)
 
void SetMaxRadius (int aRadius)
 
int GetMinRadius () const
 
int GetMaxRadius () const
 
virtual void LoadFromFile (const std::string &aDirectory="") override
 Loads the JSON document from the parent and then calls Load() More...
 
virtual void SaveToFile (const std::string &aDirectory="") override
 Calls Store() and then saves the JSON document contents into the parent JSON_SETTINGS. More...
 
std::string GetFilename () const
 
SETTINGS_LOC GetLocation () const
 
void SetLegacyFilename (const std::string &aFilename)
 
virtual void Load ()
 Updates the parameters of this object based on the current JSON document contents. More...
 
virtual void 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 (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 (std::string aPath) const
 Fetches a value from within the JSON document. More...
 
template<>
OPT< wxString > Get (std::string aPath) const
 
template<typename ValueType >
void Set (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 (std::string aPath, wxString aVal)
 
template<>
void Set (std::string aPath, wxString aVal)
 
virtual 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...
 

Static Public Member Functions

static nlohmann::json::json_pointer PointerFromString (std::string aPath)
 Builds a JSON pointer based on a given string. More...
 

Protected Member Functions

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

Protected Attributes

std::string m_filename
 The filename (not including path) of this settings file. More...
 
std::string 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_writeFile
 Whether or not the backing store file should be written. More...
 
int m_schemaVersion
 Version of this settings schema. More...
 
std::vector< nlohmann::json::json_pointer > m_preserved_paths
 A list of JSON pointers that are preserved during a read-update-write to disk. More...
 

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_canViolateDRC
 
bool m_freeAngleMode
 
bool m_inlineDragEnabled
 
bool m_snapToTracks
 
bool m_snapToPads
 
bool m_roundedCorners
 
bool m_optimizeDraggedTrack
 
int m_minRadius
 
int m_maxRadius
 
PNS_MODE m_routingMode
 
PNS_OPTIMIZATION_EFFORT m_optimizerEffort
 
int m_walkaroundIterationLimit
 
int m_shoveIterationLimit
 
TIME_LIMIT m_shoveTimeLimit
 
TIME_LIMIT m_walkaroundTimeLimit
 

Detailed Description

ROUTING_SETTINGS.

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

Definition at line 59 of file pns_routing_settings.h.

Constructor & Destructor Documentation

◆ ROUTING_SETTINGS()

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

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;
48  m_canViolateDRC = false;
49  m_freeAngleMode = false;
50  m_inlineDragEnabled = false;
51  m_snapToTracks = false;
52  m_snapToPads = false;
54  m_minRadius = 0;
55  m_maxRadius = 1000000;
56  m_roundedCorners = false;
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", [this] () -> int {
73  return m_shoveTimeLimit.Get();
74  }, [this] ( int aVal ) {
75  m_shoveTimeLimit.Set( aVal );
76  }, 1000 ) );
77 
78  m_params.emplace_back(
79  new PARAM<int>( "walkaround_iteration_limit", &m_walkaroundIterationLimit, 40 ) );
80  m_params.emplace_back( new PARAM<bool>( "jump_over_obstacles", &m_jumpOverObstacles, false ) );
81 
82  m_params.emplace_back(
83  new PARAM<bool>( "smooth_dragged_segments", &m_smoothDraggedSegments, true ) );
84 
85  m_params.emplace_back( new PARAM<bool>( "can_violate_drc", &m_canViolateDRC, false ) );
86  m_params.emplace_back( new PARAM<bool>( "free_angle_mode", &m_freeAngleMode, false ) );
87  m_params.emplace_back( new PARAM<bool>( "inline_drag", &m_inlineDragEnabled, false ) );
88  m_params.emplace_back( new PARAM<bool>( "snap_to_tracks", &m_snapToTracks, false ) );
89  m_params.emplace_back( new PARAM<bool>( "snap_to_pads", &m_snapToPads, false ) );
90  m_params.emplace_back( new PARAM<bool>( "optimize_dragged_track", &m_optimizeDraggedTrack, true ) );
91 
92  m_params.emplace_back( new PARAM<int>( "min_radius", &m_minRadius, 0 ) );
93  m_params.emplace_back( new PARAM<int>( "max_radius", &m_maxRadius, 1000000 ) );
94  m_params.emplace_back( new PARAM<bool>( "use_rounded", &m_roundedCorners, false ) );
95 
96  LoadFromFile();
97 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
Like a normal param, but with custom getter and setter functions.
Definition: parameters.h:127
void Set(int aMilliseconds)
Definition: time_limit.cpp:51
PNS_OPTIMIZATION_EFFORT m_optimizerEffort
NESTED_SETTINGS(const std::string &aName, int aSchemaVersion, JSON_SETTINGS *aParent, const std::string &aPath, nlohmann::json aDefault=nlohmann::json({}))
const int pnsSchemaVersion
virtual void LoadFromFile(const std::string &aDirectory="") override
Loads the JSON document from the parent and then calls Load()
int Get() const
Definition: time_limit.h:39

References PNS::TIME_LIMIT::Get(), NESTED_SETTINGS::LoadFromFile(), m_canViolateDRC, m_followMouse, m_freeAngleMode, m_inlineDragEnabled, m_jumpOverObstacles, m_maxRadius, m_minRadius, m_optimizeDraggedTrack, m_optimizerEffort, JSON_SETTINGS::m_params, m_removeLoops, m_roundedCorners, m_routingMode, m_shoveIterationLimit, m_shoveTimeLimit, m_shoveVias, m_smartPads, m_smoothDraggedSegments, m_snapToPads, m_snapToTracks, m_startDiagonal, m_suggestFinish, 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 383 of file json_settings.cpp.

384 {
385  wxLogTrace( traceSettings, "AddNestedSettings %s", aSettings->GetFilename() );
386  m_nested_settings.push_back( aSettings );
387 }
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
std::string GetFilename() const
Definition: json_settings.h:55
const char * traceSettings
Flag to enable settings tracing.

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

Referenced by NESTED_SETTINGS::NESTED_SETTINGS().

◆ CanViolateDRC()

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

Definition at line 120 of file pns_routing_settings.h.

References m_canViolateDRC.

Referenced by DIALOG_PNS_SETTINGS::DIALOG_PNS_SETTINGS().

◆ FollowMouse()

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

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

Definition at line 101 of file pns_routing_settings.h.

102  {
103  return m_followMouse && !( Mode() == RM_MarkObstacles );
104  }
PNS_MODE Mode() const
Returns the routing mode.

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

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

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

297 {
298  ValueType val;
299 
300  if( aConfig->Read( aKey, &val ) )
301  {
302  try
303  {
304  ( *this )[PointerFromString( aDest )] = val;
305  }
306  catch( ... )
307  {
308  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
309  return false;
310  }
311 
312  return true;
313  }
314 
315  return false;
316 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

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

357 {
358  wxString str;
359 
360  if( aConfig->Read( aKey, &str ) )
361  {
363  color.SetFromWxString( str );
364 
365  try
366  {
367  nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
368  ( *this )[PointerFromString( aDest )] = js;
369  }
370  catch( ... )
371  {
372  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
373  return false;
374  }
375 
376  return true;
377  }
378 
379  return false;
380 }
int color
Definition: DXF_plotter.cpp:61
nlohmann::json json
Definition: gerbview.cpp:40
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:40

References color, and JSON_SETTINGS::PointerFromString().

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

333 {
334  wxString str;
335 
336  if( aConfig->Read( aKey, &str ) )
337  {
338  try
339  {
340  ( *this )[PointerFromString( aDest )] = str.ToUTF8();
341  }
342  catch( ... )
343  {
344  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
345  return false;
346  }
347 
348  return true;
349  }
350 
351  return false;
352 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

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

◆ Get() [1/2]

template<typename ValueType >
OPT<ValueType> JSON_SETTINGS::Get ( std::string  aPath) const
inlineinherited

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

106  {
107  if( OPT<nlohmann::json> ret = GetJson( std::move( aPath ) ) )
108  {
109  try
110  {
111  return ret->get<ValueType>();
112  }
113  catch( ... )
114  {
115  }
116  }
117 
118  return NULLOPT;
119  }
const auto NULLOPT
Definition: optional.h:9
OPT< nlohmann::json > GetJson(std::string aPath) const
Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1....
boost::optional< T > OPT
Definition: optional.h:7

References JSON_SETTINGS::GetJson(), and NULLOPT.

Referenced by PARAM< ValueType >::Load(), PARAM_COLOR::Load(), COLOR_MAP_PARAM::Load(), PARAM_LAMBDA< ValueType >::Load(), and PARAM_SCALED< ValueType >::Load().

◆ Get() [2/2]

OPT< wxString > JSON_SETTINGS::Get ( std::string  aPath) const
inherited

Definition at line 408 of file json_settings.cpp.

409 {
410  if( OPT<nlohmann::json> opt_json = GetJson( std::move( aPath ) ) )
411  return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
412 
413  return NULLOPT;
414 }
const auto NULLOPT
Definition: optional.h:9
OPT< nlohmann::json > GetJson(std::string aPath) const
Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1....
boost::optional< T > OPT
Definition: optional.h:7

References JSON_SETTINGS::GetJson(), and NULLOPT.

◆ GetFilename()

◆ GetFreeAngleMode()

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

Definition at line 123 of file pns_routing_settings.h.

References m_freeAngleMode.

Referenced by DIALOG_PNS_SETTINGS::DIALOG_PNS_SETTINGS().

◆ GetJson()

OPT< nlohmann::json > JSON_SETTINGS::GetJson ( 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 240 of file json_settings.cpp.

241 {
242  nlohmann::json::json_pointer ptr = PointerFromString( std::move( aPath ) );
243 
244  if( this->contains( ptr ) )
245  {
246  try
247  {
248  return OPT<nlohmann::json>{ this->at( ptr ) };
249  }
250  catch( ... )
251  {
252  }
253  }
254 
255  return OPT<nlohmann::json>{};
256 }
boost::optional< T > OPT
Definition: optional.h:7
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

Referenced by JSON_SETTINGS::Get(), PARAM_LAMBDA< ValueType >::Load(), PARAM_LIST< Type >::Load(), and PARAM_MAP< Value >::Load().

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 57 of file json_settings.h.

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

References JSON_SETTINGS::m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ GetMaxRadius()

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

Definition at line 167 of file pns_routing_settings.h.

References m_maxRadius.

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

◆ GetMinRadius()

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

Definition at line 166 of file pns_routing_settings.h.

References m_minRadius.

◆ GetOptimizeDraggedTrack()

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

◆ GetRounded()

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

Definition at line 144 of file pns_routing_settings.h.

References m_roundedCorners.

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

◆ GetSnapToPads()

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

Definition at line 142 of file pns_routing_settings.h.

References m_snapToPads.

◆ GetSnapToTracks()

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

Definition at line 141 of file pns_routing_settings.h.

References m_snapToTracks.

◆ InitialDirection()

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

Definition at line 100 of file pns_routing_settings.cpp.

101 {
102  if( m_startDiagonal )
103  return DIRECTION_45( DIRECTION_45::NE );
104  else
105  return DIRECTION_45( DIRECTION_45::N );
106 }
DIRECTION_45.
Definition: direction45.h:37

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

◆ InlineDragEnabled()

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

◆ JumpOverObstacles()

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

Returns true if jumping over unmovable obstacles is on.

Definition at line 113 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 62 of file json_settings.cpp.

63 {
64  for( auto param : m_params )
65  param->Load( this );
66 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

Referenced by NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromFile(), FOOTPRINT_EDIT_FRAME::LoadSettings(), PCB_EDIT_FRAME::LoadSettings(), and SETTINGS_MANAGER::SaveColorSettings().

◆ LoadFromFile()

void NESTED_SETTINGS::LoadFromFile ( const std::string &  aDirectory = "")
overridevirtualinherited

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

Parameters
aDirectory

Reimplemented from JSON_SETTINGS.

Definition at line 47 of file nested_settings.cpp.

48 {
49  clear();
50 
51  try
52  {
53  update( ( *m_parent )[PointerFromString( m_path ) ] );
54 
55  wxLogTrace( traceSettings, "Loaded NESTED_SETTINGS %s with schema %d",
57  }
58  catch( ... )
59  {
60  wxLogTrace( traceSettings, "NESTED_SETTINGS %s: Could not load from %s at %s",
62  }
63 
64  Load();
65 }
std::string m_filename
The filename (not including path) of this settings file.
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.
std::string GetFilename() const
Definition: json_settings.h:55
const char * traceSettings
Flag to enable settings tracing.
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
int m_schemaVersion
Version of this settings schema.
virtual void Load()
Updates the parameters of this object based on the current JSON document contents.

References MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::clear(), JSON_SETTINGS::GetFilename(), JSON_SETTINGS::Load(), JSON_SETTINGS::m_filename, NESTED_SETTINGS::m_parent, NESTED_SETTINGS::m_path, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS::PointerFromString(), and traceSettings.

Referenced by NESTED_SETTINGS::NESTED_SETTINGS(), and ROUTING_SETTINGS().

◆ Migrate()

bool JSON_SETTINGS::Migrate ( )
virtualinherited

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

260 {
261  wxLogTrace( traceSettings, "Migrate() not implemented for %s", typeid( *this ).name() );
262  return false;
263 }
const char * traceSettings
Flag to enable settings tracing.

References traceSettings.

Referenced by JSON_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 PCBNEW_SETTINGS, EESCHEMA_SETTINGS, PCB_CALCULATOR_SETTINGS, APP_SETTINGS_BASE, COLOR_SETTINGS, COMMON_SETTINGS, EDA_3D_VIEWER_SETTINGS, LIBEDIT_SETTINGS, GERBVIEW_SETTINGS, FOOTPRINT_EDITOR_SETTINGS, CVPCB_SETTINGS, BITMAP2CMP_SETTINGS, and KICAD_SETTINGS.

Definition at line 266 of file json_settings.cpp.

267 {
268  wxLogTrace( traceSettings,
269  "MigrateFromLegacy() not implemented for %s", typeid( *this ).name() );
270  return false;
271 }
const char * traceSettings
Flag to enable settings tracing.

References traceSettings.

Referenced by JSON_SETTINGS::LoadFromFile().

◆ Mode()

◆ OptimizerEffort()

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

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

Definition at line 71 of file pns_routing_settings.h.

71 { return m_optimizerEffort; }
PNS_OPTIMIZATION_EFFORT m_optimizerEffort

References m_optimizerEffort.

Referenced by DIALOG_PNS_SETTINGS::DIALOG_PNS_SETTINGS(), PNS::LINE_PLACER::rhWalkOnly(), and PNS::SHOVE::runOptimizer().

◆ PointerFromString()

nlohmann::json::json_pointer JSON_SETTINGS::PointerFromString ( std::string  aPath)
staticinherited

Builds a JSON pointer based on a given string.

Parameters
aPathis the path in the form "key1.key2.key3"
Returns
a JSON pointer that can be used to index into a JSON object

Definition at line 274 of file json_settings.cpp.

275 {
276  std::replace( aPath.begin(), aPath.end(), '.', '/' );
277  aPath.insert( 0, "/" );
278 
279  nlohmann::json::json_pointer p;
280 
281  try
282  {
283  p = nlohmann::json::json_pointer( aPath );
284  }
285  catch( ... )
286  {
287  wxASSERT_MSG( false, wxT( "Invalid pointer path in PointerFromString!" ) );
288  }
289 
290  return p;
291 }

Referenced by JSON_SETTINGS::fromLegacy(), JSON_SETTINGS::fromLegacyColor(), JSON_SETTINGS::fromLegacyString(), JSON_SETTINGS::GetJson(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromFile(), APP_SETTINGS_BASE::migrateFindReplace(), GERBVIEW_SETTINGS::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), SETTINGS_MANAGER::SaveColorSettings(), NESTED_SETTINGS::SaveToFile(), and JSON_SETTINGS::Set().

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

391 {
392  auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
393  [&aSettings]( const JSON_SETTINGS* aPtr ) {
394  return aPtr == aSettings;
395  } );
396 
397  if( it != m_nested_settings.end() )
398  {
399  wxLogTrace( traceSettings, "Flush and release %s", ( *it )->GetFilename() );
400  ( *it )->SaveToFile();
401  m_nested_settings.erase( it );
402  }
403 }
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
const char * traceSettings
Flag to enable settings tracing.

References JSON_SETTINGS::m_nested_settings, and traceSettings.

Referenced by NESTED_SETTINGS::~NESTED_SETTINGS().

◆ RemoveLoops()

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

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

Definition at line 83 of file pns_routing_settings.h.

References m_removeLoops.

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

◆ ResetToDefaults()

void JSON_SETTINGS::ResetToDefaults ( )
inherited

Resets all parameters to default values.

Does NOT write to file or update underlying JSON.

Definition at line 192 of file json_settings.cpp.

193 {
194  for( auto param : m_params )
195  param->SetDefault();
196 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

Referenced by EDA_3D_VIEWER::Process_Special_Functions().

◆ SaveToFile()

void NESTED_SETTINGS::SaveToFile ( const std::string &  aDirectory = "")
overridevirtualinherited

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

Parameters
aDirectoryis ignored

Reimplemented from JSON_SETTINGS.

Definition at line 68 of file nested_settings.cpp.

69 {
70  Store();
71 
72  try
73  {
74  ( *m_parent )[PointerFromString( m_path ) ].update( *this );
75 
76  wxLogTrace( traceSettings, "Stored NESTED_SETTINGS %s with schema %d",
78  }
79  catch( ... )
80  {
81  wxLogTrace( traceSettings, "NESTED_SETTINGS %s: Could not store to %s at %s",
83  }
84 }
std::string m_filename
The filename (not including path) of this settings file.
JSON_SETTINGS * m_parent
A pointer to the parent object to load and store from.
virtual void Store()
Stores the current parameters into the JSON document represented by this object Note: this doesn't do...
std::string m_path
The path (in pointer format) of where to store this document in the parent.
std::string GetFilename() const
Definition: json_settings.h:55
const char * traceSettings
Flag to enable settings tracing.
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
int m_schemaVersion
Version of this settings schema.

References JSON_SETTINGS::GetFilename(), JSON_SETTINGS::m_filename, NESTED_SETTINGS::m_parent, NESTED_SETTINGS::m_path, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS::PointerFromString(), JSON_SETTINGS::Store(), and traceSettings.

◆ Set() [1/3]

template<typename ValueType >
void JSON_SETTINGS::Set ( std::string  aPath,
ValueType  aVal 
)
inlineinherited

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

130  {
131  ( *this )[PointerFromString( std::move( aPath ) ) ] = aVal;
132  }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

Referenced by PARAM_COLOR::Store(), PARAM< ValueType >::Store(), COLOR_MAP_PARAM::Store(), PARAM_LAMBDA< ValueType >::Store(), PARAM_SCALED< ValueType >::Store(), PARAM_LIST< Type >::Store(), and PARAM_MAP< Value >::Store().

◆ Set() [2/3]

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

◆ Set() [3/3]

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

Definition at line 417 of file json_settings.cpp.

418 {
419  ( *this )[PointerFromString( std::move( aPath ) ) ] = aVal.ToUTF8();
420 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

◆ SetCanViolateDRC()

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

Definition at line 121 of file pns_routing_settings.h.

121 { m_canViolateDRC = aViolate; }

References m_canViolateDRC.

Referenced by DIALOG_PNS_SETTINGS::OnOkClick().

◆ SetFreeAngleMode()

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

Definition at line 125 of file pns_routing_settings.h.

125 { m_freeAngleMode = aEnable; }

References m_freeAngleMode.

Referenced by DIALOG_PNS_SETTINGS::OnOkClick().

◆ SetInlineDragEnabled()

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

Definition at line 135 of file pns_routing_settings.h.

135 { m_inlineDragEnabled = aEnable; }

References m_inlineDragEnabled.

Referenced by DIALOG_PNS_SETTINGS::OnOkClick().

◆ SetJumpOverObstacles()

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

Enables/disables jumping over unmovable obstacles.

Definition at line 116 of file pns_routing_settings.h.

116 { m_jumpOverObstacles = aJumpOverObstacles; }

References m_jumpOverObstacles.

Referenced by DIALOG_PNS_SETTINGS::OnOkClick().

◆ SetLegacyFilename()

void JSON_SETTINGS::SetLegacyFilename ( const std::string &  aFilename)
inlineinherited

Definition at line 59 of file json_settings.h.

59 { m_legacy_filename = aFilename; }
std::string m_legacy_filename
The filename of the wxConfig legacy file (if different from m_filename)

References JSON_SETTINGS::m_legacy_filename.

Referenced by LIBEDIT_SETTINGS::LIBEDIT_SETTINGS().

◆ SetMaxRadius()

void PNS::ROUTING_SETTINGS::SetMaxRadius ( int  aRadius)
inline

Definition at line 158 of file pns_routing_settings.h.

159  {
160  m_maxRadius = aRadius;
161 
162  if( m_maxRadius < m_minRadius )
164  }

References m_maxRadius, and m_minRadius.

◆ SetMinRadius()

void PNS::ROUTING_SETTINGS::SetMinRadius ( int  aRadius)
inline

Definition at line 150 of file pns_routing_settings.h.

151  {
152  m_minRadius = aRadius;
153 
154  if( m_maxRadius < m_minRadius )
156  }

References m_maxRadius, and m_minRadius.

◆ SetMode()

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

Sets the routing mode.

Definition at line 68 of file pns_routing_settings.h.

68 { m_routingMode = aMode; }

References m_routingMode.

Referenced by DIALOG_PNS_SETTINGS::OnOkClick().

◆ SetOptimizeDraggedTrack()

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

Definition at line 148 of file pns_routing_settings.h.

References m_optimizeDraggedTrack.

Referenced by DIALOG_PNS_SETTINGS::OnOkClick().

◆ SetOptimizerEffort()

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

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

Definition at line 74 of file pns_routing_settings.h.

74 { m_optimizerEffort = aEffort; }
PNS_OPTIMIZATION_EFFORT m_optimizerEffort

References m_optimizerEffort.

Referenced by DIALOG_PNS_SETTINGS::OnOkClick().

◆ SetRemoveLoops()

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

Enables/disables loop (redundant track) removal.

Definition at line 86 of file pns_routing_settings.h.

86 { m_removeLoops = aRemoveLoops; }

References m_removeLoops.

Referenced by DIALOG_PNS_SETTINGS::OnOkClick().

◆ SetRounded()

void PNS::ROUTING_SETTINGS::SetRounded ( bool  aRound)
inline

Definition at line 145 of file pns_routing_settings.h.

145 { m_roundedCorners = aRound; }

References m_roundedCorners.

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

◆ SetShoveVias()

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

Enables/disables shoving vias.

Definition at line 80 of file pns_routing_settings.h.

80 { m_shoveVias = aShoveVias; }

References m_shoveVias.

Referenced by DIALOG_PNS_SETTINGS::OnOkClick().

◆ SetSmartPads()

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

Enables/disables Smart Pads (optimized connections).

Definition at line 98 of file pns_routing_settings.h.

98 { m_smartPads = aSmartPads; }

References m_smartPads.

Referenced by DIALOG_PNS_SETTINGS::OnOkClick().

◆ SetSmoothDraggedSegments()

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

Enables/disabled smoothing segments during dragging.

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

139 { m_snapToPads = aSnap; }

References m_snapToPads.

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

◆ SetSnapToTracks()

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

Definition at line 138 of file pns_routing_settings.h.

References m_snapToTracks.

◆ SetStartDiagonal()

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

Definition at line 118 of file pns_routing_settings.h.

118 { m_startDiagonal = aStartDiagonal; }

References m_startDiagonal.

◆ SetSuggestFinish()

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

Enables displaying suggestions for finishing the currently placed track.

Definition at line 92 of file pns_routing_settings.h.

92 { m_suggestFinish = aSuggestFinish; }

References m_suggestFinish.

Referenced by DIALOG_PNS_SETTINGS::OnOkClick().

◆ ShoveIterationLimit()

int PNS::ROUTING_SETTINGS::ShoveIterationLimit ( ) const

Definition at line 115 of file pns_routing_settings.cpp.

116 {
117  return m_shoveIterationLimit;
118 }

References m_shoveIterationLimit.

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

◆ ShoveTimeLimit()

TIME_LIMIT PNS::ROUTING_SETTINGS::ShoveTimeLimit ( ) const

Definition at line 109 of file pns_routing_settings.cpp.

110 {
111  return TIME_LIMIT ( m_shoveTimeLimit );
112 }

References m_shoveTimeLimit.

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

◆ ShoveVias()

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

Returns true if shoving vias is enbled.

Definition at line 77 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

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

Definition at line 95 of file pns_routing_settings.h.

References m_smartPads.

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

◆ SmoothDraggedSegments()

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

Returns true if smoothing segments durign dragging is enabled.

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

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

Definition at line 185 of file json_settings.cpp.

186 {
187  for( auto param : m_params )
188  param->Store( this );
189 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

Referenced by SETTINGS_MANAGER::SaveColorSettings(), PCB_EDIT_FRAME::SaveSettings(), NESTED_SETTINGS::SaveToFile(), and JSON_SETTINGS::SaveToFile().

◆ SuggestFinish()

bool PNS::ROUTING_SETTINGS::SuggestFinish ( )
inline

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

Definition at line 89 of file pns_routing_settings.h.

References m_suggestFinish.

Referenced by DIALOG_PNS_SETTINGS::DIALOG_PNS_SETTINGS().

◆ WalkaroundIterationLimit()

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

Definition at line 132 of file pns_routing_settings.h.

References m_walkaroundIterationLimit.

◆ WalkaroundTimeLimit()

TIME_LIMIT PNS::ROUTING_SETTINGS::WalkaroundTimeLimit ( ) const

Member Data Documentation

◆ m_canViolateDRC

bool PNS::ROUTING_SETTINGS::m_canViolateDRC
private

Definition at line 178 of file pns_routing_settings.h.

Referenced by CanViolateDRC(), ROUTING_SETTINGS(), and SetCanViolateDRC().

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

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_filename

std::string JSON_SETTINGS::m_filename
protectedinherited

◆ m_followMouse

bool PNS::ROUTING_SETTINGS::m_followMouse
private

Definition at line 175 of file pns_routing_settings.h.

Referenced by FollowMouse(), and ROUTING_SETTINGS().

◆ m_freeAngleMode

bool PNS::ROUTING_SETTINGS::m_freeAngleMode
private

Definition at line 179 of file pns_routing_settings.h.

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

◆ m_inlineDragEnabled

bool PNS::ROUTING_SETTINGS::m_inlineDragEnabled
private

◆ m_jumpOverObstacles

bool PNS::ROUTING_SETTINGS::m_jumpOverObstacles
private

◆ m_legacy_filename

std::string JSON_SETTINGS::m_legacy_filename
protectedinherited

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

Definition at line 210 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 213 of file json_settings.h.

Referenced by JSON_SETTINGS::GetLocation().

◆ m_maxRadius

int PNS::ROUTING_SETTINGS::m_maxRadius
private

Definition at line 187 of file pns_routing_settings.h.

Referenced by GetMaxRadius(), ROUTING_SETTINGS(), SetMaxRadius(), and SetMinRadius().

◆ m_minRadius

int PNS::ROUTING_SETTINGS::m_minRadius
private

Definition at line 186 of file pns_routing_settings.h.

Referenced by GetMinRadius(), ROUTING_SETTINGS(), SetMaxRadius(), and SetMinRadius().

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

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

◆ m_optimizeDraggedTrack

bool PNS::ROUTING_SETTINGS::m_optimizeDraggedTrack
private

◆ m_optimizerEffort

PNS_OPTIMIZATION_EFFORT PNS::ROUTING_SETTINGS::m_optimizerEffort
private

Definition at line 190 of file pns_routing_settings.h.

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

◆ m_params

◆ m_preserved_paths

std::vector<nlohmann::json::json_pointer> JSON_SETTINGS::m_preserved_paths
protectedinherited

A list of JSON pointers that are preserved during a read-update-write to disk.

Definition at line 231 of file json_settings.h.

◆ m_removeLoops

bool PNS::ROUTING_SETTINGS::m_removeLoops
private

Definition at line 172 of file pns_routing_settings.h.

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

◆ m_roundedCorners

bool PNS::ROUTING_SETTINGS::m_roundedCorners
private

Definition at line 183 of file pns_routing_settings.h.

Referenced by GetRounded(), ROUTING_SETTINGS(), and SetRounded().

◆ m_routingMode

PNS_MODE PNS::ROUTING_SETTINGS::m_routingMode
private

Definition at line 189 of file pns_routing_settings.h.

Referenced by 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 193 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 194 of file pns_routing_settings.h.

Referenced by ROUTING_SETTINGS(), and ShoveTimeLimit().

◆ m_shoveVias

bool PNS::ROUTING_SETTINGS::m_shoveVias
private

Definition at line 170 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 173 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 182 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 181 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 171 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 174 of file pns_routing_settings.h.

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

◆ m_walkaroundIterationLimit

int PNS::ROUTING_SETTINGS::m_walkaroundIterationLimit
private

Definition at line 192 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 195 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 225 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().


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