KiCad PCB EDA Suite
BOARD_STACKUP_ITEM Class Reference

this class manage one layer needed to make a physical board it can be a solder mask, silk screen, copper or a dielectric More...

#include <class_board_stackup.h>

Public Member Functions

 BOARD_STACKUP_ITEM (BOARD_STACKUP_ITEM_TYPE aType)
 
 BOARD_STACKUP_ITEM (BOARD_STACKUP_ITEM &aOther)
 
void AddDielectricPrms (int aDielectricPrmsIdx)
 true if this stackup item must be taken in account, false to ignore it. More...
 
void RemoveDielectricPrms (int aDielectricPrmsIdx)
 Remove a DIELECTRIC_PRMS item from m_DielectricPrmsList. More...
 
bool HasEpsilonRValue () const
 
bool HasLossTangentValue () const
 
bool HasMaterialValue (int aDielectricSubLayer=0) const
 
bool IsMaterialEditable () const
 
bool IsColorEditable () const
 
bool IsThicknessEditable () const
 
int GetSublayersCount () const
 
wxString FormatEpsilonR (int aDielectricSubLayer=0) const
 
wxString FormatLossTangent (int aDielectricSubLayer=0) const
 
wxString FormatDielectricLayerName () const
 
bool IsEnabled () const
 
BOARD_STACKUP_ITEM_TYPE GetType () const
 
PCB_LAYER_ID GetBrdLayerId () const
 
wxString GetColor () const
 
wxString GetLayerName () const
 
wxString GetTypeName () const
 
int GetDielectricLayerId () const
 
int GetThickness (int aDielectricSubLayer=0) const
 
bool IsThicknessLocked (int aDielectricSubLayer=0) const
 
double GetEpsilonR (int aDielectricSubLayer=0) const
 
double GetLossTangent (int aDielectricSubLayer=0) const
 
wxString GetMaterial (int aDielectricSubLayer=0) const
 
void SetEnabled (bool aEnable)
 
void SetBrdLayerId (PCB_LAYER_ID aBrdLayerId)
 
void SetColor (const wxString &aColorName)
 
void SetLayerName (const wxString &aName)
 
void SetTypeName (const wxString &aName)
 
void SetDielectricLayerId (int aLayerId)
 
void SetThickness (int aThickness, int aDielectricSubLayer=0)
 
void SetThicknessLocked (bool aLocked, int aDielectricSubLayer=0)
 
void SetEpsilonR (double aEpsilon, int aDielectricSubLayer=0)
 
void SetLossTangent (double aTg, int aDielectricSubLayer=0)
 
void SetMaterial (const wxString &aName, int aDielectricSubLayer=0)
 

Static Public Member Functions

static int GetCopperDefaultThickness ()
 
static int GetMaskDefaultThickness ()
 

Private Attributes

BOARD_STACKUP_ITEM_TYPE m_Type
 
wxString m_LayerName
 
wxString m_TypeName
 name of layer as shown in layer manager. Usefull to create reports More...
 
wxString m_Color
 type name of layer (copper, silk screen, core, prepreg ...) More...
 
PCB_LAYER_ID m_LayerId
 mainly for silkscreen and solder mask More...
 
int m_DielectricLayerId
 the layer id (F.Cu to B.Cu, F.Silk, B.silk, F.Mask, B.Mask) and UNDEFINED_LAYER (-1) for dielectic layers that are not really layers for the board editor More...
 
std::vector< DIELECTRIC_PRMSm_DielectricPrmsList
 the "layer" id for dielectric layers, from 1 (top) to 31 (bottom) (only 31 dielectric layers for 32 copper layers) More...
 
bool m_enabled
 

Detailed Description

this class manage one layer needed to make a physical board it can be a solder mask, silk screen, copper or a dielectric

Definition at line 87 of file class_board_stackup.h.

Constructor & Destructor Documentation

◆ BOARD_STACKUP_ITEM() [1/2]

BOARD_STACKUP_ITEM::BOARD_STACKUP_ITEM ( BOARD_STACKUP_ITEM_TYPE  aType)

Definition at line 32 of file class_board_stackup.cpp.

