KiCad PCB EDA Suite
BOARD_STACKUP_ITEM Class Reference

Manage one layer needed to make a physical board. More...

#include <board_stackup.h>

Public Member Functions

 BOARD_STACKUP_ITEM (BOARD_STACKUP_ITEM_TYPE aType)
 
 BOARD_STACKUP_ITEM (const BOARD_STACKUP_ITEM &aOther)
 
void AddDielectricPrms (int aDielectricPrmsIdx)
 Add (insert) a DIELECTRIC_PRMS item to m_DielectricPrmsList all values are set to default. 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 GetLayerName () const
 
wxString GetTypeName () const
 
int GetDielectricLayerId () const
 
wxString GetColor (int aDielectricSubLayer=0) 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 SetLayerName (const wxString &aName)
 
void SetTypeName (const wxString &aName)
 
void SetDielectricLayerId (int aLayerId)
 
void SetColor (const wxString &aColorName, int aDielectricSubLayer=0)
 
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. Useful to create reports More...
 
PCB_LAYER_ID m_LayerId
 type name of layer (copper, silk screen, core, prepreg ...) 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 dielectric 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

Manage one layer needed to make a physical board.

It can be a solder mask, silk screen, copper or a dielectric.

Definition at line 90 of file 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 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
52 SetMaterial( wxT( "FR4" ) ); // or other dielectric name
53 SetLossTangent( 0.02 ); // for FR4
54 SetEpsilonR( 4.5 ); // for FR4
55 break;
56
58 m_TypeName = wxT( "solderpaste" );
59 break;
60
62 m_TypeName = wxT( "soldermask" );
64 SetMaterial( NotSpecifiedPrm() ); // or other solder mask material name
67 break;
68
70 m_TypeName = wxT( "silkscreen" );
72 SetMaterial( NotSpecifiedPrm() ); // or other silkscreen material name
74 break;
75
77 break;
78 }
79}
@ BS_ITEM_TYPE_UNDEFINED
Definition: board_stackup.h:42
@ BS_ITEM_TYPE_COPPER
Definition: board_stackup.h:43
@ BS_ITEM_TYPE_SILKSCREEN
Definition: board_stackup.h:49
@ BS_ITEM_TYPE_DIELECTRIC
Definition: board_stackup.h:44
@ BS_ITEM_TYPE_SOLDERPASTE
Definition: board_stackup.h:46
@ BS_ITEM_TYPE_SOLDERMASK
Definition: board_stackup.h:47
PCB_LAYER_ID m_LayerId
type name of layer (copper, silk screen, core, prepreg ...)
void SetDielectricLayerId(int aLayerId)
void SetThickness(int aThickness, int aDielectricSubLayer=0)
BOARD_STACKUP_ITEM_TYPE m_Type
void SetMaterial(const wxString &aName, int aDielectricSubLayer=0)
void SetLossTangent(double aTg, int aDielectricSubLayer=0)
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 m_TypeName
name of layer as shown in layer manager. Useful to create reports
void SetColor(const wxString &aColorName, int aDielectricSubLayer=0)
void SetEpsilonR(double aEpsilon, int aDielectricSubLayer=0)
static int GetCopperDefaultThickness()
A helper class to manage a dielectric layer set of parameters.
Definition: board_stackup.h:65
@ UNDEFINED_LAYER
Definition: layer_ids.h:60
wxString NotSpecifiedPrm()
#define KEY_COPPER
#define KEY_CORE
#define DEFAULT_EPSILON_R_SILKSCREEN
#define DEFAULT_EPSILON_R_SOLDERMASK

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_DielectricPrmsList, m_LayerId, m_Type, m_TypeName, NotSpecifiedPrm(), SetColor(), SetDielectricLayerId(), SetEnabled(), SetEpsilonR(), SetLossTangent(), SetMaterial(), SetThickness(), and UNDEFINED_LAYER.

◆ BOARD_STACKUP_ITEM() [2/2]

BOARD_STACKUP_ITEM::BOARD_STACKUP_ITEM ( const BOARD_STACKUP_ITEM aOther)

Definition at line 82 of file board_stackup.cpp.

83{
84 m_LayerId = aOther.m_LayerId;
86 m_Type = aOther.m_Type;
87 m_enabled = aOther.m_enabled;
89 m_TypeName = aOther.m_TypeName;
90 m_LayerName = aOther.m_LayerName;
91}
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...

