KiCad PCB EDA Suite
Loading...
Searching...
No Matches
board_design_settings.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
24#include <pcb_dimension.h>
25#include <pcb_track.h>
26#include <cmath>
27#include <layer_ids.h>
28#include <lset.h>
29#include <kiface_base.h>
30#include <pad.h>
33#include <drc/drc_item.h>
34#include <drc/drc_engine.h>
36#include <settings/parameters.h>
38#include <advanced_config.h>
39
40const int bdsSchemaVersion = 2;
41
42
43BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS( JSON_SETTINGS* aParent, const std::string& aPath ) :
44 NESTED_SETTINGS( "board_design_settings", bdsSchemaVersion, aParent, aPath )
45{
46 // We want to leave alone parameters that aren't found in the project JSON as they may be
47 // initialized by the board file parser before NESTED_SETTINGS::LoadFromFile is called.
49
50 // Create a default NET_SETTINGS so that things don't break horribly if there's no project
51 // loaded. This also is used during file load for legacy boards that have netclasses stored
52 // in the file. After load, this information will be moved to the project and the pointer
53 // updated.
54 m_NetSettings = std::make_shared<NET_SETTINGS>( nullptr, "" );
55
56 m_HasStackup = false; // no stackup defined by default
57
58 m_Pad_Master = std::make_unique<PAD>( nullptr );
60
61 LSET all_set = LSET().set();
62 m_enabledLayers = all_set; // All layers enabled at first.
63 // SetCopperLayerCount() will adjust this.
64
65 // Default design is a double layer board with 4 user defined layers
68
70
71 // if true, when creating a new track starting on an existing track, use this track width
74
75 // First is always the reference designator
76 m_DefaultFPTextItems.emplace_back( wxT( "REF**" ), true, F_SilkS );
77 // Second is always the value
78 m_DefaultFPTextItems.emplace_back( wxT( "" ), true, F_Fab );
79 // Any following ones are freebies
80 m_DefaultFPTextItems.emplace_back( wxT( "${REFERENCE}" ), true, F_Fab );
81
88
95
96 // Edges & Courtyards; text properties aren't used but better to have them holding
97 // reasonable values than not.
100 pcbIUScale.mmToIU( DEFAULT_TEXT_SIZE ) );
104
107 pcbIUScale.mmToIU( DEFAULT_TEXT_SIZE ) );
111
114 pcbIUScale.mmToIU( DEFAULT_TEXT_SIZE ) );
116 m_TextItalic[ LAYER_CLASS_FAB ] = false;
118
121 pcbIUScale.mmToIU( DEFAULT_TEXT_SIZE ) );
125
126 m_StyleFPFields = false;
127 m_StyleFPText = false;
128 m_StyleFPShapes = false;
129 m_StyleFPDimensions = false;
130 m_StyleFPBarcodes = false;
131
140
141 m_useCustomTrackVia = false;
143 m_customViaSize.m_Diameter = pcbIUScale.mmToIU( DEFAULT_VIASMINSIZE );
145
146 m_useCustomDiffPair = false;
150
167
168 for( int errorCode = DRCE_FIRST; errorCode <= DRCE_LAST; ++errorCode )
169 m_DRCSeverities[ errorCode ] = RPT_SEVERITY_ERROR;
170
173
177
180
183
185
193
199
201
204
206
209
212
214
218
219 // Global mask margins:
223
224 // Solder paste margin absolute value
226 // Solder paste margin as a ratio of pad size
227 // The final margin is the sum of these 2 values
228 // Usually < 0 because the mask is smaller than pad
230
232 m_TentViasFront = true;
233 m_TentViasBack = true;
234
235 m_CoverViasFront = false;
236 m_CoverViasBack = false;
237
238 m_PlugViasFront = false;
239 m_PlugViasBack = false;
240
241 m_CapVias = false;
242
243 m_FillVias = false;
244
245 // Layer thickness for 3D viewer
247
248 // Default spacing for meanders
252
253 m_viaSizeIndex = 0;
255 m_diffPairIndex = 0;
256
257 // Parameters stored in JSON in the project file
258
259 // NOTE: Previously, BOARD_DESIGN_SETTINGS stored the basic board layer information (layer
260 // names and enable/disable state) in the project file even though this information is also
261 // stored in the board file. This was implemented for importing these settings from another
262 // project. Going forward, the import feature will just import from other board files (since
263 // we could have multi-board projects in the future anyway) so this functionality is dropped.
264
265
266 m_params.emplace_back( new PARAM<bool>( "rules.use_height_for_length_calcs",
267 &m_UseHeightForLengthCalcs, true ) );
268
269 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_clearance",
271 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
272
273 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_connection",
275 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 100.0 ), pcbIUScale.MM_PER_IU ) );
276
277 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_track_width",
279 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
280
281 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_via_annular_width",
283 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
284
285 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_via_diameter",
287 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
288
289 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_through_hole_diameter",
291 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
292
293 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_microvia_diameter",
295 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 10.0 ), pcbIUScale.MM_PER_IU ) );
296
297 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_microvia_drill",
299 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 10.0 ), pcbIUScale.MM_PER_IU ) );
300
301 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_hole_to_hole",
303 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 10.0 ), pcbIUScale.MM_PER_IU ) );
304
305 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_hole_clearance",
307 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 100.0 ), pcbIUScale.MM_PER_IU ) );
308
309 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_silk_clearance",
311 pcbIUScale.mmToIU( -10.0 ), pcbIUScale.mmToIU( 100.0 ), pcbIUScale.MM_PER_IU ) );
312
313 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_groove_width",
315 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
316
317 // While the maximum *effective* value is 4, we've had users interpret this as the count on
318 // all layers, and enter something like 10. They'll figure it out soon enough *unless* we
319 // enforce a max of 4 (and therefore reset it back to the default of 2), at which point it
320 // just looks buggy.
321 m_params.emplace_back( new PARAM<int>( "rules.min_resolved_spokes",
323
324 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_text_height",
326 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 100.0 ), pcbIUScale.MM_PER_IU ) );
327
328 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_text_thickness",
330 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
331
332 // Note: a clearance of -0.01 is a flag indicating we should use the legacy (pre-6.0) method
333 // based on the edge cut thicknesses.
334 m_params.emplace_back( new PARAM_SCALED<int>( "rules.min_copper_edge_clearance",
336 pcbIUScale.mmToIU( -0.01 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
337
338 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "rule_severities",
339 [&]() -> nlohmann::json
340 {
341 nlohmann::json ret = {};
342
343 for( const RC_ITEM& item : DRC_ITEM::GetItemsWithSeverities() )
344 {
345 wxString name = item.GetSettingsKey();
346 int code = item.GetErrorCode();
347
348 if( name.IsEmpty() || m_DRCSeverities.count( code ) == 0 )
349 continue;
350
351 ret[std::string( name.ToUTF8() )] = SeverityToString( m_DRCSeverities[code] );
352 }
353
354 return ret;
355 },
356 [&]( const nlohmann::json& aJson )
357 {
358 if( !aJson.is_object() )
359 return;
360
361 // Load V8 'hole_near_hole' token first (if present). Any current 'hole_to_hole' token
362 // found will then overwrite it.
363 // We can't use the migration architecture because we forgot to bump the version number
364 // when the change was made. But this is a one-off as any future deprecations should
365 // bump the version number and use registerMigration().
366 if( aJson.contains( "hole_near_hole" ) )
368
369 for( const RC_ITEM& item : DRC_ITEM::GetItemsWithSeverities() )
370 {
371 wxString name = item.GetSettingsKey();
372 std::string key( name.ToUTF8() );
373
374 if( aJson.contains( key ) )
375 m_DRCSeverities[item.GetErrorCode()] = SeverityFromString( aJson[key] );
376 }
377 }, {} ) );
378
379 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "drc_exclusions",
380 [&]() -> nlohmann::json
381 {
382 nlohmann::json js = nlohmann::json::array();
383
384 for( const wxString& entry : m_DrcExclusions )
385 js.push_back( { entry, m_DrcExclusionComments[ entry ] } );
386
387 return js;
388 },
389 [&]( const nlohmann::json& aObj )
390 {
391 m_DrcExclusions.clear();
392
393 if( !aObj.is_array() )
394 return;
395
396 for( const nlohmann::json& entry : aObj )
397 {
398 if( entry.is_array() )
399 {
400 wxString serialized = entry[0].get<wxString>();
401 m_DrcExclusions.insert( serialized );
402 m_DrcExclusionComments[ serialized ] = entry[1].get<wxString>();
403 }
404 else if( entry.is_string() )
405 {
406 m_DrcExclusions.insert( entry.get<wxString>() );
407 }
408 }
409 },
410 {} ) );
411
412 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "track_widths",
413 [&]() -> nlohmann::json
414 {
415 nlohmann::json js = nlohmann::json::array();
416
417 for( const int& width : m_TrackWidthList )
418 js.push_back( pcbIUScale.IUTomm( width ) );
419
420 return js;
421 },
422 [&]( const nlohmann::json& aJson )
423 {
424 if( !aJson.is_array() )
425 return;
426
427 m_TrackWidthList.clear();
428
429 for( const nlohmann::json& entry : aJson )
430 {
431 if( entry.empty() )
432 continue;
433
434 m_TrackWidthList.emplace_back( pcbIUScale.mmToIU( entry.get<double>() ) );
435 }
436 },
437 {} ) );
438
439 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "via_dimensions",
440 [&]() -> nlohmann::json
441 {
442 nlohmann::json js = nlohmann::json::array();
443
444 for( const auto& via : m_ViasDimensionsList )
445 {
446 nlohmann::json entry = {};
447
448 entry["diameter"] = pcbIUScale.IUTomm( via.m_Diameter );
449 entry["drill"] = pcbIUScale.IUTomm( via.m_Drill );
450
451 js.push_back( entry );
452 }
453
454 return js;
455 },
456 [&]( const nlohmann::json& aObj )
457 {
458 if( !aObj.is_array() )
459 return;
460
461 m_ViasDimensionsList.clear();
462
463 for( const nlohmann::json& entry : aObj )
464 {
465 if( entry.empty() || !entry.is_object() )
466 continue;
467
468 if( !entry.contains( "diameter" ) || !entry.contains( "drill" ) )
469 continue;
470
471 int diameter = pcbIUScale.mmToIU( entry["diameter"].get<double>() );
472 int drill = pcbIUScale.mmToIU( entry["drill"].get<double>() );
473
474 m_ViasDimensionsList.emplace_back( VIA_DIMENSION( diameter, drill ) );
475 }
476 },
477 {} ) );
478
479 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "diff_pair_dimensions",
480 [&]() -> nlohmann::json
481 {
482 nlohmann::json js = nlohmann::json::array();
483
484 for( const auto& pair : m_DiffPairDimensionsList )
485 {
486 nlohmann::json entry = {};
487
488 entry["width"] = pcbIUScale.IUTomm( pair.m_Width );
489 entry["gap"] = pcbIUScale.IUTomm( pair.m_Gap );
490 entry["via_gap"] = pcbIUScale.IUTomm( pair.m_ViaGap );
491
492 js.push_back( entry );
493 }
494
495 return js;
496 },
497 [&]( const nlohmann::json& aObj )
498 {
499 if( !aObj.is_array() )
500 return;
501
503
504 for( const nlohmann::json& entry : aObj )
505 {
506 if( entry.empty() || !entry.is_object() )
507 continue;
508
509 if( !entry.contains( "width" )
510 || !entry.contains( "gap" )
511 || !entry.contains( "via_gap" ) )
512 {
513 continue;
514 }
515
516 int width = pcbIUScale.mmToIU( entry["width"].get<double>() );
517 int gap = pcbIUScale.mmToIU( entry["gap"].get<double>() );
518 int via_gap = pcbIUScale.mmToIU( entry["via_gap"].get<double>() );
519
520 m_DiffPairDimensionsList.emplace_back( DIFF_PAIR_DIMENSION( width, gap, via_gap ) );
521 }
522 },
523 {} ) );
524
525 // Handle options for teardrops (targets and some others):
526 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "teardrop_options",
527 [&]() -> nlohmann::json
528 {
529 nlohmann::json js = nlohmann::json::array();
530 nlohmann::json entry = {};
531
532 entry["td_onvia"] = m_TeardropParamsList.m_TargetVias;
533 entry["td_onpthpad"] = m_TeardropParamsList.m_TargetPTHPads;
534 entry["td_onsmdpad"] = m_TeardropParamsList.m_TargetSMDPads;
535 entry["td_ontrackend"] = m_TeardropParamsList.m_TargetTrack2Track;
536 entry["td_onroundshapesonly"] = m_TeardropParamsList.m_UseRoundShapesOnly;
537
538 js.push_back( entry );
539
540 return js;
541 },
542 [&]( const nlohmann::json& aObj )
543 {
544 if( !aObj.is_array() )
545 return;
546
547 for( const nlohmann::json& entry : aObj )
548 {
549 if( entry.empty() || !entry.is_object() )
550 continue;
551
552 if( entry.contains( "td_onvia" ) )
553 m_TeardropParamsList.m_TargetVias = entry["td_onvia"].get<bool>();
554
555 if( entry.contains( "td_onpthpad" ) )
556 m_TeardropParamsList.m_TargetPTHPads = entry["td_onpthpad"].get<bool>();
557
558 if( entry.contains( "td_onsmdpad" ) )
559 m_TeardropParamsList.m_TargetSMDPads = entry["td_onsmdpad"].get<bool>();
560
561 if( entry.contains( "td_ontrackend" ) )
562 m_TeardropParamsList.m_TargetTrack2Track = entry["td_ontrackend"].get<bool>();
563
564 if( entry.contains( "td_onroundshapesonly" ) )
565 m_TeardropParamsList.m_UseRoundShapesOnly = entry["td_onroundshapesonly"].get<bool>();
566
567 // Legacy settings
568 for( int ii = 0; ii < 3; ++ii )
569 {
570 TEARDROP_PARAMETERS* td_prm = m_TeardropParamsList.GetParameters( (TARGET_TD)ii );
571
572 if( entry.contains( "td_allow_use_two_tracks" ) )
573 td_prm->m_AllowUseTwoTracks = entry["td_allow_use_two_tracks"].get<bool>();
574
575 if( entry.contains( "td_curve_segcount" ) )
576 {
577 if( entry["td_curve_segcount"].get<int>() > 0 )
578 td_prm->m_CurvedEdges = true;
579 }
580
581 if( entry.contains( "td_on_pad_in_zone" ) )
582 td_prm->m_TdOnPadsInZones = entry["td_on_pad_in_zone"].get<bool>();
583 }
584 }
585 },
586 {} ) );
587
588 // Handle parameters (sizes, shape) for each type of teardrop:
589 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "teardrop_parameters",
590 [&]() -> nlohmann::json
591 {
592 nlohmann::json js = nlohmann::json::array();
593
594 for( size_t ii = 0; ii < m_TeardropParamsList.GetParametersCount(); ii++ )
595 {
596 nlohmann::json entry = {};
597 TEARDROP_PARAMETERS* td_prm = m_TeardropParamsList.GetParameters( (TARGET_TD)ii );
598
599 entry["td_target_name"] = GetTeardropTargetCanonicalName( (TARGET_TD)ii );
600 entry["td_maxlen"] = pcbIUScale.IUTomm( td_prm->m_TdMaxLen );
601 entry["td_maxheight"] = pcbIUScale.IUTomm( td_prm->m_TdMaxWidth );
602 entry["td_length_ratio"] = td_prm->m_BestLengthRatio;
603 entry["td_height_ratio"] = td_prm->m_BestWidthRatio;
604 entry["td_curve_segcount"] = td_prm->m_CurvedEdges ? 1 : 0;
605 entry["td_width_to_size_filter_ratio"] = td_prm->m_WidthtoSizeFilterRatio;
606 entry["td_allow_use_two_tracks"] = td_prm->m_AllowUseTwoTracks;
607 entry["td_on_pad_in_zone"] = td_prm->m_TdOnPadsInZones;
608
609 js.push_back( entry );
610 }
611
612 return js;
613 },
614 [&]( const nlohmann::json& aObj )
615 {
616 if( !aObj.is_array() )
617 return;
618
619 for( const nlohmann::json& entry : aObj )
620 {
621 if( entry.empty() || !entry.is_object() )
622 continue;
623
624 if( !entry.contains( "td_target_name" ) )
625 continue;
626
627 int idx = GetTeardropTargetTypeFromCanonicalName( entry["td_target_name"].get<std::string>() );
628
629 if( idx >= 0 && idx < 3 )
630 {
631 TEARDROP_PARAMETERS* td_prm = m_TeardropParamsList.GetParameters( (TARGET_TD)idx );
632
633 if( entry.contains( "td_maxlen" ) )
634 td_prm->m_TdMaxLen = pcbIUScale.mmToIU( entry["td_maxlen"].get<double>() );
635
636 if( entry.contains( "td_maxheight" ) )
637 td_prm->m_TdMaxWidth = pcbIUScale.mmToIU( entry["td_maxheight"].get<double>() );
638
639 if( entry.contains( "td_length_ratio" ) )
640 td_prm->m_BestLengthRatio = entry["td_length_ratio"].get<double>();
641
642 if( entry.contains( "td_height_ratio" ) )
643 td_prm->m_BestWidthRatio = entry["td_height_ratio"].get<double>();
644
645 if( entry.contains( "td_curve_segcount" ) )
646 {
647 if( entry["td_curve_segcount"].get<int>() > 0 )
648 td_prm->m_CurvedEdges = true;
649 }
650
651 if( entry.contains( "td_width_to_size_filter_ratio" ) )
652 td_prm->m_WidthtoSizeFilterRatio = entry["td_width_to_size_filter_ratio"].get<double>();
653
654 if( entry.contains( "td_allow_use_two_tracks" ) )
655 td_prm->m_AllowUseTwoTracks = entry["td_allow_use_two_tracks"].get<bool>();
656
657 if( entry.contains( "td_on_pad_in_zone" ) )
658 td_prm->m_TdOnPadsInZones = entry["td_on_pad_in_zone"].get<bool>();
659 }
660 }
661 },
662 {} ) );
663
664 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "tuning_pattern_settings",
665 [&]() -> nlohmann::json
666 {
667 nlohmann::json js = {};
668
669 auto make_settings =
670 []( const PNS::MEANDER_SETTINGS& aSettings )
671 {
672 nlohmann::json entry = {};
673
674 entry["min_amplitude"] = pcbIUScale.IUTomm( aSettings.m_minAmplitude );
675 entry["max_amplitude"] = pcbIUScale.IUTomm( aSettings.m_maxAmplitude );
676 entry["spacing"] = pcbIUScale.IUTomm( aSettings.m_spacing );
677 entry["corner_style"] = aSettings.m_cornerStyle == PNS::MEANDER_STYLE_CHAMFER ? 0 : 1;
678 entry["corner_radius_percentage"] = aSettings.m_cornerRadiusPercentage;
679 entry["single_sided"] = aSettings.m_singleSided;
680
681 return entry;
682 };
683
684 js["single_track_defaults"] = make_settings( m_SingleTrackMeanderSettings );
685 js["diff_pair_defaults"] = make_settings( m_DiffPairMeanderSettings );
686 js["diff_pair_skew_defaults"] = make_settings( m_SkewMeanderSettings );
687
688 return js;
689 },
690 [&]( const nlohmann::json& aObj )
691 {
692 auto read_settings =
693 []( const nlohmann::json& entry ) -> PNS::MEANDER_SETTINGS
694 {
695 PNS::MEANDER_SETTINGS settings;
696
697 if( entry.contains( "min_amplitude" ) )
698 settings.m_minAmplitude = pcbIUScale.mmToIU( entry["min_amplitude"].get<double>() );
699
700 if( entry.contains( "max_amplitude" ) )
701 settings.m_maxAmplitude = pcbIUScale.mmToIU( entry["max_amplitude"].get<double>() );
702
703 if( entry.contains( "spacing" ) )
704 settings.m_spacing = pcbIUScale.mmToIU( entry["spacing"].get<double>() );
705
706 if( entry.contains( "corner_style" ) )
707 {
708 settings.m_cornerStyle = entry["corner_style"] == 0 ? PNS::MEANDER_STYLE_CHAMFER
710 }
711
712 if( entry.contains( "corner_radius_percentage" ) )
713 settings.m_cornerRadiusPercentage = entry["corner_radius_percentage"].get<int>();
714
715 if( entry.contains( "single_sided" ) )
716 settings.m_singleSided = entry["single_sided"].get<bool>();
717
718 return settings;
719 };
720
721 if( aObj.contains( "single_track_defaults" ) )
722 m_SingleTrackMeanderSettings = read_settings( aObj["single_track_defaults"] );
723
724 if( aObj.contains( "diff_pair_defaults" ) )
725 m_DiffPairMeanderSettings = read_settings( aObj["diff_pair_defaults"] );
726
727 if( aObj.contains( "diff_pair_skew_defaults" ) )
728 m_SkewMeanderSettings = read_settings( aObj["diff_pair_skew_defaults"] );
729 },
730 {} ) );
731
732 int minTextSize = pcbIUScale.mmToIU( TEXT_MIN_SIZE_MM );
733 int maxTextSize = pcbIUScale.mmToIU( TEXT_MAX_SIZE_MM );
734 int minStroke = 1;
735 int maxStroke = pcbIUScale.mmToIU( 100 );
736
737 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.silk_line_width",
739 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
740
741 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.silk_text_size_v",
743 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
744
745 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.silk_text_size_h",
747 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
748
749 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.silk_text_thickness",
751 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
752
753 m_params.emplace_back( new PARAM<bool>( "defaults.silk_text_italic",
754 &m_TextItalic[LAYER_CLASS_SILK], false ) );
755
756 m_params.emplace_back( new PARAM<bool>( "defaults.silk_text_upright",
757 &m_TextUpright[ LAYER_CLASS_SILK ], true ) );
758
759 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.copper_line_width",
761 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
762
763 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.copper_text_size_v",
765 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
766
767 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.copper_text_size_h",
769 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
770
771 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.copper_text_thickness",
773 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
774
775 m_params.emplace_back( new PARAM<bool>( "defaults.copper_text_italic",
776 &m_TextItalic[LAYER_CLASS_COPPER], false ) );
777
778 m_params.emplace_back( new PARAM<bool>( "defaults.copper_text_upright",
780
781 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.board_outline_line_width",
783 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
784
785 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.courtyard_line_width",
787 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
788
789 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.fab_line_width",
791 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
792
793 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.fab_text_size_v",
795 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
796
797 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.fab_text_size_h",
799 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
800
801 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.fab_text_thickness",
803 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
804
805 m_params.emplace_back( new PARAM<bool>( "defaults.fab_text_italic",
806 &m_TextItalic[LAYER_CLASS_FAB], false ) );
807
808 m_params.emplace_back( new PARAM<bool>( "defaults.fab_text_upright",
809 &m_TextUpright[LAYER_CLASS_FAB], true ) );
810
811 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.other_line_width",
813 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
814
815 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.other_text_size_v",
817 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
818
819 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.other_text_size_h",
821 minTextSize, maxTextSize, pcbIUScale.MM_PER_IU ) );
822
823 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.other_text_thickness",
825 minStroke, maxStroke, pcbIUScale.MM_PER_IU ) );
826
827 m_params.emplace_back( new PARAM<bool>( "defaults.other_text_italic",
828 &m_TextItalic[LAYER_CLASS_OTHERS], false ) );
829
830 m_params.emplace_back( new PARAM<bool>( "defaults.other_text_upright",
832
833 m_params.emplace_back( new PARAM_ENUM<DIM_UNITS_MODE>( "defaults.dimension_units",
836
837 m_params.emplace_back( new PARAM_ENUM<DIM_PRECISION>( "defaults.dimension_precision",
839
840 m_params.emplace_back( new PARAM_ENUM<DIM_UNITS_FORMAT>( "defaults.dimensions.units_format",
843
844 m_params.emplace_back( new PARAM<bool>( "defaults.dimensions.suppress_zeroes",
845 &m_DimensionSuppressZeroes, true ) );
846
847 // NOTE: excluding DIM_TEXT_POSITION::MANUAL from the valid range here
848 m_params.emplace_back( new PARAM_ENUM<DIM_TEXT_POSITION>( "defaults.dimensions.text_position",
851
852 m_params.emplace_back( new PARAM<bool>( "defaults.dimensions.keep_text_aligned",
854
855 m_params.emplace_back( new PARAM<int>( "defaults.dimensions.arrow_length",
858
859 m_params.emplace_back( new PARAM<int>( "defaults.dimensions.extension_offset",
862
863 m_params.emplace_back( new PARAM<bool>( "defaults.apply_defaults_to_fp_fields",
864 &m_StyleFPFields, false ) );
865 m_params.emplace_back( new PARAM<bool>( "defaults.apply_defaults_to_fp_text",
866 &m_StyleFPText, false ) );
867 m_params.emplace_back( new PARAM<bool>( "defaults.apply_defaults_to_fp_shapes",
868 &m_StyleFPShapes, false ) );
869 m_params.emplace_back( new PARAM<bool>( "defaults.apply_defaults_to_fp_dimensions",
870 &m_StyleFPDimensions, false ) );
871 m_params.emplace_back( new PARAM<bool>( "defaults.apply_defaults_to_fp_barcodes",
872 &m_StyleFPBarcodes, false ) );
873
874 m_params.emplace_back( new PARAM_SCALED<int>( "defaults.zones.min_clearance",
875 &m_defaultZoneSettings.m_ZoneClearance, pcbIUScale.mmToIU( ZONE_CLEARANCE_MM ),
876 pcbIUScale.mmToIU( 0.0 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
877
878 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "defaults.pads",
879 [&]() -> nlohmann::json
880 {
881 nlohmann::json ret =
882 {
883 { "width", pcbIUScale.IUTomm( m_Pad_Master->GetSize( PADSTACK::ALL_LAYERS ).x ) },
884 { "height", pcbIUScale.IUTomm( m_Pad_Master->GetSize( PADSTACK::ALL_LAYERS ).y ) },
885 { "drill", pcbIUScale.IUTomm( m_Pad_Master->GetDrillSize().x ) }
886 };
887
888 return ret;
889 },
890 [&]( const nlohmann::json& aJson )
891 {
892 if( aJson.contains( "width" ) && aJson.contains( "height" )
893 && aJson.contains( "drill" ) )
894 {
895 VECTOR2I sz;
896 sz.x = pcbIUScale.mmToIU( aJson["width"].get<double>() );
897 sz.y = pcbIUScale.mmToIU( aJson["height"].get<double>() );
898
899 m_Pad_Master->SetSize( PADSTACK::ALL_LAYERS, sz );
900
901 int drill = pcbIUScale.mmToIU( aJson["drill"].get<double>() );
902
903 m_Pad_Master->SetDrillSize( VECTOR2I( drill, drill ) );
904 }
905 }, {} ) );
906
907 m_params.emplace_back( new PARAM_SCALED<int>( "rules.max_error",
909 pcbIUScale.mmToIU( 0.0001 ), pcbIUScale.mmToIU( 1.0 ), pcbIUScale.MM_PER_IU ) );
910
911 m_params.emplace_back( new PARAM_SCALED<int>( "rules.solder_mask_to_copper_clearance",
913 pcbIUScale.mmToIU( 0.0 ), pcbIUScale.mmToIU( 25.0 ), pcbIUScale.MM_PER_IU ) );
914
915 m_params.emplace_back( new PARAM<bool>( "zones_allow_external_fillets",
916 &m_ZoneKeepExternalFillets, false ) );
917
919
920 registerMigration( 1, 2,
921 [&]() -> bool
922 {
923 // Schema 1 to 2: move mask and paste margin settings back to board.
924 // The parameters are removed, so we just have to manually load them here and
925 // they will get saved with the board
926 if( std::optional<double> optval = Get<double>( "rules.solder_mask_clearance" ) )
927 m_SolderMaskExpansion = static_cast<int>( *optval * pcbIUScale.IU_PER_MM );
928
929 if( std::optional<double> optval = Get<double>( "rules.solder_mask_min_width" ) )
930 m_SolderMaskMinWidth = static_cast<int>( *optval * pcbIUScale.IU_PER_MM );
931
932 if( std::optional<double> optval = Get<double>( "rules.solder_paste_clearance" ) )
933 m_SolderPasteMargin = static_cast<int>( *optval * pcbIUScale.IU_PER_MM );
934
935 if( std::optional<double> optval = Get<double>( "rules.solder_paste_margin_ratio" ) )
936 m_SolderPasteMarginRatio = *optval;
937
938 try
939 {
940 At( "rules" ).erase( "solder_mask_clearance" );
941 At( "rules" ).erase( "solder_mask_min_width" );
942 At( "rules" ).erase( "solder_paste_clearance" );
943 At( "rules" ).erase( "solder_paste_margin_ratio" );
944 }
945 catch( ... )
946 {}
947
948 return true;
949 } );
950}
951
952
954{
955 if( m_parent )
956 {
957 m_parent->ReleaseNestedSettings( this );
958 m_parent = nullptr;
959 }
960}
961
962
964 NESTED_SETTINGS( "board_design_settings", bdsSchemaVersion, aOther.m_parent,
965 aOther.m_path ),
966 m_Pad_Master( nullptr )
967{
968 initFromOther( aOther );
969}
970
971
973{
974 initFromOther( aOther );
975 return *this;
976}
977
978
980{
981 // Copy of NESTED_SETTINGS around is not allowed, so let's just update the params.
990 m_MinConn = aOther.m_MinConn;
1008 m_MaxError = aOther.m_MaxError;
1021 m_CapVias = aOther.m_CapVias;
1022 m_FillVias = aOther.m_FillVias;
1025
1026 std::copy( std::begin( aOther.m_LineThickness ), std::end( aOther.m_LineThickness ),
1027 std::begin( m_LineThickness ) );
1028
1029 std::copy( std::begin( aOther.m_TextSize ), std::end( aOther.m_TextSize ),
1030 std::begin( m_TextSize ) );
1031
1032 std::copy( std::begin( aOther.m_TextThickness ), std::end( aOther.m_TextThickness ),
1033 std::begin( m_TextThickness ) );
1034
1035 std::copy( std::begin( aOther.m_TextItalic ), std::end( aOther.m_TextItalic ),
1036 std::begin( m_TextItalic ) );
1037
1038 std::copy( std::begin( aOther.m_TextUpright ), std::end( aOther.m_TextUpright ),
1039 std::begin( m_TextUpright ) );
1040
1049
1050 m_auxOrigin = aOther.m_auxOrigin;
1051 m_gridOrigin = aOther.m_gridOrigin;
1052 m_HasStackup = aOther.m_HasStackup;
1054
1068 m_stackup = aOther.m_stackup;
1070 m_Pad_Master = std::make_unique<PAD>( *aOther.m_Pad_Master );
1072
1078}
1079
1080
1082{
1083 if( m_TrackWidthList != aOther.m_TrackWidthList ) return false;
1084 if( m_ViasDimensionsList != aOther.m_ViasDimensionsList ) return false;
1085 if( m_DiffPairDimensionsList != aOther.m_DiffPairDimensionsList ) return false;
1086 if( m_CurrentViaType != aOther.m_CurrentViaType ) return false;
1087 if( m_UseConnectedTrackWidth != aOther.m_UseConnectedTrackWidth ) return false;
1088 if( m_TempOverrideTrackWidth != aOther.m_TempOverrideTrackWidth ) return false;
1089 if( m_MinClearance != aOther.m_MinClearance ) return false;
1090 if( m_MinGrooveWidth != aOther.m_MinGrooveWidth ) return false;
1091 if( m_MinConn != aOther.m_MinConn ) return false;
1092 if( m_TrackMinWidth != aOther.m_TrackMinWidth ) return false;
1093 if( m_ViasMinAnnularWidth != aOther.m_ViasMinAnnularWidth ) return false;
1094 if( m_ViasMinSize != aOther.m_ViasMinSize ) return false;
1095 if( m_MinThroughDrill != aOther.m_MinThroughDrill ) return false;
1096 if( m_MicroViasMinSize != aOther.m_MicroViasMinSize ) return false;
1097 if( m_MicroViasMinDrill != aOther.m_MicroViasMinDrill ) return false;
1098 if( m_CopperEdgeClearance != aOther.m_CopperEdgeClearance ) return false;
1099 if( m_HoleClearance != aOther.m_HoleClearance ) return false;
1100 if( m_HoleToHoleMin != aOther.m_HoleToHoleMin ) return false;
1101 if( m_SilkClearance != aOther.m_SilkClearance ) return false;
1102 if( m_MinResolvedSpokes != aOther.m_MinResolvedSpokes ) return false;
1103 if( m_MinSilkTextHeight != aOther.m_MinSilkTextHeight ) return false;
1104 if( m_MinSilkTextThickness != aOther.m_MinSilkTextThickness ) return false;
1105 if( m_DRCSeverities != aOther.m_DRCSeverities ) return false;
1106 if( m_DrcExclusions != aOther.m_DrcExclusions ) return false;
1107 if( m_DrcExclusionComments != aOther.m_DrcExclusionComments ) return false;
1108 if( m_ZoneKeepExternalFillets != aOther.m_ZoneKeepExternalFillets ) return false;
1109 if( m_MaxError != aOther.m_MaxError ) return false;
1110 if( m_SolderMaskExpansion != aOther.m_SolderMaskExpansion ) return false;
1111 if( m_SolderMaskMinWidth != aOther.m_SolderMaskMinWidth ) return false;
1113 if( m_SolderPasteMargin != aOther.m_SolderPasteMargin ) return false;
1114 if( m_SolderPasteMarginRatio != aOther.m_SolderPasteMarginRatio ) return false;
1116 if( m_TentViasFront != aOther.m_TentViasFront ) return false;
1117 if( m_TentViasBack != aOther.m_TentViasBack ) return false;
1118 if( m_CoverViasFront != aOther.m_CoverViasFront ) return false;
1119 if( m_CoverViasBack != aOther.m_CoverViasBack ) return false;
1120 if( m_PlugViasFront != aOther.m_PlugViasFront ) return false;
1121 if( m_PlugViasBack != aOther.m_PlugViasBack ) return false;
1122 if( m_CapVias != aOther.m_CapVias ) return false;
1123 if( m_FillVias != aOther.m_FillVias ) return false;
1124 if( m_DefaultFPTextItems != aOther.m_DefaultFPTextItems ) return false;
1125 if( m_UserLayerNames != aOther.m_UserLayerNames ) return false;
1126
1127 if( !std::equal( std::begin( m_LineThickness ), std::end( m_LineThickness ),
1128 std::begin( aOther.m_LineThickness ) ) )
1129 return false;
1130
1131 if( !std::equal( std::begin( m_TextSize ), std::end( m_TextSize ),
1132 std::begin( aOther.m_TextSize ) ) )
1133 return false;
1134
1135 if( !std::equal( std::begin( m_TextThickness ), std::end( m_TextThickness ),
1136 std::begin( aOther.m_TextThickness ) ) )
1137 return false;
1138
1139 if( !std::equal( std::begin( m_TextItalic ), std::end( m_TextItalic ),
1140 std::begin( aOther.m_TextItalic ) ) )
1141 return false;
1142
1143 if( !std::equal( std::begin( m_TextUpright ), std::end( m_TextUpright ),
1144 std::begin( aOther.m_TextUpright ) ) )
1145 return false;
1146
1147 if( m_DimensionUnitsMode != aOther.m_DimensionUnitsMode ) return false;
1148 if( m_DimensionPrecision != aOther.m_DimensionPrecision ) return false;
1149 if( m_DimensionUnitsFormat != aOther.m_DimensionUnitsFormat ) return false;
1150 if( m_DimensionSuppressZeroes != aOther.m_DimensionSuppressZeroes ) return false;
1151 if( m_DimensionTextPosition != aOther.m_DimensionTextPosition ) return false;
1152 if( m_DimensionKeepTextAligned != aOther.m_DimensionKeepTextAligned ) return false;
1153 if( m_DimensionArrowLength != aOther.m_DimensionArrowLength ) return false;
1154 if( m_DimensionExtensionOffset != aOther.m_DimensionExtensionOffset ) return false;
1155 if( m_auxOrigin != aOther.m_auxOrigin ) return false;
1156 if( m_gridOrigin != aOther.m_gridOrigin ) return false;
1157 if( m_HasStackup != aOther.m_HasStackup ) return false;
1158 if( m_UseHeightForLengthCalcs != aOther.m_UseHeightForLengthCalcs ) return false;
1159 if( m_trackWidthIndex != aOther.m_trackWidthIndex ) return false;
1160 if( m_viaSizeIndex != aOther.m_viaSizeIndex ) return false;
1161 if( m_diffPairIndex != aOther.m_diffPairIndex ) return false;
1162 if( m_useCustomTrackVia != aOther.m_useCustomTrackVia ) return false;
1163 if( m_customTrackWidth != aOther.m_customTrackWidth ) return false;
1164 if( m_customViaSize != aOther.m_customViaSize ) return false;
1165 if( m_useCustomDiffPair != aOther.m_useCustomDiffPair ) return false;
1166 if( m_customDiffPair != aOther.m_customDiffPair ) return false;
1167 if( m_copperLayerCount != aOther.m_copperLayerCount ) return false;
1168 if( m_userDefinedLayerCount != aOther.m_userDefinedLayerCount ) return false;
1169 if( m_enabledLayers != aOther.m_enabledLayers ) return false;
1170 if( m_boardThickness != aOther.m_boardThickness ) return false;
1171 if( m_currentNetClassName != aOther.m_currentNetClassName ) return false;
1172 if( m_stackup != aOther.m_stackup ) return false;
1173 if( *m_NetSettings != *aOther.m_NetSettings ) return false;
1174 if( *m_Pad_Master != *aOther.m_Pad_Master ) return false;
1175 if( m_defaultZoneSettings != aOther.m_defaultZoneSettings ) return false;
1176
1177 if( m_StyleFPFields != aOther.m_StyleFPFields ) return false;
1178 if( m_StyleFPText != aOther.m_StyleFPText ) return false;
1179 if( m_StyleFPShapes != aOther.m_StyleFPShapes ) return false;
1180 if( m_StyleFPDimensions != aOther.m_StyleFPDimensions ) return false;
1181 if( m_StyleFPBarcodes != aOther.m_StyleFPBarcodes ) return false;
1182
1183 return true;
1184}
1185
1186
1188{
1206 std::string units_ptr( "defaults.dimension_units" );
1207 std::string precision_ptr( "defaults.dimension_precision" );
1208
1209 if( !( Contains( units_ptr )
1210 && Contains( precision_ptr )
1211 && At( units_ptr ).is_number_integer()
1212 && At( precision_ptr ).is_number_integer() ) )
1213 {
1214 // if either is missing or invalid, migration doesn't make sense
1215 return true;
1216 }
1217
1218 int units = *Get<int>( units_ptr );
1219 int precision = *Get<int>( precision_ptr );
1220
1221 // The enum maps directly to precision if the units is mils
1222 int extraDigits = 0;
1223
1224 switch( units )
1225 {
1226 case 0: extraDigits = 3; break;
1227 case 2: extraDigits = 2; break;
1228 default: break;
1229 }
1230
1231 precision += extraDigits;
1232
1233 Set( precision_ptr, precision );
1234
1235 return true;
1236}
1237
1238
1239bool BOARD_DESIGN_SETTINGS::LoadFromFile( const wxString& aDirectory )
1240{
1241 bool ret = NESTED_SETTINGS::LoadFromFile( aDirectory );
1242
1243 // A number of things won't have been translated by the PROJECT_FILE migration because of
1244 // descoped objects required to decode this data. So, it will be in the legacy.pcbnew
1245 // section and needs to be pulled out here
1246
1247 PROJECT_FILE* project = dynamic_cast<PROJECT_FILE*>( GetParent() );
1248
1249 if( !project )
1250 return ret;
1251
1252 bool migrated = false;
1253
1254 auto drcName =
1255 []( int aCode ) -> std::string
1256 {
1257 return std::string( DRC_ITEM::Create( aCode )->GetSettingsKey().ToUTF8() );
1258 };
1259
1260 const std::string rs = "rule_severities.";
1261 const std::string no_courtyard_key = "legacy_no_courtyard_defined";
1262 const std::string courtyard_overlap_key = "legacy_courtyards_overlap";
1263
1264 try
1265 {
1266 nlohmann::json& severities =
1267 project->Internals()->at( "/board/design_settings/rule_severities"_json_pointer );
1268
1269 if( severities.contains( no_courtyard_key ) )
1270 {
1271 if( severities[no_courtyard_key].get<bool>() )
1272 Set( rs + drcName( DRCE_MISSING_COURTYARD ), "error" );
1273 else
1274 Set( rs + drcName( DRCE_MISSING_COURTYARD ), "ignore" );
1275
1276 severities.erase( no_courtyard_key );
1277 migrated = true;
1278 }
1279
1280 if( severities.contains( courtyard_overlap_key ) )
1281 {
1282 if( severities[courtyard_overlap_key].get<bool>() )
1283 Set( rs + drcName( DRCE_OVERLAPPING_FOOTPRINTS ), "error" );
1284 else
1285 Set( rs + drcName( DRCE_OVERLAPPING_FOOTPRINTS ), "ignore" );
1286
1287 severities.erase( courtyard_overlap_key );
1288 migrated = true;
1289 }
1290 }
1291 catch( ... )
1292 {
1293 }
1294
1295 if( Contains( "legacy" ) )
1296 {
1297 // This defaults to false for new boards, but version 5.1.x and prior kept the fillets
1298 // so we do the same for legacy boards.
1300
1301 project->At( "legacy" ).erase( "pcbnew" );
1302 }
1303
1304 // Now that we have everything, we need to load again
1305 if( migrated )
1306 Load();
1307
1308 return ret;
1309}
1310
1311
1313{
1314 return m_DRCSeverities[ aDRCErrorCode ];
1315}
1316
1317
1318bool BOARD_DESIGN_SETTINGS::Ignore( int aDRCErrorCode )
1319{
1320 return m_DRCSeverities[ aDRCErrorCode ] == RPT_SEVERITY_IGNORE;
1321}
1322
1323
1324std::vector<BOARD_DESIGN_SETTINGS::VALIDATION_ERROR>
1325BOARD_DESIGN_SETTINGS::ValidateDesignRules( std::optional<EDA_UNITS> aUnits ) const
1326{
1327 std::vector<VALIDATION_ERROR> errors;
1328 EDA_UNITS units = aUnits.value_or( EDA_UNITS::MM );
1329
1330 auto addRangeError =
1331 [&]( const wxString& aField, int aValue, int aMin, int aMax )
1332 {
1333 if( aValue < aMin || aValue > aMax )
1334 {
1335 wxString minValue = EDA_UNIT_UTILS::UI::StringFromValue( pcbIUScale, units,
1336 aMin, true );
1337 wxString maxValue = EDA_UNIT_UTILS::UI::StringFromValue( pcbIUScale, units,
1338 aMax, true );
1339
1340 errors.push_back( {
1341 aField,
1342 wxString::Format( _( "Value must be between %s and %s." ),
1343 minValue, maxValue )
1344 } );
1345 }
1346 };
1347
1348 auto addRatioRangeError =
1349 [&]( const wxString& aField, double aValue, double aMin, double aMax )
1350 {
1351 if( !std::isfinite( aValue ) || aValue < aMin || aValue > aMax )
1352 {
1353 errors.push_back( {
1354 aField,
1355 wxString::Format( _( "Value must be between %.3f and %.3f." ),
1356 aMin, aMax )
1357 } );
1358 }
1359 };
1360
1361 addRangeError( wxS( "min_clearance" ), m_MinClearance,
1362 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 25.0 ) );
1363 addRangeError( wxS( "min_connection" ), m_MinConn,
1364 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 100.0 ) );
1365 addRangeError( wxS( "min_track_width" ), m_TrackMinWidth,
1366 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 25.0 ) );
1367 addRangeError( wxS( "min_via_annular_width" ), m_ViasMinAnnularWidth,
1368 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 25.0 ) );
1369 addRangeError( wxS( "min_via_diameter" ), m_ViasMinSize,
1370 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 25.0 ) );
1371 addRangeError( wxS( "min_through_hole_diameter" ), m_MinThroughDrill,
1372 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 25.0 ) );
1373 addRangeError( wxS( "min_microvia_diameter" ), m_MicroViasMinSize,
1374 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 10.0 ) );
1375 addRangeError( wxS( "min_microvia_drill" ), m_MicroViasMinDrill,
1376 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 10.0 ) );
1377 addRangeError( wxS( "min_hole_to_hole" ), m_HoleToHoleMin,
1378 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 10.0 ) );
1379 addRangeError( wxS( "min_hole_clearance" ), m_HoleClearance,
1380 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 100.0 ) );
1381 addRangeError( wxS( "min_silk_clearance" ), m_SilkClearance,
1382 pcbIUScale.mmToIU( -10.0 ), pcbIUScale.mmToIU( 100.0 ) );
1383 addRangeError( wxS( "min_groove_width" ), m_MinGrooveWidth,
1384 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 25.0 ) );
1385 addRangeError( wxS( "min_text_height" ), m_MinSilkTextHeight,
1386 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 100.0 ) );
1387 addRangeError( wxS( "min_text_thickness" ), m_MinSilkTextThickness,
1388 pcbIUScale.mmToIU( 0.00 ), pcbIUScale.mmToIU( 25.0 ) );
1389 addRangeError( wxS( "min_copper_edge_clearance" ), m_CopperEdgeClearance,
1390 pcbIUScale.mmToIU( -0.01 ), pcbIUScale.mmToIU( 25.0 ) );
1391
1393 {
1394 errors.push_back( {
1395 wxS( "min_resolved_spokes" ),
1396 _( "Value must be between 0 and 99." )
1397 } );
1398 }
1399
1400 addRangeError( wxS( "max_error" ), m_MaxError,
1403
1404 addRangeError( wxS( "solder_mask_expansion" ), m_SolderMaskExpansion,
1405 pcbIUScale.mmToIU( -25.0 ), pcbIUScale.mmToIU( 25.0 ) );
1406 addRangeError( wxS( "solder_mask_min_width" ), m_SolderMaskMinWidth,
1407 pcbIUScale.mmToIU( 0.0 ), pcbIUScale.mmToIU( 25.0 ) );
1408 addRangeError( wxS( "solder_mask_to_copper_clearance" ), m_SolderMaskToCopperClearance,
1409 pcbIUScale.mmToIU( 0.0 ), pcbIUScale.mmToIU( 25.0 ) );
1410 addRangeError( wxS( "solder_paste_margin" ), m_SolderPasteMargin,
1411 pcbIUScale.mmToIU( -25.0 ), pcbIUScale.mmToIU( 25.0 ) );
1412 addRatioRangeError( wxS( "solder_paste_margin_ratio" ), m_SolderPasteMarginRatio,
1413 -1.0, 1.0 );
1414
1415 TEARDROP_PARAMETERS_LIST& teardropParamsList =
1417
1418 for( size_t ii = 0; ii < teardropParamsList.GetParametersCount(); ++ii )
1419 {
1420 const TEARDROP_PARAMETERS* params = teardropParamsList.GetParameters( static_cast<TARGET_TD>( ii ) );
1421 std::string target = GetTeardropTargetCanonicalName( static_cast<TARGET_TD>( ii ) );
1422
1423 if( params->m_TdMaxLen < 0 )
1424 {
1425 errors.push_back( {
1426 wxString::Format( wxS( "teardrop_parameters[%s].max_length" ), target ),
1427 _( "Value must be greater than or equal to 0." )
1428 } );
1429 }
1430
1431 if( params->m_TdMaxWidth < 0 )
1432 {
1433 errors.push_back( {
1434 wxString::Format( wxS( "teardrop_parameters[%s].max_width" ), target ),
1435 _( "Value must be greater than or equal to 0." )
1436 } );
1437 }
1438
1439 addRatioRangeError( wxString::Format( wxS( "teardrop_parameters[%s].best_length_ratio" ), target ),
1440 params->m_BestLengthRatio, 0.0, 1.0 );
1441 addRatioRangeError( wxString::Format( wxS( "teardrop_parameters[%s].best_width_ratio" ), target ),
1442 params->m_BestWidthRatio, 0.0, 1.0 );
1443 addRatioRangeError( wxString::Format( wxS( "teardrop_parameters[%s].width_to_size_filter_ratio" ),
1444 target ),
1445 params->m_WidthtoSizeFilterRatio, 0.0, 1.0 );
1446 }
1447
1448 for( size_t ii = 1; ii < m_DiffPairDimensionsList.size(); ++ii )
1449 {
1450 const DIFF_PAIR_DIMENSION& diffPair = m_DiffPairDimensionsList[ii];
1451
1452 if( diffPair.m_Width > 0 && diffPair.m_Gap <= 0 )
1453 {
1454 errors.push_back( {
1455 wxString::Format( wxS( "diff_pair_dimensions_list[%zu].gap" ), ii ),
1456 _( "No differential pair gap defined." )
1457 } );
1458 }
1459 }
1460
1461 for( size_t ii = 1; ii < m_ViasDimensionsList.size(); ++ii )
1462 {
1463 const VIA_DIMENSION& viaDim = m_ViasDimensionsList[ii];
1464
1465 std::optional<int> viaDiameter;
1466 std::optional<int> viaDrill;
1467
1468 if( viaDim.m_Diameter > 0 )
1469 viaDiameter = viaDim.m_Diameter;
1470
1471 if( viaDim.m_Drill > 0 )
1472 viaDrill = viaDim.m_Drill;
1473
1474 if( std::optional<PCB_VIA::VIA_PARAMETER_ERROR> error =
1475 PCB_VIA::ValidateViaParameters( viaDiameter, viaDrill ) )
1476 {
1477 errors.push_back( {
1478 wxString::Format( wxS( "via_dimensions_list[%zu]" ), ii ),
1479 error->m_Message
1480 } );
1481 }
1482 }
1483
1484 return errors;
1485}
1486
1487
1489{
1490 int biggest = std::max( m_MinClearance, m_HoleClearance );
1491 DRC_CONSTRAINT constraint;
1492
1493 biggest = std::max( biggest, m_HoleToHoleMin );
1494 biggest = std::max( biggest, m_CopperEdgeClearance );
1495
1496 if( m_DRCEngine )
1497 {
1498 m_DRCEngine->QueryWorstConstraint( CLEARANCE_CONSTRAINT, constraint );
1499 biggest = std::max( biggest, constraint.Value().Min() );
1500
1501 m_DRCEngine->QueryWorstConstraint( PHYSICAL_CLEARANCE_CONSTRAINT, constraint );
1502 biggest = std::max( biggest, constraint.Value().Min() );
1503
1504 m_DRCEngine->QueryWorstConstraint( HOLE_CLEARANCE_CONSTRAINT, constraint );
1505 biggest = std::max( biggest, constraint.Value().Min() );
1506
1507 m_DRCEngine->QueryWorstConstraint( EDGE_CLEARANCE_CONSTRAINT, constraint );
1508 biggest = std::max( biggest, constraint.Value().Min() );
1509
1510 m_DRCEngine->QueryWorstConstraint( HOLE_TO_HOLE_CONSTRAINT, constraint );
1511 biggest = std::max( biggest, constraint.Value().Min() );
1512 }
1513
1514 // Clip to avoid integer overflows in subsequent calculations
1515 return std::min( biggest, MAXIMUM_CLEARANCE );
1516}
1517
1518
1520{
1521 int clearance = m_NetSettings->GetDefaultNetclass()->GetClearance();
1522
1523 for( const auto& [name, netclass] : m_NetSettings->GetNetclasses() )
1524 clearance = std::min( clearance, netclass->GetClearance() );
1525
1526 return clearance;
1527}
1528
1529
1531{
1532 m_viaSizeIndex = std::min( aIndex, (int) m_ViasDimensionsList.size() - 1 );
1533 m_useCustomTrackVia = false;
1534}
1535
1536
1538{
1540 return m_customViaSize.m_Diameter;
1542 return m_NetSettings->GetDefaultNetclass()->GetViaDiameter();
1543 else
1544 return m_ViasDimensionsList[ m_viaSizeIndex ].m_Diameter;
1545}
1546
1547
1549{
1550 int drill;
1551
1553 drill = m_customViaSize.m_Drill;
1555 drill = m_NetSettings->GetDefaultNetclass()->GetViaDrill();
1556 else
1557 drill = m_ViasDimensionsList[ m_viaSizeIndex ].m_Drill;
1558
1559 return drill > 0 ? drill : -1;
1560}
1561
1562
1564{
1565 m_trackWidthIndex = std::min( aIndex, (int) m_TrackWidthList.size() - 1 );
1566 m_useCustomTrackVia = false;
1567}
1568
1569
1571{
1573 return m_customTrackWidth;
1575 return m_NetSettings->GetDefaultNetclass()->GetTrackWidth();
1576 else
1578}
1579
1580
1582{
1583 if( !m_DiffPairDimensionsList.empty() )
1584 m_diffPairIndex = std::min( aIndex, (int) m_DiffPairDimensionsList.size() - 1 );
1585
1586 m_useCustomDiffPair = false;
1587}
1588
1589
1591{
1593 {
1594 return m_customDiffPair.m_Width;
1595 }
1597 {
1598 if( m_NetSettings->GetDefaultNetclass()->HasDiffPairWidth() )
1599 return m_NetSettings->GetDefaultNetclass()->GetDiffPairWidth();
1600 else
1601 return m_NetSettings->GetDefaultNetclass()->GetTrackWidth();
1602 }
1603 else
1604 {
1606 }
1607}
1608
1609
1611{
1613 {
1614 return m_customDiffPair.m_Gap;
1615 }
1617 {
1618 if( m_NetSettings->GetDefaultNetclass()->HasDiffPairGap() )
1619 return m_NetSettings->GetDefaultNetclass()->GetDiffPairGap();
1620 else
1621 return m_NetSettings->GetDefaultNetclass()->GetClearance();
1622 }
1623 else
1624 {
1626 }
1627}
1628
1629
1631{
1633 {
1634 return m_customDiffPair.m_ViaGap;
1635 }
1637 {
1638 if( m_NetSettings->GetDefaultNetclass()->HasDiffPairViaGap() )
1639 return m_NetSettings->GetDefaultNetclass()->GetDiffPairViaGap();
1640 else
1641 return GetCurrentDiffPairGap();
1642 }
1643 else
1644 {
1646 }
1647}
1648
1649
1651{
1652 m_copperLayerCount = aNewLayerCount;
1653
1654 // Update only enabled copper layers mask
1655 m_enabledLayers.ClearCopperLayers();
1656
1657 if( aNewLayerCount > 0 )
1658 m_enabledLayers |= LSET::AllCuMask( aNewLayerCount );
1659}
1660
1661
1663{
1664 m_userDefinedLayerCount = aNewLayerCount;
1665
1666 m_enabledLayers.ClearUserDefinedLayers();
1667
1668 if( aNewLayerCount > 0 )
1669 m_enabledLayers |= LSET::UserDefinedLayersMask( aNewLayerCount );
1670}
1671
1672
1674{
1675 m_enabledLayers = aMask;
1676
1677 // Ensures mandatory back and front layers are always enabled regardless of board file
1678 // configuration.
1679 m_enabledLayers.set( B_Cu ).set( F_Cu )
1680 .set( B_CrtYd ).set( F_CrtYd )
1681 .set( Edge_Cuts )
1682 .set( Margin );
1683
1684 // update layer counts to ensure their consistency with m_EnabledLayers
1685 LSET copperLayers = aMask;
1686 copperLayers.ClearNonCopperLayers();
1687
1688 LSET userLayers = aMask & LSET::UserDefinedLayersMask();
1689
1690 m_copperLayerCount = (int) copperLayers.count();
1691 m_userDefinedLayerCount = (int) userLayers.count();
1692}
1693
1694
1695// Return the layer class index { silk, copper, edges & courtyards, fab, others } of the
1696// given layer.
1698{
1699 if( aLayer == F_SilkS || aLayer == B_SilkS )
1700 return LAYER_CLASS_SILK;
1701 else if( IsCopperLayer( aLayer ) )
1702 return LAYER_CLASS_COPPER;
1703 else if( aLayer == Edge_Cuts )
1704 return LAYER_CLASS_EDGES;
1705 else if( aLayer == F_CrtYd || aLayer == B_CrtYd )
1706 return LAYER_CLASS_COURTYARD;
1707 else if( aLayer == F_Fab || aLayer == B_Fab )
1708 return LAYER_CLASS_FAB;
1709 else
1710 return LAYER_CLASS_OTHERS;
1711}
1712
1713
1715{
1716 return pcbIUScale.mmToIU( ADVANCED_CFG::GetCfg().m_DRCEpsilon );
1717}
1718
1719
1721{
1722 return pcbIUScale.mmToIU( ADVANCED_CFG::GetCfg().m_HoleWallThickness );
1723}
1724
1725
1727{
1728 return m_LineThickness[ GetLayerClass( aLayer ) ];
1729}
1730
1731
1733{
1734 return m_TextSize[ GetLayerClass( aLayer ) ];
1735}
1736
1737
1739{
1740 return m_TextThickness[ GetLayerClass( aLayer ) ];
1741}
1742
1743
1745{
1746 return m_TextItalic[ GetLayerClass( aLayer ) ];
1747}
1748
1749
1751{
1752 return m_TextUpright[ GetLayerClass( aLayer ) ];
1753}
1754
1756{
1757 m_Pad_Master->SetSizeX( pcbIUScale.mmToIU( DEFAULT_PAD_WIDTH_MM ) );
1758 m_Pad_Master->SetSizeY( pcbIUScale.mmToIU( DEFAULT_PAD_HEIGTH_MM ) );
1759 m_Pad_Master->SetDrillShape( PAD_DRILL_SHAPE::CIRCLE );
1760 m_Pad_Master->SetDrillSize( VECTOR2I( pcbIUScale.mmToIU( DEFAULT_PAD_DRILL_DIAMETER_MM ), 0 ) );
1762
1763 constexpr double RR_RADIUS = DEFAULT_PAD_HEIGTH_MM * DEFAULT_PAD_RR_RADIUS_RATIO;
1764 m_Pad_Master->SetRoundRectCornerRadius( PADSTACK::ALL_LAYERS, pcbIUScale.mmToIU( RR_RADIUS ) );
1765
1766 if( m_Pad_Master->GetFrontShape() == PAD_SHAPE::CIRCLE )
1767 m_Pad_Master->SetThermalSpokeAngle( ANGLE_45 );
1768 else
1769 m_Pad_Master->SetThermalSpokeAngle( ANGLE_90 );
1770}
const char * name
constexpr int ARC_HIGH_DEF
Definition base_units.h:128
constexpr EDA_IU_SCALE pcbIUScale
Definition base_units.h:112
const int bdsSchemaVersion
#define DEFAULT_MICROVIASMINDRILL
#define DEFAULT_SOLDERPASTE_CLEARANCE
#define DEFAULT_SOLDERPASTE_RATIO
#define DEFAULT_CUSTOMDPAIRWIDTH
#define DEFAULT_DP_MEANDER_SPACING
@ LAYER_CLASS_OTHERS
@ LAYER_CLASS_FAB
@ LAYER_CLASS_COURTYARD
@ LAYER_CLASS_SILK
@ LAYER_CLASS_COPPER
@ LAYER_CLASS_EDGES
#define DEFAULT_PAD_WIDTH_MM
#define DEFAULT_VIASMINSIZE
#define DEFAULT_PAD_DRILL_DIAMETER_MM
#define DEFAULT_TEXT_WIDTH
#define DEFAULT_COPPER_TEXT_WIDTH
#define DEFAULT_CUSTOMDPAIRGAP
#define DEFAULT_MINCLEARANCE
#define MAXIMUM_ERROR_SIZE_MM
#define DEFAULT_HOLECLEARANCE
#define DEFAULT_SOLDERMASK_EXPANSION
#define DEFAULT_SOLDERMASK_MIN_WIDTH
#define MINIMUM_ERROR_SIZE_MM
#define DEFAULT_DIMENSION_EXTENSION_OFFSET
#define DEFAULT_COPPEREDGECLEARANCE
#define DEFAULT_PAD_HEIGTH_MM
#define DEFAULT_DIMENSION_ARROW_LENGTH
#define DEFAULT_TRACKMINWIDTH
#define DEFAULT_MINTHROUGHDRILL
#define DEFAULT_PAD_RR_RADIUS_RATIO
#define DEFAULT_SILK_TEXT_SIZE
#define MAXIMUM_CLEARANCE
#define DEFAULT_HOLETOHOLEMIN
#define DEFAULT_MINCONNECTION
#define DEFAULT_COPPER_LINE_WIDTH
#define DEFAULT_SILK_LINE_WIDTH
#define DEFAULT_SILKCLEARANCE
#define DEFAULT_MICROVIASMINSIZE
#define DEFAULT_SILK_TEXT_WIDTH
#define DEFAULT_MINGROOVEWIDTH
#define DEFAULT_TEXT_SIZE
#define DEFAULT_EDGE_WIDTH
#define DEFAULT_CUSTOMTRACKWIDTH
#define DEFAULT_CUSTOMDPAIRVIAGAP
#define DEFAULT_COPPER_TEXT_SIZE
#define DEFAULT_SOLDERMASK_TO_COPPER_CLEARANCE
#define DEFAULT_LINE_WIDTH
#define DEFAULT_MEANDER_SPACING
#define DEFAULT_COURTYARD_WIDTH
#define DEFAULT_BOARD_THICKNESS_MM
#define DEFAULT_MINRESOLVEDSPOKES
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
BASE_SET & set(size_t pos)
Definition base_set.h:116
DIM_PRECISION m_DimensionPrecision
Number of digits after the decimal.
std::vector< TEXT_ITEM_INFO > m_DefaultFPTextItems
int GetHolePlatingThickness() const
Pad & via drills are finish size.
VIATYPE m_CurrentViaType
(VIA_BLIND_BURIED, VIA_THROUGH, VIA_MICROVIA)
void SetEnabledLayers(const LSET &aMask)
Change the bit-mask of enabled layers to aMask.
std::shared_ptr< NET_SETTINGS > m_NetSettings
bool operator==(const BOARD_DESIGN_SETTINGS &aOther) const
std::map< wxString, wxString > m_DrcExclusionComments
DIM_UNITS_FORMAT m_DimensionUnitsFormat
void initFromOther(const BOARD_DESIGN_SETTINGS &aOther)
bool GetTextUpright(PCB_LAYER_ID aLayer) const
std::map< int, SEVERITY > m_DRCSeverities
VECTOR2I m_gridOrigin
origin for grid offsets
int GetTextThickness(PCB_LAYER_ID aLayer) const
Return the default text thickness from the layer class for the given layer.
VECTOR2I m_auxOrigin
origin for plot exports
bool m_TextUpright[LAYER_CLASS_COUNT]
BOARD_DESIGN_SETTINGS(JSON_SETTINGS *aParent, const std::string &aPath)
bool GetTextItalic(PCB_LAYER_ID aLayer) const
wxString m_currentNetClassName
Current net class name used to display netclass info.
void SetViaSizeIndex(int aIndex)
Set the current via size list index to aIndex.
std::shared_ptr< DRC_ENGINE > m_DRCEngine
std::vector< DIFF_PAIR_DIMENSION > m_DiffPairDimensionsList
std::set< wxString > m_DrcExclusions
bool Ignore(int aDRCErrorCode)
Return true if the DRC error code's severity is SEVERITY_IGNORE.
std::map< std::string, wxString > m_UserLayerNames
std::unique_ptr< PAD > m_Pad_Master
TEARDROP_PARAMETERS_LIST m_TeardropParamsList
The parameters of teardrops for the different teardrop targets (via/pad, track end).
void SetUserDefinedLayerCount(int aNewLayerCount)
Set the number of user defined layers to aNewLayerCount.
int GetDRCEpsilon() const
Return an epsilon which accounts for rounding errors, etc.
int GetLayerClass(PCB_LAYER_ID aLayer) const
PNS::MEANDER_SETTINGS m_DiffPairMeanderSettings
int m_boardThickness
Board thickness for 3D viewer.
int m_copperLayerCount
Number of copper layers for this design.
int m_userDefinedLayerCount
Number of user defined layers for this design.
bool LoadFromFile(const wxString &aDirectory="") override
Loads the backing file from disk and then calls Load()
PNS::MEANDER_SETTINGS m_SingleTrackMeanderSettings
void SetTrackWidthIndex(int aIndex)
Set the current track width list index to aIndex.
int m_TextThickness[LAYER_CLASS_COUNT]
ZONE_SETTINGS m_defaultZoneSettings
The default settings that will be used for new zones.
SEVERITY GetSeverity(int aDRCErrorCode)
std::vector< int > m_TrackWidthList
DIFF_PAIR_DIMENSION m_customDiffPair
std::vector< VALIDATION_ERROR > ValidateDesignRules(std::optional< EDA_UNITS > aUnits=std::nullopt) const
Validate design settings values and return per-field errors.
int m_LineThickness[LAYER_CLASS_COUNT]
VECTOR2I GetTextSize(PCB_LAYER_ID aLayer) const
Return the default text size from the layer class for the given layer.
int GetLineThickness(PCB_LAYER_ID aLayer) const
Return the default graphic segment thickness from the layer class for the given layer.
bool m_UseHeightForLengthCalcs
Enable inclusion of stackup height in track length measurements and length tuning.
VECTOR2I m_TextSize[LAYER_CLASS_COUNT]
PNS::MEANDER_SETTINGS m_SkewMeanderSettings
LSET m_enabledLayers
Bit-mask for layer enabling.
bool m_TextItalic[LAYER_CLASS_COUNT]
void SetCopperLayerCount(int aNewLayerCount)
Set the copper layer count to aNewLayerCount.
DIM_TEXT_POSITION m_DimensionTextPosition
BOARD_STACKUP m_stackup
The description of layers stackup, for board fabrication only physical layers are in layers stackup.
std::vector< VIA_DIMENSION > m_ViasDimensionsList
BOARD_DESIGN_SETTINGS & operator=(const BOARD_DESIGN_SETTINGS &aOther)
MINOPTMAX< int > & Value()
Definition drc_rule.h:197
static std::vector< std::reference_wrapper< RC_ITEM > > GetItemsWithSeverities()
Definition drc_item.h:143
static std::shared_ptr< DRC_ITEM > Create(int aErrorCode)
Constructs a DRC_ITEM for the given error code.
Definition drc_item.cpp:407
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 l...
bool Contains(const std::string &aPath) const
virtual void Load()
Updates the parameters of this object based on the current JSON document contents.
std::optional< ValueType > Get(const std::string &aPath) const
Fetches a value from within the JSON document.
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
void registerMigration(int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
Registers a migration from one schema version to another.
nlohmann::json & At(const std::string &aPath)
Wrappers for the underlying JSON API so that most consumers don't need json.hpp All of these function...
JSON_SETTINGS(const wxString &aFilename, SETTINGS_LOC aLocation, int aSchemaVersion)
bool m_resetParamsIfMissing
Whether or not to set parameters to their default value if missing from JSON on Load()
LSET is a set of PCB_LAYER_IDs.
Definition lset.h:37
static const LSET & AllCuMask()
return AllCuMask( MAX_CU_LAYERS );
Definition lset.cpp:608
LSET & ClearNonCopperLayers()
Clear the non-copper layers in this set.
Definition lset.cpp:950
static LSET UserDefinedLayersMask(int aUserDefinedLayerCount=MAX_USER_DEFINED_LAYERS)
Return a mask with the requested number of user defined layers.
Definition lset.cpp:704
T Min() const
Definition minoptmax.h:33
std::string m_path
The path (in pointer format) of where to store this document in the parent.
JSON_SETTINGS * GetParent()
JSON_SETTINGS * m_parent
A pointer to the parent object to load and store from.
NESTED_SETTINGS(const std::string &aName, int aSchemaVersion, JSON_SETTINGS *aParent, const std::string &aPath, bool aLoadFromFile=true)
bool LoadFromFile(const wxString &aDirectory="") override
Loads the JSON document from the parent and then calls Load()
static constexpr PCB_LAYER_ID ALL_LAYERS
! Temporary layer identifier to identify code that is not padstack-aware
Definition padstack.h:177
Stores an enum as an integer.
Definition parameters.h:230
Like a normal param, but with custom getter and setter functions.
Definition parameters.h:297
Represents a parameter that has a scaling factor between the value in the file and the value used int...
Definition parameters.h:394
static std::optional< VIA_PARAMETER_ERROR > ValidateViaParameters(std::optional< int > aDiameter, std::optional< int > aPrimaryDrill, std::optional< PCB_LAYER_ID > aPrimaryStartLayer=std::nullopt, std::optional< PCB_LAYER_ID > aPrimaryEndLayer=std::nullopt, std::optional< int > aSecondaryDrill=std::nullopt, std::optional< PCB_LAYER_ID > aSecondaryStartLayer=std::nullopt, std::optional< PCB_LAYER_ID > aSecondaryEndLayer=std::nullopt, std::optional< int > aTertiaryDrill=std::nullopt, std::optional< PCB_LAYER_ID > aTertiaryStartLayer=std::nullopt, std::optional< PCB_LAYER_ID > aTertiaryEndLayer=std::nullopt, int aCopperLayerCount=0)
Dimensions for the meandering algorithm.
Definition pns_meander.h:70
int m_minAmplitude
Maximum meandering amplitude.
Definition pns_meander.h:95
int m_cornerRadiusPercentage
Place meanders on one side.
bool m_singleSided
Initial side when placing meanders at segment.
MEANDER_STYLE m_cornerStyle
Rounding percentage (0 - 100).
int m_maxAmplitude
Meandering period/spacing (see dialog picture for explanation).
Definition pns_meander.h:98
int m_spacing
Amplitude/spacing adjustment step.
The backing store for a PROJECT, in JSON format.
A holder for a rule check item, DRC in Pcbnew or ERC in Eeschema.
Definition rc_item.h:84
TEARDROP_PARAMETERS_LIST is a helper class to handle the list of TEARDROP_PARAMETERS needed to build ...
TEARDROP_PARAMETERS * GetParameters(TARGET_TD aTdType)
TEARDROP_PARAMETARS is a helper class to handle parameters needed to build teardrops for a board thes...
double m_BestWidthRatio
The height of a teardrop as ratio between height and size of pad/via.
int m_TdMaxLen
max allowed length for teardrops in IU. <= 0 to disable
bool m_AllowUseTwoTracks
True to create teardrops using 2 track segments if the first in too small.
int m_TdMaxWidth
max allowed height for teardrops in IU. <= 0 to disable
double m_BestLengthRatio
The length of a teardrop as ratio between length and size of pad/via.
double m_WidthtoSizeFilterRatio
The ratio (H/D) between the via/pad size and the track width max value to create a teardrop 1....
bool m_TdOnPadsInZones
A filter to exclude pads inside zone fills.
bool m_CurvedEdges
True if the teardrop should be curved.
@ DRCE_TUNING_PROFILE_IMPLICIT_RULES
Definition drc_item.h:114
@ DRCE_SILK_EDGE_CLEARANCE
Definition drc_item.h:99
@ DRCE_FOOTPRINT_FILTERS
Definition drc_item.h:80
@ DRCE_SILK_MASK_CLEARANCE
Definition drc_item.h:97
@ DRCE_PADSTACK
Definition drc_item.h:63
@ DRCE_MIRRORED_TEXT_ON_FRONT_LAYER
Definition drc_item.h:110
@ DRCE_LIB_FOOTPRINT_ISSUES
Definition drc_item.h:83
@ DRCE_OVERLAPPING_FOOTPRINTS
Definition drc_item.h:66
@ DRCE_SCHEMATIC_FIELDS_PARITY
Definition drc_item.h:120
@ DRCE_MISSING_COURTYARD
Definition drc_item.h:67
@ DRCE_TRACK_NOT_CENTERED_ON_VIA
Definition drc_item.h:118
@ DRCE_ISOLATED_COPPER
Definition drc_item.h:49
@ DRCE_MISSING_TUNING_PROFILE
Definition drc_item.h:113
@ DRCE_DRILLED_HOLES_TOO_CLOSE
Definition drc_item.h:53
@ DRCE_COPPER_SLIVER
Definition drc_item.h:93
@ DRCE_PTH_IN_COURTYARD
Definition drc_item.h:70
@ DRCE_FIRST
Definition drc_item.h:39
@ DRCE_DANGLING_VIA
Definition drc_item.h:51
@ DRCE_FOOTPRINT_TYPE_MISMATCH
Definition drc_item.h:82
@ DRCE_NONMIRRORED_TEXT_ON_BACK_LAYER
Definition drc_item.h:111
@ DRCE_DUPLICATE_FOOTPRINT
Definition drc_item.h:76
@ DRCE_DANGLING_TRACK
Definition drc_item.h:52
@ DRCE_TEXT_HEIGHT
Definition drc_item.h:101
@ DRCE_DRILLED_HOLES_COLOCATED
Definition drc_item.h:54
@ DRCE_EXTRA_FOOTPRINT
Definition drc_item.h:77
@ DRCE_SILK_CLEARANCE
Definition drc_item.h:100
@ DRCE_LAST
Definition drc_item.h:122
@ DRCE_LIB_FOOTPRINT_MISMATCH
Definition drc_item.h:84
@ DRCE_NET_CONFLICT
Definition drc_item.h:78
@ DRCE_MISSING_FOOTPRINT
Definition drc_item.h:75
@ DRCE_TEXT_THICKNESS
Definition drc_item.h:102
@ DRCE_NPTH_IN_COURTYARD
Definition drc_item.h:71
@ DRCE_CONNECTION_WIDTH
Definition drc_item.h:60
@ DRCE_SCHEMATIC_PARITY
Definition drc_item.h:79
@ EDGE_CLEARANCE_CONSTRAINT
Definition drc_rule.h:59
@ CLEARANCE_CONSTRAINT
Definition drc_rule.h:55
@ HOLE_CLEARANCE_CONSTRAINT
Definition drc_rule.h:57
@ PHYSICAL_CLEARANCE_CONSTRAINT
Definition drc_rule.h:83
@ HOLE_TO_HOLE_CONSTRAINT
Definition drc_rule.h:58
#define _(s)
static constexpr EDA_ANGLE ANGLE_90
Definition eda_angle.h:413
static constexpr EDA_ANGLE ANGLE_45
Definition eda_angle.h:412
#define TEXT_MIN_SIZE_MM
Minimum text size (1 micron).
Definition eda_text.h:58
#define TEXT_MAX_SIZE_MM
Maximum text size in mm (~10 inches)
Definition eda_text.h:59
EDA_UNITS
Definition eda_units.h:48
bool IsCopperLayer(int aLayerId)
Test whether a layer is a copper layer.
Definition layer_ids.h:679
PCB_LAYER_ID
A quick note on layer IDs:
Definition layer_ids.h:60
@ F_CrtYd
Definition layer_ids.h:116
@ Edge_Cuts
Definition layer_ids.h:112
@ B_Cu
Definition layer_ids.h:65
@ F_Fab
Definition layer_ids.h:119
@ Margin
Definition layer_ids.h:113
@ F_SilkS
Definition layer_ids.h:100
@ B_CrtYd
Definition layer_ids.h:115
@ B_SilkS
Definition layer_ids.h:101
@ F_Cu
Definition layer_ids.h:64
@ B_Fab
Definition layer_ids.h:118
KICOMMON_API wxString StringFromValue(const EDA_IU_SCALE &aIuScale, EDA_UNITS aUnits, double aValue, bool aAddUnitsText=false, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
Return the string from aValue according to aUnits (inch, mm ...) for display.
@ MEANDER_STYLE_ROUND
Definition pns_meander.h:54
@ MEANDER_STYLE_CHAMFER
Definition pns_meander.h:55
@ ROUNDRECT
Definition padstack.h:57
@ OUTSIDE
Text appears outside the dimension line (default)
@ INLINE
Text appears in line with the dimension line.
SEVERITY
@ RPT_SEVERITY_WARNING
@ RPT_SEVERITY_ERROR
@ RPT_SEVERITY_IGNORE
Container to handle a stock of specific differential pairs each with unique track width,...
Container to handle a stock of specific vias each with unique diameter and drill sizes in the BOARD c...
std::string GetTeardropTargetCanonicalName(TARGET_TD aTdType)
TARGET_TD GetTeardropTargetTypeFromCanonicalName(const std::string &aTargetName)
int clearance
SEVERITY SeverityFromString(const wxString &aSeverity)
Definition ui_common.cpp:56
wxString SeverityToString(const SEVERITY &aSeverity)
Definition ui_common.cpp:67
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:687
#define ZONE_CLEARANCE_MM
Definition zones.h:36