33 {
34  DIELECTRIC_PRMS item_prms;
35  m_DielectricPrmsList.emplace_back( item_prms );
37  m_Type = aType;
39  SetEnabled( true );
40 
41  // Initialize parameters to a usual value for allowed types:
42  switch( m_Type )
43  {
47  break;
48 
50  m_TypeName = KEY_CORE; // or prepreg
51  SetMaterial( "FR4" ); // or other dielectric name
52  SetLossTangent( 0.02 ); // for FR4
53  SetEpsilonR( 4.5 ); // for FR4
54  break;
55 
57  m_TypeName = "solderpaste";
58  break;
59 
61  m_TypeName = "soldermask";
62  m_Color = "Green";
63  SetMaterial( NotSpecifiedPrm() ); // or other solder mask material name
66  break;
67 
69  m_TypeName = "silkscreen";
71  SetMaterial( NotSpecifiedPrm() ); // or other silkscreen material name
73  break;
74 
76  break;
77  }
78 }
#define DEFAULT_EPSILON_R_SOLDERMASK
#define KEY_COPPER
wxString m_TypeName
name of layer as shown in layer manager. Usefull to create reports
static int GetCopperDefaultThickness()
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...
wxString NotSpecifiedPrm()
void SetDielectricLayerId(int aLayerId)
A helper class to manage a dielectric layer set of parameters.
PCB_LAYER_ID m_LayerId
mainly for silkscreen and solder mask
void SetMaterial(const wxString &aName, int aDielectricSubLayer=0)
void SetEpsilonR(double aEpsilon, int aDielectricSubLayer=0)
void SetThickness(int aThickness, int aDielectricSubLayer=0)
static int GetMaskDefaultThickness()
#define DEFAULT_EPSILON_R_SILKSCREEN
wxString m_Color
type name of layer (copper, silk screen, core, prepreg ...)
#define KEY_CORE
BOARD_STACKUP_ITEM_TYPE m_Type
void SetLossTangent(double aTg, int aDielectricSubLayer=0)
void SetEnabled(bool aEnable)

References BS_ITEM_TYPE_COPPER, BS_ITEM_TYPE_DIELECTRIC, BS_ITEM_TYPE_SILKSCREEN, BS_ITEM_TYPE_SOLDERMASK, BS_ITEM_TYPE_SOLDERPASTE, BS_ITEM_TYPE_UNDEFINED, DEFAULT_EPSILON_R_SILKSCREEN, DEFAULT_EPSILON_R_SOLDERMASK, GetCopperDefaultThickness(), GetMaskDefaultThickness(), KEY_COPPER, KEY_CORE, m_Color, m_DielectricPrmsList, m_LayerId, m_Type, m_TypeName, NotSpecifiedPrm(), SetDielectricLayerId(), SetEnabled(), SetEpsilonR(), SetLossTangent(), SetMaterial(), SetThickness(), and UNDEFINED_LAYER.

◆ BOARD_STACKUP_ITEM() [2/2]

BOARD_STACKUP_ITEM::BOARD_STACKUP_ITEM ( BOARD_STACKUP_ITEM aOther)

Definition at line 81 of file class_board_stackup.cpp.

82 {
83  m_LayerId = aOther.m_LayerId;
85  m_Type = aOther.m_Type;
86  m_enabled = aOther.m_enabled;
88  m_TypeName = aOther.m_TypeName;
89  m_LayerName = aOther.m_LayerName;
90  m_Color = aOther.GetColor();
91 }
wxString GetColor() const
wxString m_TypeName
name of layer as shown in layer manager. Usefull to create reports
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...
PCB_LAYER_ID m_LayerId
mainly for silkscreen and solder mask
wxString m_Color
type name of layer (copper, silk screen, core, prepreg ...)
BOARD_STACKUP_ITEM_TYPE m_Type
int m_DielectricLayerId
the layer id (F.Cu to B.Cu, F.Silk, B.silk, F.Mask, B.Mask) and UNDEFINED_LAYER (-1) for dielectic la...

References GetColor(), m_Color, m_DielectricLayerId, m_DielectricPrmsList, m_enabled, m_LayerId, m_LayerName, m_Type, and m_TypeName.

Member Function Documentation

◆ AddDielectricPrms()

void BOARD_STACKUP_ITEM::AddDielectricPrms ( int  aDielectricPrmsIdx)

true if this stackup item must be taken in account, false to ignore it.

Mainly used in dialog stackup editor. add (insert) a DIELECTRIC_PRMS item to m_DielectricPrmsList all values are set to default