References 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)

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 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, new_prms );
100}

References m_DielectricPrmsList.

Referenced by 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 board_stackup.cpp.

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

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

282{
283 // return a wxString to print/display Epsilon R
284 // note: we do not want scientific notation
285 wxString txt = UIDouble2Str( GetEpsilonR( aDielectricSubLayer ) );
286 return txt;
287}
double GetEpsilonR(int aDielectricSubLayer=0) const
std::string UIDouble2Str(double aValue)
Print a float number without using scientific notation and no trailing 0 We want to avoid scientific ...

References GetEpsilonR(), and UIDouble2Str().

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

291{
292 // return a wxString to print/display Loss Tangent
293 // note: we do not want scientific notation
294 wxString txt = UIDouble2Str( GetLossTangent( aDielectricSubLayer ) );
295 return txt;
296}
double GetLossTangent(int aDielectricSubLayer=0) const

References GetLossTangent(), and UIDouble2Str().

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

◆ GetBrdLayerId()

◆ GetColor()

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

◆ GetCopperDefaultThickness()

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

Definition at line 119 of file board_stackup.cpp.

120{
121 // A reasonable thickness for copper layers:
122 return pcbIUScale.mmToIU( 0.035 );
123}
constexpr EDA_IU_SCALE pcbIUScale
Definition: base_units.h:109
constexpr int mmToIU(double mm) const
Definition: base_units.h:89

References EDA_IU_SCALE::mmToIU(), and pcbIUScale.

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

◆ GetDielectricLayerId()

int BOARD_STACKUP_ITEM::GetDielectricLayerId ( ) const
inline

◆ GetEpsilonR()

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

Definition at line 157 of file board_stackup.cpp.

158{
159 wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
160
161 return m_DielectricPrmsList[aDielectricSubLayer].m_EpsilonR;
162}

References GetSublayersCount(), and m_DielectricPrmsList.

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

◆ GetLayerName()

wxString BOARD_STACKUP_ITEM::GetLayerName ( ) const
inline

Definition at line 155 of file board_stackup.h.

155{ return m_LayerName; }

References m_LayerName.

Referenced by PANEL_SETUP_BOARD_STACKUP::createRowData(), and DRAWING_TOOL::DrawSpecificationStackup().

◆ GetLossTangent()

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

Definition at line 149 of file board_stackup.cpp.

150{
151 wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
152
153 return m_DielectricPrmsList[aDielectricSubLayer].m_LossTangent;
154}

References GetSublayersCount(), and m_DielectricPrmsList.

Referenced by GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), PANEL_SETUP_BOARD_STACKUP::createRowData(), DRAWING_TOOL::DrawSpecificationStackup(), 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 126 of file board_stackup.cpp.

127{
128 // A reasonable thickness for solder mask:
129 return pcbIUScale.mmToIU( 0.01 );
130}

References EDA_IU_SCALE::mmToIU(), and pcbIUScale.

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

◆ GetMaterial()

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

◆ GetSublayersCount()

◆ GetThickness()

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

Definition at line 141 of file board_stackup.cpp.

142{
143 wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
144
145 return m_DielectricPrmsList[aDielectricSubLayer].m_Thickness;
146}

References GetSublayersCount(), and m_DielectricPrmsList.

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

◆ GetType()

◆ GetTypeName()

wxString BOARD_STACKUP_ITEM::GetTypeName ( ) const
inline

◆ HasEpsilonRValue()

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

Definition at line 236 of file board_stackup.cpp.

237{
240};

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 meaningfully Dielectric Loss parameter namely dielectric layers: dielectric and solder mask

Definition at line 243 of file board_stackup.cpp.

244{
247};

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 250 of file board_stackup.cpp.

251{
252 // return true if the material is specified
253 return IsMaterialEditable() && IsPrmSpecified( GetMaterial( aDielectricSubLayer ) );
254}
bool IsPrmSpecified(const wxString &aPrmValue)
bool IsMaterialEditable() const
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 151 of file board_stackup.h.

151{ return m_enabled; }

References m_enabled.

◆ IsMaterialEditable()

◆ IsThicknessEditable()

◆ IsThicknessLocked()

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

