KiCad PCB EDA Suite
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 (C) 2009-2021 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 <convert_to_biu.h>
24 #include <base_units.h>
25 #include <string_utils.h>
26 #include <layer_ids.h>
27 #include <board_design_settings.h>
28 #include <board.h>
29 #include <i18n_utility.h> // For _HKI definition
31 #include <string_utils.h> // for Double2Str()
32 
33 
35 {
36  DIELECTRIC_PRMS item_prms;
37  m_DielectricPrmsList.emplace_back( item_prms );
39  m_Type = aType;
41  SetEnabled( true );
42 
43  // Initialize parameters to a usual value for allowed types:
44  switch( m_Type )
45  {
49  break;
50 
52  m_TypeName = KEY_CORE; // or prepreg
53  SetMaterial( "FR4" ); // or other dielectric name
54  SetLossTangent( 0.02 ); // for FR4
55  SetEpsilonR( 4.5 ); // for FR4
56  break;
57 
59  m_TypeName = "solderpaste";
60  break;
61 
63  m_TypeName = "soldermask";
64  m_Color = "Green";
65  SetMaterial( NotSpecifiedPrm() ); // or other solder mask material name
68  break;
69 
71  m_TypeName = "silkscreen";
73  SetMaterial( NotSpecifiedPrm() ); // or other silkscreen material name
75  break;
76 
78  break;
79  }
80 }
81 
82 
84 {
85  m_LayerId = aOther.m_LayerId;
87  m_Type = aOther.m_Type;
88  m_enabled = aOther.m_enabled;
90  m_TypeName = aOther.m_TypeName;
91  m_LayerName = aOther.m_LayerName;
92  m_Color = aOther.GetColor();
93 }
94 
95 
96 void BOARD_STACKUP_ITEM::AddDielectricPrms( int aDielectricPrmsIdx )
97 {
98  // add a DIELECTRIC_PRMS item to m_DielectricPrmsList
99  DIELECTRIC_PRMS new_prms;
100 
101  m_DielectricPrmsList.emplace( m_DielectricPrmsList.begin() + aDielectricPrmsIdx,
102  new_prms );
103 }
104 
105 
106 void BOARD_STACKUP_ITEM::RemoveDielectricPrms( int aDielectricPrmsIdx )
107 {
108  // Remove a DIELECTRIC_PRMS item from m_DielectricPrmsList if possible
109 
110  if( GetSublayersCount() < 2 || aDielectricPrmsIdx < 0
111  || aDielectricPrmsIdx >= GetSublayersCount() )
112  return;
113 
114  m_DielectricPrmsList.erase( m_DielectricPrmsList.begin() + aDielectricPrmsIdx );
115 }
116 
117 
118 
120 {
121  // A reasonable thickness for copper layers:
122  return Millimeter2iu( 0.035 );
123 }
124 
125 
127 {
128  // A reasonable thickness for solder mask:
129  return Millimeter2iu( 0.01 );
130 }
131 
132 
133 // Getters:
134 int BOARD_STACKUP_ITEM::GetThickness( int aDielectricSubLayer ) const
135 {
136  wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
137 
138  return m_DielectricPrmsList[aDielectricSubLayer].m_Thickness;
139 }
140 
141 
142 double BOARD_STACKUP_ITEM::GetLossTangent( int aDielectricSubLayer ) const
143 {
144  wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
145 
146  return m_DielectricPrmsList[aDielectricSubLayer].m_LossTangent;
147 }
148 
149 
150 double BOARD_STACKUP_ITEM::GetEpsilonR( int aDielectricSubLayer ) const
151 {
152  wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
153 
154  return m_DielectricPrmsList[aDielectricSubLayer].m_EpsilonR;
155 }
156 
157 
158 bool BOARD_STACKUP_ITEM::IsThicknessLocked( int aDielectricSubLayer ) const
159 {
160  wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
161 
162  return m_DielectricPrmsList[aDielectricSubLayer].m_ThicknessLocked;
163 }
164 
165 
166 wxString BOARD_STACKUP_ITEM::GetMaterial( int aDielectricSubLayer ) const
167 {
168  wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
169 
170  return m_DielectricPrmsList[aDielectricSubLayer].m_Material;
171 }
172 
173 
174 // Setters:
175 void BOARD_STACKUP_ITEM::SetThickness( int aThickness, int aDielectricSubLayer )
176 {
177  wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
178 
179  if( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() )
180  m_DielectricPrmsList[aDielectricSubLayer].m_Thickness = aThickness;
181 }
182 
183 
184 void BOARD_STACKUP_ITEM::SetLossTangent( double aTg, int aDielectricSubLayer )
185 {
186  wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
187 
188  if( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() )
189  m_DielectricPrmsList[aDielectricSubLayer].m_LossTangent = aTg;
190 }
191 
192 
193 void BOARD_STACKUP_ITEM::SetEpsilonR( double aEpsilon, int aDielectricSubLayer )
194 {
195  wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
196 
197  if( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() )
198  m_DielectricPrmsList[aDielectricSubLayer].m_EpsilonR = aEpsilon;
199 }
200 
201 
202 void BOARD_STACKUP_ITEM::SetThicknessLocked( bool aLocked, int aDielectricSubLayer )
203 {
204  wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
205 
206  if( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() )
207  m_DielectricPrmsList[aDielectricSubLayer].m_ThicknessLocked = aLocked;
208 }
209 
210 
211 void BOARD_STACKUP_ITEM::SetMaterial( const wxString& aName, int aDielectricSubLayer )
212 {
213  wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
214 
215  if( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() )
216  m_DielectricPrmsList[aDielectricSubLayer].m_Material = aName;
217 }
218 
219 
221 {
224  //|| m_Type == BS_ITEM_TYPE_SILKSCREEN
225  ;
226 };
227 
228 
230 {
233 };
234 
235 
236 bool BOARD_STACKUP_ITEM::HasMaterialValue( int aDielectricSubLayer ) const
237 {
238  // return true if the material is specified
239  return IsMaterialEditable() && IsPrmSpecified( GetMaterial( aDielectricSubLayer ) );
240 }
241 
242 
244 {
245  // The material is editable only for dielectric
246  return m_Type == BS_ITEM_TYPE_DIELECTRIC ||
249 }
250 
251 
253 {
255 }
256 
257 
259 {
260  switch( m_Type )
261  {
262  case BS_ITEM_TYPE_COPPER:
263  return true;
264 
266  return true;
267 
269  return true;
270 
272  return false;
273 
275  return false;
276 
277  default:
278  break;
279  }
280 
281  return false;
282 }
283 
284 
285 wxString BOARD_STACKUP_ITEM::FormatEpsilonR( int aDielectricSubLayer ) const
286 {
287  // return a wxString to print/display Epsilon R
288  // note: we do not want scientific notation
289  wxString txt = Double2Str( GetEpsilonR( aDielectricSubLayer ) );
290  return txt;
291 }
292 
293 
294 wxString BOARD_STACKUP_ITEM::FormatLossTangent( int aDielectricSubLayer ) const
295 {
296  // return a wxString to print/display Loss Tangent
297  // note: we do not want scientific notation
298  wxString txt = Double2Str( GetLossTangent( aDielectricSubLayer ) );
299  return txt;
300 }
301 
302 
304 {
305  // return a wxString to print/display a dielectric name
306  wxString lname;
307  lname.Printf( _( "Dielectric %d" ), GetDielectricLayerId() );
308 
309  return lname;
310 }
311 
312 
314 {
315  m_HasDielectricConstrains = false; // True if some dielectric layers have constrains
316  // (Loss tg and Epison R)
317  m_HasThicknessConstrains = false; // True if some dielectric or copper layers have constrains
319  m_CastellatedPads = false; // True if some castellated pads exist
320  m_EdgePlating = false; // True if edge board is plated
321  m_FinishType = "None"; // undefined finish type
322 }
323 
324 
326 {
331  m_EdgePlating = aOther.m_EdgePlating;
332  m_FinishType = aOther.m_FinishType;
333 
334  // All items in aOther.m_list have to be duplicated, because aOther.m_list
335  // manage pointers to these items
336  for( auto item : aOther.m_list )
337  {
338  BOARD_STACKUP_ITEM* dup_item = new BOARD_STACKUP_ITEM( *item );
339  Add( dup_item );
340  }
341 }
342 
343 
345 {
350  m_EdgePlating = aOther.m_EdgePlating;
351  m_FinishType = aOther.m_FinishType;
352 
353  RemoveAll();
354 
355  // All items in aOther.m_list have to be duplicated, because aOther.m_list
356  // manage pointers to these items
357  for( auto item : aOther.m_list )
358  {
359  BOARD_STACKUP_ITEM* dup_item = new BOARD_STACKUP_ITEM( *item );
360  Add( dup_item );
361  }
362 
363  return *this;
364 }
365 
366 
368 {
369  for( auto item : m_list )
370  delete item;
371 
372  m_list.clear();
373 }
374 
375 
377 {
378  if( aIndex < 0 || aIndex >= GetCount() )
379  return nullptr;
380 
381  return GetList()[aIndex];
382 }
383 
384 
386 {
387  // return the board thickness from the thickness of BOARD_STACKUP_ITEM list
388  int thickness = 0;
389 
390  for( auto item : m_list )
391  {
392  if( item->IsThicknessEditable() && item->IsEnabled() )
393  thickness += item->GetThickness();
394  }
395 
396  return thickness;
397 }
398 
399 
401 {
402  bool change = false;
403  // Build the suitable stackup:
404  BOARD_STACKUP stackup;
405  stackup.BuildDefaultStackupList( aSettings );
406 
407  // First, find removed layers:
408  for( BOARD_STACKUP_ITEM* curr_item: m_list )
409  {
410  bool found = false;
411 
412  for( BOARD_STACKUP_ITEM* item: stackup.GetList() )
413  {
414  if( curr_item->GetBrdLayerId() != UNDEFINED_LAYER )
415  {
416  if( item->GetBrdLayerId() == curr_item->GetBrdLayerId() )
417  {
418  found = true;
419  break;
420  }
421  }
422  else // curr_item = dielectric layer
423  {
424  if( item->GetBrdLayerId() != UNDEFINED_LAYER )
425  continue;
426 
427  if( item->GetDielectricLayerId() == curr_item->GetDielectricLayerId() )
428  {
429  found = true;
430  break;
431  }
432  }
433  }
434 
435  if( !found ) // a layer was removed: a change is found
436  {
437  change = true;
438  break;
439  }
440  }
441 
442  // Now initialize all stackup items to the initial values, when exist
443  for( BOARD_STACKUP_ITEM* item : stackup.GetList() )
444  {
445  bool found = false;
446  // Search for initial settings:
447  for( const BOARD_STACKUP_ITEM* initial_item : m_list )
448  {
449  if( item->GetBrdLayerId() != UNDEFINED_LAYER )
450  {
451  if( item->GetBrdLayerId() == initial_item->GetBrdLayerId() )
452  {
453  *item = *initial_item;
454  found = true;
455  break;
456  }
457  }
458  else // dielectric layer: see m_DielectricLayerId for identification
459  {
460  // Compare dielectric layer with dielectric layer
461  if( initial_item->GetBrdLayerId() != UNDEFINED_LAYER )
462  continue;
463 
464  if( item->GetDielectricLayerId() == initial_item->GetDielectricLayerId() )
465  {
466  *item = *initial_item;
467  found = true;
468  break;
469  }
470  }
471  }
472 
473  if( !found )
474  {
475  change = true;
476  }
477  }
478 
479  // Transfert layer settings:
480  *this = stackup;
481 
482  // Transfer other stackup settings from aSettings
483  const BOARD_STACKUP& source_stackup = aSettings->GetStackupDescriptor();
486  m_CastellatedPads = source_stackup.m_CastellatedPads;
487  m_EdgePlating = source_stackup.m_EdgePlating;
488  m_FinishType = source_stackup.m_FinishType;
489 
490  return change;
491 }
492 
493 
495  int aActiveCopperLayersCount )
496 {
497  // Creates a default stackup, according to the current BOARD_DESIGN_SETTINGS settings.
498  // Note: the m_TypeName string is made translatable using _HKI marker, but is not
499  // translated when building the stackup.
500  // It will be used as this in files, and can be translated only in dialog
501  // if aSettings == NULL, build a full stackup (with 32 copper layers)
502  LSET enabledLayer = aSettings ? aSettings->GetEnabledLayers() : StackupAllowedBrdLayers();
503  int copperLayerCount = aSettings ? aSettings->GetCopperLayerCount() : B_Cu+1;
504 
505  // We need to calculate a suitable dielectric layer thickness.
506  // If no settings, and if aActiveCopperLayersCount is given, use it
507  // (If no settings, and no aActiveCopperLayersCount, the full 32 layers are used)
508  int activeCuLayerCount = copperLayerCount;
509 
510  if( aSettings == nullptr && aActiveCopperLayersCount > 0 )
511  activeCuLayerCount = aActiveCopperLayersCount;
512 
513  int brd__thickness = aSettings ? aSettings->GetBoardThickness() : Millimeter2iu( 1.6 );
514  int diel_thickness = brd__thickness -
515  ( BOARD_STACKUP_ITEM::GetCopperDefaultThickness() * activeCuLayerCount );
516 
517  // Take in account the solder mask thickness:
518  int sm_count = ( enabledLayer & LSET( 2, F_Mask, B_Mask) ).count();
519  diel_thickness -= BOARD_STACKUP_ITEM::GetMaskDefaultThickness() * sm_count;
520  diel_thickness /= std::max( 1, activeCuLayerCount - 1 );
521 
522  int dielectric_idx = 0;
523 
524  // Add silk screen, solder mask and solder paste layers on top
525  if( enabledLayer[F_SilkS] )
526  {
528  item->SetBrdLayerId( F_SilkS );
529  item->SetTypeName( _HKI( "Top Silk Screen" ) );
530  Add( item );
531  }
532 
533  if( enabledLayer[F_Paste] )
534  {
536  item->SetBrdLayerId( F_Paste );
537  item->SetTypeName( _HKI( "Top Solder Paste" ) );
538  Add( item );
539  }
540 
541  if( enabledLayer[F_Mask] )
542  {
544  item->SetBrdLayerId( F_Mask );
545  item->SetTypeName( _HKI( "Top Solder Mask" ) );
546  Add( item );
547  }
548 
549  // Add copper and dielectric layers
550  for( int ii = 0; ii < copperLayerCount; ii++ )
551  {
553  item->SetBrdLayerId( ( PCB_LAYER_ID )ii );
554  item->SetTypeName( KEY_COPPER );
555  Add( item );
556 
557  if( ii == copperLayerCount-1 )
558  {
559  item->SetBrdLayerId( B_Cu );
560  break;
561  }
562 
563  // Add the dielectric layer:
565  item->SetThickness( diel_thickness );
566  item->SetDielectricLayerId( dielectric_idx + 1 );
567 
568  // Display a dielectric default layer name:
569  if( (dielectric_idx & 1) == 0 )
570  {
571  item->SetTypeName( KEY_CORE );
572  item->SetMaterial( "FR4" );
573  }
574  else
575  {
576  item->SetTypeName( KEY_PREPREG );
577  item->SetMaterial( "FR4" );
578  }
579 
580  Add( item );
581  dielectric_idx++;
582  }
583 
584  // Add silk screen, solder mask and solder paste layers on bottom
585  if( enabledLayer[B_Mask] )
586  {
588  item->SetBrdLayerId( B_Mask );
589  item->SetTypeName( _HKI( "Bottom Solder Mask" ) );
590  Add( item );
591  }
592 
593  if( enabledLayer[B_Paste] )
594  {
596  item->SetBrdLayerId( B_Paste );
597  item->SetTypeName( _HKI( "Bottom Solder Paste" ) );
598  Add( item );
599  }
600 
601  if( enabledLayer[B_SilkS] )
602  {
604  item->SetBrdLayerId( B_SilkS );
605  item->SetTypeName( _HKI( "Bottom Silk Screen" ) );
606  Add( item );
607  }
608 
609  // Transfer other stackup settings from aSettings
610  if( aSettings )
611  {
612  const BOARD_STACKUP& source_stackup = aSettings->GetStackupDescriptor();
614  m_CastellatedPads = source_stackup.m_CastellatedPads;
615  m_EdgePlating = source_stackup.m_EdgePlating;
616  m_FinishType = source_stackup.m_FinishType;
617  }
618 }
619 
620 
622  const BOARD* aBoard, int aNestLevel ) const
623 {
624  // Board stackup is the ordered list from top to bottom of
625  // physical layers and substrate used to build the board.
626  if( m_list.empty() )
627  return;
628 
629  aFormatter->Print( aNestLevel, "(stackup\n" );
630  int nest_level = aNestLevel+1;
631 
632  // Note:
633  // Unspecified parameters are not stored in file.
634  for( BOARD_STACKUP_ITEM* item: m_list )
635  {
636  wxString layer_name;
637 
638  if( item->GetBrdLayerId() == UNDEFINED_LAYER )
639  layer_name.Printf( "dielectric %d", item->GetDielectricLayerId() );
640  else
641  layer_name = LSET::Name( item->GetBrdLayerId() );
642 
643  aFormatter->Print( nest_level, "(layer %s (type %s)",
644  aFormatter->Quotew( layer_name ).c_str(),
645  aFormatter->Quotew( item->GetTypeName() ).c_str() );
646 
647  if( item->IsColorEditable() && IsPrmSpecified( item->GetColor() ) )
648  aFormatter->Print( 0, " (color %s)",
649  aFormatter->Quotew( item->GetColor() ).c_str() );
650 
651  for( int idx = 0; idx < item->GetSublayersCount(); idx++ )
652  {
653  if( idx ) // not for the main (first) layer.
654  {
655  aFormatter->Print( 0, "\n" );
656  aFormatter->Print( nest_level+1, "addsublayer" );
657  }
658 
659  if( item->IsThicknessEditable() )
660  {
661  if( item->GetType() == BS_ITEM_TYPE_DIELECTRIC && item->IsThicknessLocked( idx ) )
662  aFormatter->Print( 0, " (thickness %s locked)",
663  FormatInternalUnits( item->GetThickness( idx ) ).c_str() );
664  else
665  aFormatter->Print( 0, " (thickness %s)",
666  FormatInternalUnits( item->GetThickness( idx ) ).c_str() );
667  }
668 
669  if( item->HasMaterialValue( idx ) )
670  aFormatter->Print( 0, " (material %s)",
671  aFormatter->Quotew( item->GetMaterial( idx ) ).c_str() );
672 
673  if( item->HasEpsilonRValue() && item->HasMaterialValue( idx ) )
674  aFormatter->Print( 0, " (epsilon_r %g)", item->GetEpsilonR( idx ) );
675 
676  if( item->HasLossTangentValue() && item->HasMaterialValue( idx ) )
677  aFormatter->Print( 0, " (loss_tangent %s)",
678  Double2Str(item->GetLossTangent( idx ) ).c_str() );
679  }
680 
681  aFormatter->Print( 0, ")\n" );
682  }
683 
684  // Other infos about board, related to layers and other fabrication specifications
686  aFormatter->Print( nest_level, "(copper_finish %s)\n",
687  aFormatter->Quotew( m_FinishType ).c_str() );
688 
689  aFormatter->Print( nest_level, "(dielectric_constraints %s)\n",
690  m_HasDielectricConstrains ? "yes" : "no" );
691 
693  aFormatter->Print( nest_level, "(edge_connector %s)\n",
694  m_EdgeConnectorConstraints > 1 ? "bevelled": "yes" );
695 
696  if( m_CastellatedPads )
697  aFormatter->Print( nest_level, "(castellated_pads yes)\n" );
698 
699  if( m_EdgePlating )
700  aFormatter->Print( nest_level, "(edge_plating yes)\n" );
701 
702  aFormatter->Print( aNestLevel, ")\n" );
703 }
704 
705 
706 int BOARD_STACKUP::GetLayerDistance( PCB_LAYER_ID aFirstLayer, PCB_LAYER_ID aSecondLayer ) const
707 {
708  wxASSERT( IsCopperLayer( aFirstLayer ) && IsCopperLayer( aSecondLayer ) );
709 
710  if( aFirstLayer == aSecondLayer )
711  return 0;
712 
713  if( aSecondLayer < aFirstLayer )
714  std::swap( aFirstLayer, aSecondLayer );
715 
716  int total = 0;
717  bool start = false;
718  bool half = false;
719 
720  for( BOARD_STACKUP_ITEM* item : m_list )
721  {
722  // Will be UNDEFINED_LAYER for dielectrics
723  PCB_LAYER_ID layer = item->GetBrdLayerId();
724 
725  if( layer != UNDEFINED_LAYER && !IsCopperLayer( layer ) )
726  continue; // Silk/mask layer
727 
728  // Reached the start copper layer? Start counting the next dielectric after it
729  if( !start && ( layer != UNDEFINED_LAYER && layer >= aFirstLayer ) )
730  {
731  start = true;
732  half = true;
733  }
734  else if( !start )
735  continue;
736 
737  // Reached the stop copper layer? we're done
738  if( start && ( layer != UNDEFINED_LAYER && layer >= aSecondLayer ) )
739  half = true;
740 
741  for( int sublayer = 0; sublayer < item->GetSublayersCount(); sublayer++ )
742  {
743  int subThickness = item->GetThickness( sublayer );
744  total += half ? ( subThickness / 2 ) : subThickness;
745  }
746 
747  half = false;
748 
749  if( layer != UNDEFINED_LAYER && layer >= aSecondLayer )
750  break;
751  }
752 
753  return total;
754 }
755 
756 
757 bool IsPrmSpecified( const wxString& aPrmValue )
758 {
759  // return true if the param value is specified:
760 
761  if( !aPrmValue.IsEmpty()
762  && ( aPrmValue.CmpNoCase( NotSpecifiedPrm() ) != 0 )
763  && aPrmValue != wxGetTranslation( NotSpecifiedPrm() ) )
764  return true;
765 
766  return false;
767 }
#define DEFAULT_EPSILON_R_SOLDERMASK
bool HasEpsilonRValue() const
void SetBrdLayerId(PCB_LAYER_ID aBrdLayerId)
void SetTypeName(const wxString &aName)
BOARD_STACKUP_ITEM * GetStackupLayer(int aIndex)
BOARD_STACKUP_ITEM_TYPE
Definition: board_stackup.h:40
bool HasMaterialValue(int aDielectricSubLayer=0) const
Manage layers needed to make a physical board.
Implementation of conversion functions that require both schematic and board internal units.
int GetSublayersCount() const
wxString m_FinishType
The name of external copper finish.
bool m_EdgePlating
True if the edge board is plated.
bool IsThicknessLocked(int aDielectricSubLayer=0) const
int GetLayerDistance(PCB_LAYER_ID aFirstLayer, PCB_LAYER_ID aSecondLayer) const
Calculate the distance (height) between the two given copper layers.
BS_EDGE_CONNECTOR_CONSTRAINTS m_EdgeConnectorConstraints
If the board has edge connector cards, some constrains can be specified in job file: BS_EDGE_CONNECTO...
bool m_CastellatedPads
True if castellated pads exist.
#define KEY_COPPER
wxString GetColor() const
An interface used to output 8 bit text in a convenient way.
Definition: richio.h:309
wxString m_TypeName
name of layer as shown in layer manager. Useful to create reports
BOARD_STACKUP & operator=(const BOARD_STACKUP &aOther)
double GetLossTangent(int aDielectricSubLayer=0) const
static int GetCopperDefaultThickness()
bool SynchronizeWithBoard(BOARD_DESIGN_SETTINGS *aSettings)
Synchronize the BOARD_STACKUP_ITEM* list with the board.
int BuildBoardThicknessFromStackup() const
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...
bool m_HasDielectricConstrains
True if some layers have impedance controlled tracks or have specific constrains for micro-wave appli...
BOARD_STACKUP & GetStackupDescriptor()
bool IsThicknessEditable() const
LSET is a set of PCB_LAYER_IDs.
Definition: layer_ids.h:504
static LSET StackupAllowedBrdLayers()
static const wxChar * Name(PCB_LAYER_ID aLayerId)
Return the fixed name association with aLayerId.
Definition: lset.cpp:82
wxString NotSpecifiedPrm()
int GetThickness(int aDielectricSubLayer=0) const
bool IsColorEditable() const
void SetDielectricLayerId(int aLayerId)
bool HasLossTangentValue() const
A helper class to manage a dielectric layer set of parameters.
Definition: board_stackup.h:64
double GetEpsilonR(int aDielectricSubLayer=0) const
PCB_LAYER_ID m_LayerId
mainly for silkscreen and solder mask
wxString FormatEpsilonR(int aDielectricSubLayer=0) const
bool IsMaterialEditable() const
#define _(s)
wxString FormatLossTangent(int aDielectricSubLayer=0) const
void SetMaterial(const wxString &aName, int aDielectricSubLayer=0)
std::vector< BOARD_STACKUP_ITEM * > m_list
int GetCount() const
#define KEY_PREPREG
bool m_HasThicknessConstrains
True if some layers (copper and/or dielectric) have specific thickness.
Manage one layer needed to make a physical board.
Definition: board_stackup.h:89
void SetEpsilonR(double aEpsilon, int aDielectricSubLayer=0)
const std::vector< BOARD_STACKUP_ITEM * > & GetList() const
void FormatBoardStackup(OUTPUTFORMATTER *aFormatter, const BOARD *aBoard, int aNestLevel) const
Write the stackup info on board file.
bool IsCopperLayer(LAYER_NUM aLayerId)
Tests whether a layer is a copper layer.
Definition: layer_ids.h:796
void AddDielectricPrms(int aDielectricPrmsIdx)
Add (insert) a DIELECTRIC_PRMS item to m_DielectricPrmsList all values are set to default.
void SetThickness(int aThickness, int aDielectricSubLayer=0)
Some functions to handle hotkeys in KiCad.
static int GetMaskDefaultThickness()
#define DEFAULT_EPSILON_R_SILKSCREEN
void SetThicknessLocked(bool aLocked, int aDielectricSubLayer=0)
wxString m_Color
type name of layer (copper, silk screen, core, prepreg ...)
void RemoveAll()
Delete all items in list and clear the list.
BOARD_STACKUP_ITEM(BOARD_STACKUP_ITEM_TYPE aType)
bool IsPrmSpecified(const wxString &aPrmValue)
int GetDielectricLayerId() const
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
LSET GetEnabledLayers() const
Return a bit-mask of all the layers that are enabled.
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:65
std::string Double2Str(double aValue)
Print a float number without using scientific notation and no trailing 0 We want to avoid scientific ...
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:426
#define KEY_CORE
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.
BOARD_STACKUP_ITEM_TYPE m_Type
static constexpr int Millimeter2iu(double mm)
#define _HKI(x)
void SetLossTangent(double aTg, int aDielectricSubLayer=0)
wxString GetMaterial(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...
std::string FormatInternalUnits(int aValue)
Function FormatInternalUnits converts aValue from internal units to a string appropriate for writing ...
Definition: base_units.cpp:485
wxString FormatDielectricLayerName() const
std::string Quotew(const wxString &aWrapee) const
Definition: richio.cpp:494
Container for design settings for a BOARD object.
void SetEnabled(bool aEnable)
void RemoveDielectricPrms(int aDielectricPrmsIdx)
Remove a DIELECTRIC_PRMS item from m_DielectricPrmsList.