Parameters
aDielectricPrmsIdxis a index in m_DielectricPrmsList the new item will be inserted at this position

Definition at line 94 of file class_board_stackup.cpp.

95 {
96  // add a DIELECTRIC_PRMS item to m_DielectricPrmsList
97  DIELECTRIC_PRMS new_prms;
98 
99  m_DielectricPrmsList.emplace( m_DielectricPrmsList.begin() + aDielectricPrmsIdx,
100  new_prms );
101 }
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...
A helper class to manage a dielectric layer set of parameters.

References m_DielectricPrmsList.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::loadBoardStackup(), PANEL_SETUP_BOARD_STACKUP::onAddDielectricLayer(), PCB_PARSER::parseBoardStackup(), and PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup().

◆ FormatDielectricLayerName()

wxString BOARD_STACKUP_ITEM::FormatDielectricLayerName ( ) const
Returns
a wxString to print/display a dielectric name

Definition at line 299 of file class_board_stackup.cpp.

300 {
301  // return a wxString to print/display a dielectriv name
302  wxString lname;
303  lname.Printf( _( "Dielectric %d" ), GetDielectricLayerId() );
304 
305  return lname;
306 }
int GetDielectricLayerId() const
#define _(s)
Definition: 3d_actions.cpp:33

References _, and GetDielectricLayerId().

Referenced by PANEL_SETUP_BOARD_STACKUP::createRowData(), and PANEL_SETUP_BOARD_STACKUP::onAddDielectricLayer().

◆ FormatEpsilonR()

wxString BOARD_STACKUP_ITEM::FormatEpsilonR ( int  aDielectricSubLayer = 0) const
Returns
a wxString to print/display Epsilon R

Definition at line 281 of file class_board_stackup.cpp.

282 {
283  // return a wxString to print/display Epsilon R
284  wxString txt;
285  txt.Printf( "%.2f", GetEpsilonR( aDielectricSubLayer ) );
286  return txt;
287 }
double GetEpsilonR(int aDielectricSubLayer=0) const

References GetEpsilonR().

Referenced by GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), and PANEL_SETUP_BOARD_STACKUP::onMaterialChange().

◆ FormatLossTangent()

wxString BOARD_STACKUP_ITEM::FormatLossTangent ( int  aDielectricSubLayer = 0) const
Returns
a wxString to print/display Loss Tangent

Definition at line 290 of file class_board_stackup.cpp.

291 {
292  // return a wxString to print/display Loss Tangent
293  wxString txt;
294  txt.Printf( "%g", GetLossTangent( aDielectricSubLayer ) );
295  return txt;
296 }
double GetLossTangent(int aDielectricSubLayer=0) const

References GetLossTangent().

Referenced by GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), and PANEL_SETUP_BOARD_STACKUP::onMaterialChange().

◆ GetBrdLayerId()

PCB_LAYER_ID BOARD_STACKUP_ITEM::GetBrdLayerId ( ) const
inline

◆ GetColor()

wxString BOARD_STACKUP_ITEM::GetColor ( ) const
inline

◆ GetCopperDefaultThickness()

int BOARD_STACKUP_ITEM::GetCopperDefaultThickness ( )
static
Returns
a reasonable default value for a copper layer thickness

Definition at line 116 of file class_board_stackup.cpp.

117 {
118  // A reasonable thickness for copper layers:
119  return Millimeter2iu( 0.035 );
120 }
static constexpr int Millimeter2iu(double mm)

References Millimeter2iu().

Referenced by BOARD_STACKUP_ITEM(), and BOARD_STACKUP::BuildDefaultStackupList().

◆ GetDielectricLayerId()

int BOARD_STACKUP_ITEM::GetDielectricLayerId ( ) const
inline

Definition at line 177 of file class_board_stackup.h.

177 { return m_DielectricLayerId; }
int m_DielectricLayerId
the layer id (F.Cu to B.Cu, F.Silk, B.silk, F.Mask, B.Mask) and UNDEFINED_LAYER (-1) for dielectic la...

References m_DielectricLayerId.

Referenced by GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), FormatDielectricLayerName(), and PANEL_SETUP_BOARD_STACKUP::showOnlyActiveLayers().

◆ GetEpsilonR()

double BOARD_STACKUP_ITEM::GetEpsilonR ( int  aDielectricSubLayer = 0) const