Definition at line 165 of file board_stackup.cpp.

166{
167 wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
168
169 return m_DielectricPrmsList[aDielectricSubLayer].m_ThicknessLocked;
170}

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 103 of file board_stackup.cpp.

104{
105 // Remove a DIELECTRIC_PRMS item from m_DielectricPrmsList if possible
106
107 if( GetSublayersCount() < 2
108 || aDielectricPrmsIdx < 0
109 || aDielectricPrmsIdx >= GetSublayersCount() )
110 {
111 return;
112 }
113
114 m_DielectricPrmsList.erase( m_DielectricPrmsList.begin() + aDielectricPrmsIdx );
115}

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 168 of file board_stackup.h.

168{ m_LayerId = aBrdLayerId; }

References m_LayerId.

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

◆ SetColor()

void BOARD_STACKUP_ITEM::SetColor ( const wxString &  aColorName,
int  aDielectricSubLayer = 0 
)

Definition at line 182 of file board_stackup.cpp.

183{
184 wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
185
186 if( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() )
187 m_DielectricPrmsList[aDielectricSubLayer].m_Color = aColorName;
188}

References GetSublayersCount(), and m_DielectricPrmsList.

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

◆ SetDielectricLayerId()

void BOARD_STACKUP_ITEM::SetDielectricLayerId ( int  aLayerId)
inline

◆ SetEnabled()

void BOARD_STACKUP_ITEM::SetEnabled ( bool  aEnable)
inline

Definition at line 167 of file board_stackup.h.

167{ 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 209 of file board_stackup.cpp.

210{
211 wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
212
213 if( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() )
214 m_DielectricPrmsList[aDielectricSubLayer].m_EpsilonR = aEpsilon;
215}

References GetSublayersCount(), and m_DielectricPrmsList.

Referenced by BOARD_STACKUP_ITEM(), CADSTAR_PCB_ARCHIVE_LOADER::initStackupItem(), 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 200 of file board_stackup.cpp.

201{
202 wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
203
204 if( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() )
205 m_DielectricPrmsList[aDielectricSubLayer].m_LossTangent = aTg;
206}

References GetSublayersCount(), and m_DielectricPrmsList.

Referenced by BOARD_STACKUP_ITEM(), CADSTAR_PCB_ARCHIVE_LOADER::initStackupItem(), 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 227 of file board_stackup.cpp.

228{
229 wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
230
231 if( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() )
232 m_DielectricPrmsList[aDielectricSubLayer].m_Material = aName;
233}

References GetSublayersCount(), and m_DielectricPrmsList.

Referenced by BOARD_STACKUP_ITEM(), BOARD_STACKUP::BuildDefaultStackupList(), CADSTAR_PCB_ARCHIVE_LOADER::initStackupItem(), 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 191 of file board_stackup.cpp.

192{
193 wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
194
195 if( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() )
196 m_DielectricPrmsList[aDielectricSubLayer].m_Thickness = aThickness;
197}

References GetSublayersCount(), and m_DielectricPrmsList.

Referenced by BOARD_STACKUP_ITEM(), BOARD_STACKUP::BuildDefaultStackupList(), CADSTAR_PCB_ARCHIVE_LOADER::initStackupItem(), 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 218 of file board_stackup.cpp.

219{
220 wxASSERT( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() );
221
222 if( aDielectricSubLayer >= 0 && aDielectricSubLayer < GetSublayersCount() )
223 m_DielectricPrmsList[aDielectricSubLayer].m_ThicknessLocked = aLocked;
224}

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

Member Data Documentation

◆ 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 dielectric layers that are not really layers for the board editor

Definition at line 187 of file 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 dielectric layer between 2 copper layers, and therefore more than one item in list

Definition at line 194 of file board_stackup.h.

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

◆ m_enabled

bool BOARD_STACKUP_ITEM::m_enabled
private

Definition at line 196 of file board_stackup.h.

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

◆ m_LayerId

PCB_LAYER_ID BOARD_STACKUP_ITEM::m_LayerId
private

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

Definition at line 184 of file board_stackup.h.

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

◆ m_LayerName

wxString BOARD_STACKUP_ITEM::m_LayerName
private

Definition at line 182 of file 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. Useful to create reports

Definition at line 183 of file board_stackup.h.

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


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