KiCad PCB EDA Suite
Loading...
Searching...
No Matches
board_stackup.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 (C) 2019 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 3
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License along
18 * with this program. If not, see <http://www.gnu.org/licenses/>.
19 */
20
21
22#include "board_stackup.h"
23#include <base_units.h>
24#include <string_utils.h>
25#include <layer_ids.h>
27#include <board.h>
28#include <i18n_utility.h> // For _HKI definition
31#include <richio.h>
32#include <google/protobuf/any.pb.h>
33#include <api/board/board.pb.h>
34#include <api/api_enums.h>
35
36
38{
39 if( m_Material != aOther.m_Material ) return false;
40 if( m_Thickness != aOther.m_Thickness ) return false;
41 if( m_ThicknessLocked != aOther.m_ThicknessLocked ) return false;
42 if( m_EpsilonR != aOther.m_EpsilonR ) return false;
43 if( m_LossTangent != aOther.m_LossTangent ) return false;
44 if( m_Color != aOther.m_Color ) return false;
45
46 return true;
47}
48
49
51{
52 DIELECTRIC_PRMS item_prms;
53 m_DielectricPrmsList.emplace_back( item_prms );
55 m_Type = aType;
57 SetEnabled( true );
58
59 // Initialize parameters to a usual value for allowed types:
60 switch( m_Type )
61 {
65 break;
66
68 m_TypeName = KEY_CORE; // or prepreg
70 SetMaterial( wxT( "FR4" ) ); // or other dielectric name
71 SetLossTangent( 0.02 ); // for FR4
72 SetEpsilonR( 4.5 ); // for FR4
73 break;
74
76 m_TypeName = wxT( "solderpaste" );
77 break;
78
80 m_TypeName = wxT( "soldermask" );
82 SetMaterial( NotSpecifiedPrm() ); // or other solder mask material name
85 break;
86
88 m_TypeName = wxT( "silkscreen" );
90 SetMaterial( NotSpecifiedPrm() ); // or other silkscreen material name
92 break;
93
95 break;
96 }
97}
98
99
101{
102 m_LayerId = aOther.m_LayerId;
104 m_Type = aOther.m_Type;
105 m_enabled = aOther.m_enabled;
107 m_TypeName = aOther.m_TypeName;
108 m_LayerName = aOther.m_LayerName;
109}
110
111
113{
114 if( m_Type != aOther.m_Type ) return false;
115 if( m_LayerName != aOther.m_LayerName ) return false;
116 if( m_TypeName != aOther.m_TypeName ) return false;
117 if( m_LayerId != aOther.m_LayerId ) return false;
118 if( m_DielectricLayerId != aOther.m_DielectricLayerId ) return false;
119 if( m_enabled != aOther.m_enabled ) return false;
120
121 if( !std::equal( std::begin( m_DielectricPrmsList ), std::end( m_DielectricPrmsList ),
122 std::begin( aOther.m_DielectricPrmsList ),
123 []( const DIELECTRIC_PRMS& aA, const DIELECTRIC_PRMS& aB )
124 {
125 return aA == aB;
126 } ) )
127 {
128 return false;
129 }
130
131 return true;
132}
133
134
135void BOARD_STACKUP_ITEM::AddDielectricPrms( int aDielectricPrmsIdx )
136{
137 // add a DIELECTRIC_PRMS item to m_DielectricPrmsList
138 DIELECTRIC_PRMS new_prms;
139
140 m_DielectricPrmsList.emplace( m_DielectricPrmsList.begin() + aDielectricPrmsIdx, new_prms );
141}
142
143
144void BOARD_STACKUP_ITEM::RemoveDielectricPrms( int aDielectricPrmsIdx )
145{
146 // Remove a DIELECTRIC_PRMS item from m_DielectricPrmsList if possible
147
148 if( GetSublayersCount() < 2
149 || aDielectricPrmsIdx < 0
150 || aDielectricPrmsIdx >= GetSublayersCount() )
151 {
152 return;
153 }
154
155 m_DielectricPrmsList.erase( m_DielectricPrmsList.begin() + aDielectricPrmsIdx );
156}
157
158
159
161{
162 // A reasonable thickness for copper layers:
163 return pcbIUScale.mmToIU( 0.035 );
164}
165
166
168{
169 // A reasonable thickness for solder mask:
170 return pcbIUScale.mmToIU( 0.01 );
171}
172
173
174// Getters:
175wxString BOARD_STACKUP_ITEM::GetColor( int aDielectricSubLayer ) const
176{
177 wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
178
179 return m_DielectricPrmsList[aDielectricSubLayer].m_Color;
180}
181
182int BOARD_STACKUP_ITEM::GetThickness( int aDielectricSubLayer ) const
183{
184 wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
185
186 return m_DielectricPrmsList[aDielectricSubLayer].m_Thickness;
187}
188
189
190double BOARD_STACKUP_ITEM::GetLossTangent( int aDielectricSubLayer ) const
191{
192 wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
193
194 return m_DielectricPrmsList[aDielectricSubLayer].m_LossTangent;
195}
196
197
198double BOARD_STACKUP_ITEM::GetEpsilonR( int aDielectricSubLayer ) const
199{
200 wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
201
202 return m_DielectricPrmsList[aDielectricSubLayer].m_EpsilonR;
203}
204
205
206bool BOARD_STACKUP_ITEM::IsThicknessLocked( int aDielectricSubLayer ) const
207{
208 wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
209
210 return m_DielectricPrmsList[aDielectricSubLayer].m_ThicknessLocked;
211}
212
213
214wxString BOARD_STACKUP_ITEM::GetMaterial( int aDielectricSubLayer ) const
215{
216 wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
217
218 return m_DielectricPrmsList[aDielectricSubLayer].m_Material;
219}
220
221
222// Setters:
223void BOARD_STACKUP_ITEM::SetColor( const wxString& aColorName , int aDielectricSubLayer )
224{
225 wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
226
227 if( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() )
228 m_DielectricPrmsList[aDielectricSubLayer].m_Color = aColorName;
229}
230
231
232void BOARD_STACKUP_ITEM::SetThickness( int aThickness, int aDielectricSubLayer )
233{
234 wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
235
236 if( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() )
237 m_DielectricPrmsList[aDielectricSubLayer].m_Thickness = aThickness;
238}
239
240
241void BOARD_STACKUP_ITEM::SetLossTangent( double aTg, int aDielectricSubLayer )
242{
243 wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
244
245 if( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() )
246 m_DielectricPrmsList[aDielectricSubLayer].m_LossTangent = aTg;
247}
248
249
250void BOARD_STACKUP_ITEM::SetEpsilonR( double aEpsilon, int aDielectricSubLayer )
251{
252 wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
253
254 if( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() )
255 m_DielectricPrmsList[aDielectricSubLayer].m_EpsilonR = aEpsilon;
256}
257
258
259void BOARD_STACKUP_ITEM::SetThicknessLocked( bool aLocked, int aDielectricSubLayer )
260{
261 wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
262
263 if( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() )
264 m_DielectricPrmsList[aDielectricSubLayer].m_ThicknessLocked = aLocked;
265}
266
267
268void BOARD_STACKUP_ITEM::SetMaterial( const wxString& aName, int aDielectricSubLayer )
269{
270 wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
271
272 if( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() )
273 m_DielectricPrmsList[aDielectricSubLayer].m_Material = aName;
274}
275
276
278{
281};
282
283
285{
288};
289
290
291bool BOARD_STACKUP_ITEM::HasMaterialValue( int aDielectricSubLayer ) const
292{
293 // return true if the material is specified
294 return IsMaterialEditable() && IsPrmSpecified( GetMaterial( aDielectricSubLayer ) );
295}
296
297
299{
303}
304
305
307{
311}
312
313
315{
319}
320
321
322wxString BOARD_STACKUP_ITEM::FormatEpsilonR( int aDielectricSubLayer ) const
323{
324 // return a wxString to print/display Epsilon R
325 // note: we do not want scientific notation
326 wxString txt = UIDouble2Str( GetEpsilonR( aDielectricSubLayer ) );
327 return txt;
328}
329
330
331wxString BOARD_STACKUP_ITEM::FormatLossTangent( int aDielectricSubLayer ) const
332{
333 // return a wxString to print/display Loss Tangent
334 // note: we do not want scientific notation
335 wxString txt = UIDouble2Str( GetLossTangent( aDielectricSubLayer ) );
336 return txt;
337}
338
339
341{
342 // return a wxString to print/display a dielectric name
343 wxString lname;
344 lname.Printf( _( "Dielectric %d" ), GetDielectricLayerId() );
345
346 return lname;
347}
348
349
351{
352 m_HasDielectricConstrains = false; // True if some dielectric layers have constrains
353 // (Loss tg and Epison R)
354 m_HasThicknessConstrains = false; // True if some dielectric or copper layers have constrains
356 m_EdgePlating = false; // True if edge board is plated
357 m_FinishType = wxT( "None" ); // undefined finish type
358}
359
360
362{
367 m_FinishType = aOther.m_FinishType;
368
369 // All items in aOther.m_list have to be duplicated, because aOther.m_list
370 // manage pointers to these items
371 for( BOARD_STACKUP_ITEM* item : aOther.m_list )
372 {
373 BOARD_STACKUP_ITEM* dup_item = new BOARD_STACKUP_ITEM( *item );
374 Add( dup_item );
375 }
376}
377
378
380{
385 m_FinishType = aOther.m_FinishType;
386
387 RemoveAll();
388
389 // All items in aOther.m_list have to be duplicated, because aOther.m_list
390 // manage pointers to these items
391 for( BOARD_STACKUP_ITEM* item : aOther.m_list )
392 {
393 BOARD_STACKUP_ITEM* dup_item = new BOARD_STACKUP_ITEM( *item );
394 Add( dup_item );
395 }
396
397 return *this;
398}
399
400
401bool BOARD_STACKUP::operator==( const BOARD_STACKUP& aOther ) const
402{
403 if( m_HasDielectricConstrains != aOther.m_HasDielectricConstrains ) return false;
404 if( m_HasThicknessConstrains != aOther.m_HasThicknessConstrains ) return false;
405 if( m_EdgeConnectorConstraints != aOther.m_EdgeConnectorConstraints ) return false;
406 if( m_EdgePlating != aOther.m_EdgePlating ) return false;
407 if( m_FinishType != aOther.m_FinishType ) return false;
408
409 if( !std::equal( std::begin( m_list ), std::end( m_list ), std::begin( aOther.m_list ),
410 []( const BOARD_STACKUP_ITEM* aA, const BOARD_STACKUP_ITEM* aB )
411 {
412 return *aA == *aB;
413 } ) )
414 {
415 return false;
416 }
417
418 return true;
419}
420
421
422void BOARD_STACKUP::Serialize( google::protobuf::Any& aContainer ) const
423{
424 using namespace kiapi::board;
425 BoardStackup stackup;
426
427 for( const BOARD_STACKUP_ITEM* item : m_list )
428 {
429 BoardStackupLayer* layer = stackup.mutable_layers()->Add();
430
431 layer->mutable_thickness()->set_value_nm( item->GetThickness() );
432 layer->set_layer( ToProtoEnum<PCB_LAYER_ID, types::BoardLayer>( item->GetBrdLayerId() ) );
433 layer->set_type(
434 ToProtoEnum<BOARD_STACKUP_ITEM_TYPE, BoardStackupLayerType>( item->GetType() ) );
435
436 switch( item->GetType() )
437 {
439 {
440 layer->set_material_name( "copper" );
441 // (no copper params yet...)
442 break;
443 }
444
446 {
447 BoardStackupDielectricLayer* dielectric = layer->mutable_dielectric()->New();
448
449 for( int i = 0; i < item->GetSublayersCount(); ++i )
450 {
451 BoardStackupDielectricProperties* props = dielectric->mutable_layer()->Add();
452 props->set_epsilon_r( item->GetEpsilonR( i ) );
453 props->set_loss_tangent( item->GetLossTangent( i ) );
454 props->set_material_name( item->GetMaterial( i ).ToUTF8() );
455 props->mutable_thickness()->set_value_nm( item->GetThickness( i ) );
456 }
457
458 break;
459 }
460
461 default:
462 break;
463 }
464 }
465
466 aContainer.PackFrom( stackup );
467}
468
469
470bool BOARD_STACKUP::Deserialize( const google::protobuf::Any& aContainer )
471{
472 // Read-only for now
473 return false;
474}
475
476
478{
479 for( BOARD_STACKUP_ITEM* item : m_list )
480 delete item;
481
482 m_list.clear();
483}
484
485
487{
488 if( aIndex < 0 || aIndex >= GetCount() )
489 return nullptr;
490
491 return GetList()[aIndex];
492}
493
494
496{
497 // return the board thickness from the thickness of BOARD_STACKUP_ITEM list
498 int thickness = 0;
499
500 for( BOARD_STACKUP_ITEM* item : m_list )
501 {
502 if( item->IsThicknessEditable() && item->IsEnabled() )
503 {
504 thickness += item->GetThickness();
505
506 // dielectric layers can have more than one main layer
507 // add thickness of all sublayers
508 for( int idx = 1; idx < item->GetSublayersCount(); idx++ )
509 {
510 thickness += item->GetThickness( idx );
511 }
512 }
513 }
514
515 return thickness;
516}
517
518
520{
521 bool change = false;
522 // Build the suitable stackup:
523 BOARD_STACKUP stackup;
524 stackup.BuildDefaultStackupList( aSettings );
525
526 // First, find removed layers:
527 for( BOARD_STACKUP_ITEM* curr_item: m_list )
528 {
529 bool found = false;
530
531 for( BOARD_STACKUP_ITEM* item: stackup.GetList() )
532 {
533 if( curr_item->GetBrdLayerId() != UNDEFINED_LAYER )
534 {
535 if( item->GetBrdLayerId() == curr_item->GetBrdLayerId() )
536 {
537 found = true;
538 break;
539 }
540 }
541 else // curr_item = dielectric layer
542 {
543 if( item->GetBrdLayerId() != UNDEFINED_LAYER )
544 continue;
545
546 if( item->GetDielectricLayerId() == curr_item->GetDielectricLayerId() )
547 {
548 found = true;
549 break;
550 }
551 }
552 }
553
554 if( !found ) // a layer was removed: a change is found
555 {
556 change = true;
557 break;
558 }
559 }
560
561 // Now initialize all stackup items to the initial values, when exist
562 for( BOARD_STACKUP_ITEM* item : stackup.GetList() )
563 {
564 bool found = false;
565 // Search for initial settings:
566 for( const BOARD_STACKUP_ITEM* initial_item : m_list )
567 {
568 if( item->GetBrdLayerId() != UNDEFINED_LAYER )
569 {
570 if( item->GetBrdLayerId() == initial_item->GetBrdLayerId() )
571 {
572 *item = *initial_item;
573 found = true;
574 break;
575 }
576 }
577 else // dielectric layer: see m_DielectricLayerId for identification
578 {
579 // Compare dielectric layer with dielectric layer
580 if( initial_item->GetBrdLayerId() != UNDEFINED_LAYER )
581 continue;
582
583 if( item->GetDielectricLayerId() == initial_item->GetDielectricLayerId() )
584 {
585 *item = *initial_item;
586 found = true;
587 break;
588 }
589 }
590 }
591
592 if( !found )
593 {
594 change = true;
595 }
596 }
597
598 // Transfer layer settings:
599 *this = stackup;
600
601 // Transfer other stackup settings from aSettings
602 const BOARD_STACKUP& source_stackup = aSettings->GetStackupDescriptor();
605 m_EdgePlating = source_stackup.m_EdgePlating;
606 m_FinishType = source_stackup.m_FinishType;
607
608 return change;
609}
610
611
613 int aActiveCopperLayersCount )
614{
615 // Creates a default stackup, according to the current BOARD_DESIGN_SETTINGS settings.
616 // Note: the m_TypeName string is made translatable using _HKI marker, but is not
617 // translated when building the stackup.
618 // It will be used as this in files, and can be translated only in dialog
619 // if aSettings == NULL, build a full stackup (with 32 copper layers)
620 LSET enabledLayer = aSettings ? aSettings->GetEnabledLayers() : StackupAllowedBrdLayers();
621 int copperLayerCount = aSettings ? aSettings->GetCopperLayerCount() : 32;
622
623 // We need to calculate a suitable dielectric layer thickness.
624 // If no settings, and if aActiveCopperLayersCount is given, use it
625 // (If no settings, and no aActiveCopperLayersCount, the full 32 layers are used)
626 int activeCuLayerCount = copperLayerCount;
627
628 if( aSettings == nullptr && aActiveCopperLayersCount > 0 )
629 activeCuLayerCount = aActiveCopperLayersCount;
630
631 int brd__thickness = aSettings ? aSettings->GetBoardThickness() : pcbIUScale.mmToIU( 1.6 );
632 int diel_thickness = brd__thickness -
633 ( BOARD_STACKUP_ITEM::GetCopperDefaultThickness() * activeCuLayerCount );
634
635 // Take in account the solder mask thickness:
636 int sm_count = ( enabledLayer & LSET( { F_Mask, B_Mask } ) ).count();
637 diel_thickness -= BOARD_STACKUP_ITEM::GetMaskDefaultThickness() * sm_count;
638 diel_thickness /= std::max( 1, activeCuLayerCount - 1 );
639
640 int dielectric_idx = 0;
641
642 // Add silk screen, solder mask and solder paste layers on top
643 if( enabledLayer[F_SilkS] )
644 {
646 item->SetBrdLayerId( F_SilkS );
647 item->SetTypeName( _HKI( "Top Silk Screen" ) );
648 Add( item );
649 }
650
651 if( enabledLayer[F_Paste] )
652 {
654 item->SetBrdLayerId( F_Paste );
655 item->SetTypeName( _HKI( "Top Solder Paste" ) );
656 Add( item );
657 }
658
659 if( enabledLayer[F_Mask] )
660 {
662 item->SetBrdLayerId( F_Mask );
663 item->SetTypeName( _HKI( "Top Solder Mask" ) );
664 Add( item );
665 }
666
667 // Add copper and dielectric layers
668 for( PCB_LAYER_ID layer : enabledLayer.CuStack() )
669 {
671 item->SetBrdLayerId( layer );
672 item->SetTypeName( KEY_COPPER );
673 Add( item );
674
675 if( layer == B_Cu )
676 break;
677
678 // Add the dielectric layer:
680 item->SetThickness( diel_thickness );
681 item->SetDielectricLayerId( dielectric_idx + 1 );
682
683 // Display a dielectric default layer name:
684 if( (dielectric_idx & 1) == 0 )
685 {
686 item->SetTypeName( KEY_CORE );
687 item->SetMaterial( wxT( "FR4" ) );
688 }
689 else
690 {
691 item->SetTypeName( KEY_PREPREG );
692 item->SetMaterial( wxT( "FR4" ) );
693 }
694
695 Add( item );
696 dielectric_idx++;
697 }
698
699 // Add silk screen, solder mask and solder paste layers on bottom
700 if( enabledLayer[B_Mask] )
701 {
703 item->SetBrdLayerId( B_Mask );
704 item->SetTypeName( _HKI( "Bottom Solder Mask" ) );
705 Add( item );
706 }
707
708 if( enabledLayer[B_Paste] )
709 {
711 item->SetBrdLayerId( B_Paste );
712 item->SetTypeName( _HKI( "Bottom Solder Paste" ) );
713 Add( item );
714 }
715
716 if( enabledLayer[B_SilkS] )
717 {
719 item->SetBrdLayerId( B_SilkS );
720 item->SetTypeName( _HKI( "Bottom Silk Screen" ) );
721 Add( item );
722 }
723
724 // Transfer other stackup settings from aSettings
725 if( aSettings )
726 {
727 const BOARD_STACKUP& source_stackup = aSettings->GetStackupDescriptor();
730 m_EdgePlating = source_stackup.m_EdgePlating;
731 m_FinishType = source_stackup.m_FinishType;
732 }
733}
734
735
736void BOARD_STACKUP::FormatBoardStackup( OUTPUTFORMATTER* aFormatter, const BOARD* aBoard ) const
737{
738 // Board stackup is the ordered list from top to bottom of
739 // physical layers and substrate used to build the board.
740 if( m_list.empty() )
741 return;
742
743 aFormatter->Print( "(stackup" );
744
745 // Note:
746 // Unspecified parameters are not stored in file.
747 for( BOARD_STACKUP_ITEM* item: m_list )
748 {
749 wxString layer_name;
750
751 if( item->GetBrdLayerId() == UNDEFINED_LAYER )
752 layer_name.Printf( wxT( "dielectric %d" ), item->GetDielectricLayerId() );
753 else
754 layer_name = LSET::Name( item->GetBrdLayerId() );
755
756 aFormatter->Print( "(layer %s (type %s)",
757 aFormatter->Quotew( layer_name ).c_str(),
758 aFormatter->Quotew( item->GetTypeName() ).c_str() );
759
760 // Output other parameters (in sub layer list there is at least one item)
761 for( int idx = 0; idx < item->GetSublayersCount(); idx++ )
762 {
763 if( idx ) // not for the main (first) layer.
764 aFormatter->Print( " addsublayer" );
765
766 if( item->IsColorEditable() && IsPrmSpecified( item->GetColor( idx ) ) )
767 {
768 aFormatter->Print( "(color %s)",
769 aFormatter->Quotew( item->GetColor( idx ) ).c_str() );
770 }
771
772 if( item->IsThicknessEditable() )
773 {
774 aFormatter->Print( "(thickness %s",
775 EDA_UNIT_UTILS::FormatInternalUnits( pcbIUScale, item->GetThickness( idx ) ).c_str() );
776
777 if( item->GetType() == BS_ITEM_TYPE_DIELECTRIC && item->IsThicknessLocked( idx ) )
778 aFormatter->Print( " locked" );
779
780 aFormatter->Print( ")" );
781 }
782
783 if( item->HasMaterialValue( idx ) )
784 {
785 aFormatter->Print( "(material %s)",
786 aFormatter->Quotew( item->GetMaterial( idx ) ).c_str() );
787 }
788
789 if( item->HasEpsilonRValue() && item->HasMaterialValue( idx ) )
790 aFormatter->Print( "(epsilon_r %s)", FormatDouble2Str( item->GetEpsilonR( idx ) ).c_str() );
791
792 if( item->HasLossTangentValue() && item->HasMaterialValue( idx ) )
793 {
794 aFormatter->Print( "(loss_tangent %s)",
795 FormatDouble2Str( item->GetLossTangent( idx ) ).c_str() );
796 }
797 }
798
799 aFormatter->Print( ")" );
800 }
801
802 // Other infos about board, related to layers and other fabrication specifications
804 aFormatter->Print( "(copper_finish %s)", aFormatter->Quotew( m_FinishType ).c_str() );
805
806 KICAD_FORMAT::FormatBool( aFormatter, "dielectric_constraints", m_HasDielectricConstrains );
807
809 {
810 aFormatter->Print( "(edge_connector %s)",
811 m_EdgeConnectorConstraints > 1 ? "bevelled": "yes" );
812 }
813
814 if( m_EdgePlating )
815 KICAD_FORMAT::FormatBool( aFormatter, "edge_plating", true );
816
817 aFormatter->Print( ")" );
818}
819
820
821int BOARD_STACKUP::GetLayerDistance( PCB_LAYER_ID aFirstLayer, PCB_LAYER_ID aSecondLayer ) const
822{
823 wxASSERT( IsCopperLayer( aFirstLayer ) && IsCopperLayer( aSecondLayer ) );
824
825 if( aFirstLayer == aSecondLayer )
826 return 0;
827
828 // B_Cu is always the last copper layer but doesn't have the last numerical value
829 if( aSecondLayer != B_Cu && ( aSecondLayer < aFirstLayer || aFirstLayer == B_Cu ) )
830 std::swap( aFirstLayer, aSecondLayer );
831
832 int total = 0;
833 bool start = false;
834
835 for( BOARD_STACKUP_ITEM* item : m_list )
836 {
837 // Will be UNDEFINED_LAYER for dielectrics
838 PCB_LAYER_ID layer = item->GetBrdLayerId();
839
840 if( layer != UNDEFINED_LAYER && !IsCopperLayer( layer ) )
841 continue; // Silk/mask layer
842
843 // Reached the start copper layer? Start counting the next dielectric after it
844 if( !start && ( layer != UNDEFINED_LAYER && layer == aFirstLayer ) )
845 start = true;
846 else if( !start )
847 continue;
848
849 for( int sublayer = 0; sublayer < item->GetSublayersCount(); sublayer++ )
850 {
851 total += item->GetThickness( sublayer );
852 }
853
854 if( layer != UNDEFINED_LAYER && layer == aSecondLayer )
855 break;
856 }
857
858 return total;
859}
860
861
862bool IsPrmSpecified( const wxString& aPrmValue )
863{
864 // return true if the param value is specified:
865
866 if( !aPrmValue.IsEmpty()
867 && ( aPrmValue.CmpNoCase( NotSpecifiedPrm() ) != 0 )
868 && aPrmValue != wxGetTranslation( NotSpecifiedPrm() ) )
869 return true;
870
871 return false;
872}
constexpr EDA_IU_SCALE pcbIUScale
Definition: base_units.h:112
bool IsPrmSpecified(const wxString &aPrmValue)
@ BS_EDGE_CONNECTOR_NONE
Definition: board_stackup.h:57
BOARD_STACKUP_ITEM_TYPE
Definition: board_stackup.h:43
@ BS_ITEM_TYPE_UNDEFINED
Definition: board_stackup.h:44
@ BS_ITEM_TYPE_COPPER
Definition: board_stackup.h:45
@ BS_ITEM_TYPE_SILKSCREEN
Definition: board_stackup.h:51
@ BS_ITEM_TYPE_DIELECTRIC
Definition: board_stackup.h:46
@ BS_ITEM_TYPE_SOLDERPASTE
Definition: board_stackup.h:48
@ BS_ITEM_TYPE_SOLDERMASK
Definition: board_stackup.h:49
Container for design settings for a BOARD object.
const LSET & GetEnabledLayers() const
Return a bit-mask of all the layers that are enabled.
int GetBoardThickness() const
The full thickness of the board including copper and masks.
BOARD_STACKUP & GetStackupDescriptor()
Manage one layer needed to make a physical board.
Definition: board_stackup.h:96
void AddDielectricPrms(int aDielectricPrmsIdx)
Add (insert) a DIELECTRIC_PRMS item to m_DielectricPrmsList all values are set to default.
PCB_LAYER_ID m_LayerId
type name of layer (copper, silk screen, core, prepreg ...)
int GetSublayersCount() const
void SetDielectricLayerId(int aLayerId)
double GetEpsilonR(int aDielectricSubLayer=0) const
wxString GetColor(int aDielectricSubLayer=0) const
bool HasEpsilonRValue() const
void SetThickness(int aThickness, int aDielectricSubLayer=0)
bool IsMaterialEditable() const
BOARD_STACKUP_ITEM_TYPE m_Type
bool HasMaterialValue(int aDielectricSubLayer=0) const
void SetThicknessLocked(bool aLocked, int aDielectricSubLayer=0)
wxString FormatDielectricLayerName() const
void SetMaterial(const wxString &aName, int aDielectricSubLayer=0)
BOARD_STACKUP_ITEM(BOARD_STACKUP_ITEM_TYPE aType)
bool HasLossTangentValue() const
bool IsThicknessEditable() const
void SetLossTangent(double aTg, int aDielectricSubLayer=0)
int GetThickness(int aDielectricSubLayer=0) const
void SetEnabled(bool aEnable)
std::vector< DIELECTRIC_PRMS > m_DielectricPrmsList
the "layer" id for dielectric layers, from 1 (top) to 31 (bottom) (only 31 dielectric layers for 32 c...
static int GetMaskDefaultThickness()
wxString GetMaterial(int aDielectricSubLayer=0) const
wxString m_TypeName
name of layer as shown in layer manager. Useful to create reports
void SetBrdLayerId(PCB_LAYER_ID aBrdLayerId)
void SetTypeName(const wxString &aName)
bool IsThicknessLocked(int aDielectricSubLayer=0) const
wxString FormatEpsilonR(int aDielectricSubLayer=0) const
int m_DielectricLayerId
the layer id (F.Cu to B.Cu, F.Silk, B.silk, F.Mask, B.Mask) and UNDEFINED_LAYER (-1) for dielectric l...
void SetColor(const wxString &aColorName, int aDielectricSubLayer=0)
void SetEpsilonR(double aEpsilon, int aDielectricSubLayer=0)
void RemoveDielectricPrms(int aDielectricPrmsIdx)
Remove a DIELECTRIC_PRMS item from m_DielectricPrmsList.
int GetDielectricLayerId() const
bool operator==(const BOARD_STACKUP_ITEM &aOther) const
bool IsColorEditable() const
wxString FormatLossTangent(int aDielectricSubLayer=0) const
double GetLossTangent(int aDielectricSubLayer=0) const
static int GetCopperDefaultThickness()
Manage layers needed to make a physical board.
void RemoveAll()
Delete all items in list and clear the list.
const std::vector< BOARD_STACKUP_ITEM * > & GetList() const
static LSET StackupAllowedBrdLayers()
int GetCount() const
bool SynchronizeWithBoard(BOARD_DESIGN_SETTINGS *aSettings)
Synchronize the BOARD_STACKUP_ITEM* list with the board.
bool Deserialize(const google::protobuf::Any &aContainer) override
Deserializes the given protobuf message into this object.
bool operator==(const BOARD_STACKUP &aOther) const
int BuildBoardThicknessFromStackup() const
bool m_HasDielectricConstrains
True if some layers have impedance controlled tracks or have specific constrains for micro-wave appli...
void Add(BOARD_STACKUP_ITEM *aItem)
Add a new item in stackup layer.
void BuildDefaultStackupList(const BOARD_DESIGN_SETTINGS *aSettings, int aActiveCopperLayersCount=0)
Create a default stackup, according to the current BOARD_DESIGN_SETTINGS settings.
void Serialize(google::protobuf::Any &aContainer) const override
Serializes this object to the given Any message.
BOARD_STACKUP & operator=(const BOARD_STACKUP &aOther)
BOARD_STACKUP_ITEM * GetStackupLayer(int aIndex)
int GetLayerDistance(PCB_LAYER_ID aFirstLayer, PCB_LAYER_ID aSecondLayer) const
Calculate the distance (height) between the two given copper layers.
std::vector< BOARD_STACKUP_ITEM * > m_list
bool m_EdgePlating
True if the edge board is plated.
BS_EDGE_CONNECTOR_CONSTRAINTS m_EdgeConnectorConstraints
If the board has edge connector cards, some constrains can be specified in job file: BS_EDGE_CONNECTO...
void FormatBoardStackup(OUTPUTFORMATTER *aFormatter, const BOARD *aBoard) const
Write the stackup info on board file.
bool m_HasThicknessConstrains
True if some layers (copper and/or dielectric) have specific thickness.
wxString m_FinishType
The name of external copper finish.
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:317
A helper class to manage a dielectric layer set of parameters.
Definition: board_stackup.h:67
double m_EpsilonR
true for dielectric layers with a fixed thickness (for impedance controlled purposes),...
Definition: board_stackup.h:84
int m_Thickness
type of material (for dielectric and solder mask)
Definition: board_stackup.h:81
wxString m_Material
Definition: board_stackup.h:80
bool operator==(const DIELECTRIC_PRMS &aOther) const
wxString m_Color
For dielectric (and solder mask) the dielectric loss.
Definition: board_stackup.h:86
bool m_ThicknessLocked
the physical layer thickness in internal units
Definition: board_stackup.h:82
double m_LossTangent
For dielectric (and solder mask) the dielectric constant.
Definition: board_stackup.h:85
LSET is a set of PCB_LAYER_IDs.
Definition: lset.h:37
LSEQ CuStack() const
Return a sequence of copper layers in starting from the front/top and extending to the back/bottom.
Definition: lset.cpp:246
static wxString Name(PCB_LAYER_ID aLayerId)
Return the fixed name association with aLayerId.
Definition: lset.cpp:188
An interface used to output 8 bit text in a convenient way.
Definition: richio.h:322
std::string Quotew(const wxString &aWrapee) const
Definition: richio.cpp:548
int PRINTF_FUNC_N Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:463
#define _HKI(x)
#define _(s)
Some functions to handle hotkeys in KiCad.
bool IsCopperLayer(int aLayerId)
Test whether a layer is a copper layer.
Definition: layer_ids.h:665
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
@ F_Paste
Definition: layer_ids.h:104
@ B_Mask
Definition: layer_ids.h:98
@ B_Cu
Definition: layer_ids.h:65
@ F_Mask
Definition: layer_ids.h:97
@ B_Paste
Definition: layer_ids.h:105
@ F_SilkS
Definition: layer_ids.h:100
@ UNDEFINED_LAYER
Definition: layer_ids.h:61
@ B_SilkS
Definition: layer_ids.h:101
KICOMMON_API std::string FormatInternalUnits(const EDA_IU_SCALE &aIuScale, int aValue)
Converts aValue from internal units to a string appropriate for writing to file.
Definition: eda_units.cpp:194
void FormatBool(OUTPUTFORMATTER *aOut, const wxString &aKey, bool aValue)
Writes a boolean to the formatter, in the style (aKey [yes|no])
wxString NotSpecifiedPrm()
#define KEY_PREPREG
#define KEY_COPPER
#define KEY_CORE
#define DEFAULT_EPSILON_R_SILKSCREEN
#define DEFAULT_EPSILON_R_SOLDERMASK
std::string UIDouble2Str(double aValue)
Print a float number without using scientific notation and no trailing 0 We want to avoid scientific ...
std::string FormatDouble2Str(double aValue)
Print a float number without using scientific notation and no trailing 0 This function is intended in...
constexpr int mmToIU(double mm) const
Definition: base_units.h:92