Definition at line 146 of file class_board_stackup.cpp.

147 {
148  wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
149 
150  return m_DielectricPrmsList[aDielectricSubLayer].m_EpsilonR;
151 }
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...

References GetSublayersCount(), and m_DielectricPrmsList.

Referenced by GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), PANEL_SETUP_BOARD_STACKUP::createRowData(), FormatEpsilonR(), and PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard().

◆ GetLayerName()

wxString BOARD_STACKUP_ITEM::GetLayerName ( ) const
inline

◆ GetLossTangent()

double BOARD_STACKUP_ITEM::GetLossTangent ( int  aDielectricSubLayer = 0) const

Definition at line 138 of file class_board_stackup.cpp.

139 {
140  wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
141 
142  return m_DielectricPrmsList[aDielectricSubLayer].m_LossTangent;
143 }
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...

References GetSublayersCount(), and m_DielectricPrmsList.

Referenced by GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), PANEL_SETUP_BOARD_STACKUP::createRowData(), FormatLossTangent(), and PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard().

◆ GetMaskDefaultThickness()

int BOARD_STACKUP_ITEM::GetMaskDefaultThickness ( )
static
Returns
a reasonable default value for a solder mask layer thickness

Definition at line 123 of file class_board_stackup.cpp.

124 {
125  // A reasonable thickness for solder mask:
126  return Millimeter2iu( 0.01 );
127 }
static constexpr int Millimeter2iu(double mm)

References Millimeter2iu().

Referenced by BOARD_STACKUP_ITEM(), and BOARD_STACKUP::BuildDefaultStackupList().

◆ GetMaterial()

wxString BOARD_STACKUP_ITEM::GetMaterial ( int  aDielectricSubLayer = 0) const

Definition at line 162 of file class_board_stackup.cpp.

163 {
164  wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
165 
166  return m_DielectricPrmsList[aDielectricSubLayer].m_Material;
167 }
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...

References GetSublayersCount(), and m_DielectricPrmsList.

Referenced by GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), PANEL_SETUP_BOARD_STACKUP::createRowData(), HasMaterialValue(), PANEL_SETUP_BOARD_STACKUP::onMaterialChange(), PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard(), and PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup().

◆ GetSublayersCount()

int BOARD_STACKUP_ITEM::GetSublayersCount ( ) const
inline
Returns
a the number of sublayers in a dielectric layer. the count is >= 1 (there is at least one layer)

Definition at line 158 of file class_board_stackup.h.

158 { return m_DielectricPrmsList.size(); }
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...

References m_DielectricPrmsList.

Referenced by GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), PANEL_SETUP_BOARD_STACKUP::createRowData(), GetEpsilonR(), GetLossTangent(), GetMaterial(), GetThickness(), IsThicknessLocked(), PANEL_SETUP_BOARD_STACKUP::onAddDielectricLayer(), RemoveDielectricPrms(), SetEpsilonR(), SetLossTangent(), SetMaterial(), SetThickness(), SetThicknessLocked(), and PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup().

◆ GetThickness()

int BOARD_STACKUP_ITEM::GetThickness ( int  aDielectricSubLayer = 0) const

Definition at line 130 of file class_board_stackup.cpp.

131 {
132  wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
133 
134  return m_DielectricPrmsList[aDielectricSubLayer].m_Thickness;
135 }
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...

References GetSublayersCount(), and m_DielectricPrmsList.

Referenced by GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), PANEL_SETUP_BOARD_STACKUP::createRowData(), PANEL_SETUP_BOARD_STACKUP::onCalculateDielectricThickness(), and PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard().

◆ GetType()

◆ GetTypeName()

wxString BOARD_STACKUP_ITEM::GetTypeName ( ) const
inline

Definition at line 176 of file class_board_stackup.h.

176 { return m_TypeName; }
wxString m_TypeName
name of layer as shown in layer manager. Usefull to create reports

References m_TypeName.

Referenced by GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), PANEL_SETUP_BOARD_STACKUP::createRowData(), and PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard().

◆ HasEpsilonRValue()

bool BOARD_STACKUP_ITEM::HasEpsilonRValue ( ) const
Returns
true if the layer has a meaningfull Epsilon R parameter namely dielectric layers: dielectric and solder mask

Definition at line 216 of file class_board_stackup.cpp.

217 {
220  //|| m_Type == BS_ITEM_TYPE_SILKSCREEN
221  ;
222 };
BOARD_STACKUP_ITEM_TYPE m_Type

References BS_ITEM_TYPE_DIELECTRIC, BS_ITEM_TYPE_SOLDERMASK, and m_Type.

Referenced by PANEL_SETUP_BOARD_STACKUP::createRowData(), PANEL_SETUP_BOARD_STACKUP::onMaterialChange(), PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard(), and PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup().

◆ HasLossTangentValue()

bool BOARD_STACKUP_ITEM::HasLossTangentValue ( ) const
Returns
true if the layer has a meaningfull Dielectric Loss parameter namely dielectric layers: dielectric and solder mask

Definition at line 225 of file class_board_stackup.cpp.

References BS_ITEM_TYPE_DIELECTRIC, BS_ITEM_TYPE_SOLDERMASK, and m_Type.

Referenced by PANEL_SETUP_BOARD_STACKUP::createRowData(), PANEL_SETUP_BOARD_STACKUP::onMaterialChange(), PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard(), and PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup().

◆ HasMaterialValue()

bool BOARD_STACKUP_ITEM::HasMaterialValue ( int  aDielectricSubLayer = 0) const
Returns
true if the material is specified

Definition at line 232 of file class_board_stackup.cpp.

233 {
234  // return true if the material is specified
235  return IsMaterialEditable() && IsPrmSpecified( GetMaterial( aDielectricSubLayer ) );
236 }
bool IsPrmSpecified(const wxString &aPrmValue)
wxString GetMaterial(int aDielectricSubLayer=0) const

References GetMaterial(), IsMaterialEditable(), and IsPrmSpecified().

Referenced by GERBER_JOBFILE_WRITER::addJSONMaterialStackup().

◆ IsColorEditable()

◆ IsEnabled()

bool BOARD_STACKUP_ITEM::IsEnabled ( ) const
inline

Definition at line 170 of file class_board_stackup.h.

170 {return m_enabled; }

References m_enabled.

◆ IsMaterialEditable()

bool BOARD_STACKUP_ITEM::IsMaterialEditable ( ) const

◆ IsThicknessEditable()

bool BOARD_STACKUP_ITEM::IsThicknessEditable ( ) const

◆ IsThicknessLocked()

bool BOARD_STACKUP_ITEM::IsThicknessLocked ( int  aDielectricSubLayer = 0) const

Definition at line 154 of file class_board_stackup.cpp.

155 {
156  wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
157 
158  return m_DielectricPrmsList[aDielectricSubLayer].m_ThicknessLocked;
159 }
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...

References GetSublayersCount(), and m_DielectricPrmsList.

Referenced by PANEL_SETUP_BOARD_STACKUP::createRowData(), and PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard().

◆ RemoveDielectricPrms()

void BOARD_STACKUP_ITEM::RemoveDielectricPrms ( int  aDielectricPrmsIdx)

Remove a DIELECTRIC_PRMS item from m_DielectricPrmsList.

Parameters
aDielectricPrmsIdxis the index of the parameters set to remove in m_DielectricPrmsList

Definition at line 104 of file class_board_stackup.cpp.

105 {
106  // Remove a DIELECTRIC_PRMS item from m_DielectricPrmsList if possible
107 
108  if( GetSublayersCount() < 2 || aDielectricPrmsIdx < 0 || aDielectricPrmsIdx >= GetSublayersCount() )
109  return;
110 
111  m_DielectricPrmsList.erase( m_DielectricPrmsList.begin() + aDielectricPrmsIdx );
112 }
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...

References GetSublayersCount(), and m_DielectricPrmsList.

Referenced by PANEL_SETUP_BOARD_STACKUP::onRemoveDielectricLayer().

◆ SetBrdLayerId()

void BOARD_STACKUP_ITEM::SetBrdLayerId ( PCB_LAYER_ID  aBrdLayerId)
inline

Definition at line 187 of file class_board_stackup.h.

187 { m_LayerId = aBrdLayerId; }
PCB_LAYER_ID m_LayerId
mainly for silkscreen and solder mask

References m_LayerId.

Referenced by BOARD_STACKUP::BuildDefaultStackupList(), CADSTAR_PCB_ARCHIVE_LOADER::loadBoardStackup(), and PCB_PARSER::parseBoardStackup().

◆ SetColor()

void BOARD_STACKUP_ITEM::SetColor ( const wxString &  aColorName)
inline

Definition at line 188 of file class_board_stackup.h.

188 { m_Color = aColorName; }
wxString m_Color
type name of layer (copper, silk screen, core, prepreg ...)

References m_Color.

Referenced by PCB_PARSER::parseBoardStackup(), and PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup().

◆ SetDielectricLayerId()

void BOARD_STACKUP_ITEM::SetDielectricLayerId ( int  aLayerId)
inline

Definition at line 191 of file class_board_stackup.h.

191 { m_DielectricLayerId = aLayerId; }
int m_DielectricLayerId
the layer id (F.Cu to B.Cu, F.Silk, B.silk, F.Mask, B.Mask) and UNDEFINED_LAYER (-1) for dielectic la...

References m_DielectricLayerId.

Referenced by BOARD_STACKUP_ITEM(), BOARD_STACKUP::BuildDefaultStackupList(), CADSTAR_PCB_ARCHIVE_LOADER::loadBoardStackup(), and PCB_PARSER::parseBoardStackup().

◆ SetEnabled()

void BOARD_STACKUP_ITEM::SetEnabled ( bool  aEnable)
inline

Definition at line 186 of file class_board_stackup.h.

186 { m_enabled = aEnable; }

References m_enabled.

Referenced by BOARD_STACKUP_ITEM(), and PANEL_SETUP_BOARD_STACKUP::showOnlyActiveLayers().

◆ SetEpsilonR()

void BOARD_STACKUP_ITEM::SetEpsilonR ( double  aEpsilon,
int  aDielectricSubLayer = 0 
)

Definition at line 189 of file class_board_stackup.cpp.

190 {
191  wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
192 
193  if( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() )
194  m_DielectricPrmsList[aDielectricSubLayer].m_EpsilonR = aEpsilon;
195 }
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...

References GetSublayersCount(), and m_DielectricPrmsList.

Referenced by BOARD_STACKUP_ITEM(), CADSTAR_PCB_ARCHIVE_LOADER::loadBoardStackup(), PANEL_SETUP_BOARD_STACKUP::onMaterialChange(), PCB_PARSER::parseBoardStackup(), and PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup().

◆ SetLayerName()

void BOARD_STACKUP_ITEM::SetLayerName ( const wxString &  aName)
inline

◆ SetLossTangent()

void BOARD_STACKUP_ITEM::SetLossTangent ( double  aTg,
int  aDielectricSubLayer = 0 
)

Definition at line 180 of file class_board_stackup.cpp.

181 {
182  wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
183 
184  if( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() )
185  m_DielectricPrmsList[aDielectricSubLayer].m_LossTangent = aTg;
186 }
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...

References GetSublayersCount(), and m_DielectricPrmsList.

Referenced by BOARD_STACKUP_ITEM(), CADSTAR_PCB_ARCHIVE_LOADER::loadBoardStackup(), PANEL_SETUP_BOARD_STACKUP::onMaterialChange(), PCB_PARSER::parseBoardStackup(), and PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup().

◆ SetMaterial()

void BOARD_STACKUP_ITEM::SetMaterial ( const wxString &  aName,
int  aDielectricSubLayer = 0 
)

Definition at line 207 of file class_board_stackup.cpp.

208 {
209  wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
210 
211  if( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() )
212  m_DielectricPrmsList[aDielectricSubLayer].m_Material = aName;
213 }
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...

References GetSublayersCount(), and m_DielectricPrmsList.

Referenced by BOARD_STACKUP_ITEM(), BOARD_STACKUP::BuildDefaultStackupList(), CADSTAR_PCB_ARCHIVE_LOADER::loadBoardStackup(), PANEL_SETUP_BOARD_STACKUP::onMaterialChange(), PCB_PARSER::parseBoardStackup(), and PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup().

◆ SetThickness()

void BOARD_STACKUP_ITEM::SetThickness ( int  aThickness,
int  aDielectricSubLayer = 0 
)

Definition at line 171 of file class_board_stackup.cpp.

172 {
173  wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
174 
175  if( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() )
176  m_DielectricPrmsList[aDielectricSubLayer].m_Thickness = aThickness;
177 }
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...

References GetSublayersCount(), and m_DielectricPrmsList.

Referenced by BOARD_STACKUP_ITEM(), BOARD_STACKUP::BuildDefaultStackupList(), CADSTAR_PCB_ARCHIVE_LOADER::loadBoardStackup(), PANEL_SETUP_BOARD_STACKUP::onCalculateDielectricThickness(), PANEL_SETUP_BOARD_STACKUP::onThicknessChange(), PCB_PARSER::parseBoardStackup(), and PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup().

◆ SetThicknessLocked()

void BOARD_STACKUP_ITEM::SetThicknessLocked ( bool  aLocked,
int  aDielectricSubLayer = 0 
)

Definition at line 198 of file class_board_stackup.cpp.

199 {
200  wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
201 
202  if( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() )
203  m_DielectricPrmsList[aDielectricSubLayer].m_ThicknessLocked = aLocked;
204 }
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...

References GetSublayersCount(), and m_DielectricPrmsList.

Referenced by PCB_PARSER::parseBoardStackup(), and PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup().

◆ SetTypeName()

void BOARD_STACKUP_ITEM::SetTypeName ( const wxString &  aName)
inline

Definition at line 190 of file class_board_stackup.h.

190 { m_TypeName = aName; }
wxString m_TypeName
name of layer as shown in layer manager. Usefull to create reports

References m_TypeName.

Referenced by BOARD_STACKUP::BuildDefaultStackupList(), CADSTAR_PCB_ARCHIVE_LOADER::loadBoardStackup(), PCB_PARSER::parseBoardStackup(), and PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup().

Member Data Documentation

◆ m_Color

wxString BOARD_STACKUP_ITEM::m_Color
private

type name of layer (copper, silk screen, core, prepreg ...)

Definition at line 98 of file class_board_stackup.h.

Referenced by BOARD_STACKUP_ITEM(), GetColor(), and SetColor().

◆ m_DielectricLayerId

int BOARD_STACKUP_ITEM::m_DielectricLayerId
private

the layer id (F.Cu to B.Cu, F.Silk, B.silk, F.Mask, B.Mask) and UNDEFINED_LAYER (-1) for dielectic layers that are not really layers for the board editor

Definition at line 102 of file class_board_stackup.h.

Referenced by BOARD_STACKUP_ITEM(), GetDielectricLayerId(), and SetDielectricLayerId().

◆ m_DielectricPrmsList

std::vector<DIELECTRIC_PRMS> BOARD_STACKUP_ITEM::m_DielectricPrmsList
private

the "layer" id for dielectric layers, from 1 (top) to 31 (bottom) (only 31 dielectric layers for 32 copper layers)

List of dielectric parameters usually only one item, but in complex (microwave) boards, one can have more than one dielectic layer between 2 copper layers, and therfore more than one item in list

Definition at line 109 of file class_board_stackup.h.

Referenced by AddDielectricPrms(), BOARD_STACKUP_ITEM(), GetEpsilonR(), GetLossTangent(), GetMaterial(), GetSublayersCount(), GetThickness(), IsThicknessLocked(), RemoveDielectricPrms(), SetEpsilonR(), SetLossTangent(), SetMaterial(), SetThickness(), and SetThicknessLocked().

◆ m_enabled

bool BOARD_STACKUP_ITEM::m_enabled
private

Definition at line 111 of file class_board_stackup.h.

Referenced by BOARD_STACKUP_ITEM(), IsEnabled(), and SetEnabled().

◆ m_LayerId

PCB_LAYER_ID BOARD_STACKUP_ITEM::m_LayerId
private

mainly for silkscreen and solder mask

Definition at line 99 of file class_board_stackup.h.

Referenced by BOARD_STACKUP_ITEM(), GetBrdLayerId(), and SetBrdLayerId().

◆ m_LayerName

wxString BOARD_STACKUP_ITEM::m_LayerName
private

Definition at line 96 of file class_board_stackup.h.

Referenced by BOARD_STACKUP_ITEM(), GetLayerName(), and SetLayerName().

◆ m_Type

◆ m_TypeName

wxString BOARD_STACKUP_ITEM::m_TypeName
private

name of layer as shown in layer manager. Usefull to create reports

Definition at line 97 of file class_board_stackup.h.

Referenced by BOARD_STACKUP_ITEM(), GetTypeName(), and SetTypeName().


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