KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
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)
 
bool operator== (const BOARD_STACKUP_ITEM &aOther) const
 
bool operator!= (const BOARD_STACKUP_ITEM &aOther) const
 
void AddDielectricPrms (int aDielectricPrmsIdx)
 Add (insert) a DIELECTRIC_PRMS item to m_DielectricPrmsList all values are set to default.
 
void RemoveDielectricPrms (int aDielectricPrmsIdx)
 Remove a DIELECTRIC_PRMS item from m_DielectricPrmsList.
 
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
 
PCB_LAYER_ID m_LayerId
 type name of layer (copper, silk screen, core, prepreg ...)
 
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
 
std::vector< DIELECTRIC_PRMS > m_DielectricPrmsList
 the "layer" id for dielectric layers, from 1 (top) to 31 (bottom) (only 31 dielectric layers for 32 copper layers)
 
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 95 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 50 of file board_stackup.cpp.

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

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

References m_DielectricPrmsList.

Referenced by PANEL_SETUP_BOARD_STACKUP::onAddDielectricLayer(), PCB_IO_KICAD_SEXPR_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 340 of file board_stackup.cpp.

References _, and GetDielectricLayerId().

Referenced by PANEL_SETUP_BOARD_STACKUP::lazyBuildRowUI(), 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 322 of file board_stackup.cpp.

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

References GetLossTangent(), and UIDouble2Str().

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

◆ GetBrdLayerId()

PCB_LAYER_ID BOARD_STACKUP_ITEM::GetBrdLayerId ( ) const
inline

Definition at line 162 of file board_stackup.h.

References m_LayerId.

Referenced by GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), DRAWING_TOOL::DrawSpecificationStackup(), PCB_IO_IPC2581::generateCadLayers(), STEP_PCB_MODEL::getCopperLayerZPlacement(), ODB_MATRIX_ENTITY::InitMatrixLayerData(), PANEL_SETUP_BOARD_STACKUP::lazyBuildRowUI(), and PANEL_SETUP_BOARD_STACKUP::showOnlyActiveLayers().

◆ GetColor()

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

Definition at line 175 of file board_stackup.cpp.

References GetSublayersCount(), and m_DielectricPrmsList.

Referenced by GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), PANEL_SETUP_BOARD_STACKUP::createColorBox(), DRAWING_TOOL::DrawSpecificationStackup(), PANEL_SETUP_BOARD_STACKUP::lazyBuildRowUI(), PANEL_SETUP_BOARD_STACKUP::onMaterialChange(), and PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard().

◆ GetCopperDefaultThickness()

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

Definition at line 160 of file board_stackup.cpp.

References EDA_IU_SCALE::mmToIU(), and pcbIUScale.

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

◆ GetDielectricLayerId()

int BOARD_STACKUP_ITEM::GetDielectricLayerId ( ) const
inline

Definition at line 165 of file board_stackup.h.

References m_DielectricLayerId.

Referenced by GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), FormatDielectricLayerName(), PCB_IO_IPC2581::generateCadLayers(), ODB_MATRIX_ENTITY::InitMatrixLayerData(), and PANEL_SETUP_BOARD_STACKUP::showOnlyActiveLayers().

◆ GetEpsilonR()

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

Definition at line 198 of file board_stackup.cpp.

References GetSublayersCount(), and m_DielectricPrmsList.

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

◆ GetLayerName()

wxString BOARD_STACKUP_ITEM::GetLayerName ( ) const
inline

Definition at line 163 of file board_stackup.h.

References m_LayerName.

Referenced by DRAWING_TOOL::DrawSpecificationStackup(), PCB_IO_IPC2581::generateCadLayers(), ODB_MATRIX_ENTITY::InitMatrixLayerData(), and PANEL_SETUP_BOARD_STACKUP::lazyBuildRowUI().

◆ GetLossTangent()

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

Definition at line 190 of file board_stackup.cpp.

References GetSublayersCount(), and m_DielectricPrmsList.

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

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

Definition at line 214 of file board_stackup.cpp.

References GetSublayersCount(), and m_DielectricPrmsList.

Referenced by GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), DRAWING_TOOL::DrawSpecificationStackup(), HasMaterialValue(), PANEL_SETUP_BOARD_STACKUP::lazyBuildRowUI(), 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 147 of file board_stackup.h.

References m_DielectricPrmsList.

Referenced by GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), DRAWING_TOOL::DrawSpecificationStackup(), PCB_IO_IPC2581::generateCadLayers(), GetColor(), STEP_PCB_MODEL::getCopperLayerZPlacement(), GetEpsilonR(), GetLossTangent(), GetMaterial(), GetThickness(), ODB_MATRIX_ENTITY::InitMatrixLayerData(), IsThicknessLocked(), PANEL_SETUP_BOARD_STACKUP::lazyBuildRowUI(), PANEL_SETUP_BOARD_STACKUP::onAddDielectricLayer(), RemoveDielectricPrms(), SetColor(), SetEpsilonR(), SetLossTangent(), SetMaterial(), SetThickness(), SetThicknessLocked(), and PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup().

◆ GetThickness()

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

Definition at line 182 of file board_stackup.cpp.

References GetSublayersCount(), and m_DielectricPrmsList.

Referenced by GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), DRAWING_TOOL::DrawSpecificationStackup(), STEP_PCB_MODEL::getCopperLayerZPlacement(), PANEL_SETUP_BOARD_STACKUP::lazyBuildRowUI(), and PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard().

◆ GetType()

BOARD_STACKUP_ITEM_TYPE BOARD_STACKUP_ITEM::GetType ( ) const
inline

Definition at line 161 of file board_stackup.h.

References m_Type.

Referenced by GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), PANEL_SETUP_BOARD_STACKUP::createColorBox(), DRAWING_TOOL::DrawSpecificationStackup(), PCB_IO_IPC2581::generateCadLayers(), PANEL_SETUP_BOARD_STACKUP::getColorIconItem(), STEP_PCB_MODEL::getCopperLayerZPlacement(), PANEL_SETUP_BOARD_STACKUP::GetSelectedColor(), ODB_MATRIX_ENTITY::InitMatrixLayerData(), PANEL_SETUP_BOARD_STACKUP::lazyBuildRowUI(), PANEL_SETUP_BOARD_STACKUP::onAddDielectricLayer(), PANEL_SETUP_BOARD_STACKUP::onColorSelected(), PANEL_SETUP_BOARD_STACKUP::onMaterialChange(), PCB_IO_KICAD_SEXPR_PARSER::parseBoardStackup(), PANEL_SETUP_BOARD_STACKUP::setDefaultLayerWidths(), PANEL_SETUP_BOARD_STACKUP::showOnlyActiveLayers(), PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard(), and PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup().

◆ GetTypeName()

wxString BOARD_STACKUP_ITEM::GetTypeName ( ) const
inline

Definition at line 164 of file board_stackup.h.

References m_TypeName.

Referenced by GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), DRAWING_TOOL::DrawSpecificationStackup(), PCB_IO_IPC2581::generateCadLayers(), STEP_PCB_MODEL::getCopperLayerZPlacement(), ODB_MATRIX_ENTITY::InitMatrixLayerData(), PANEL_SETUP_BOARD_STACKUP::lazyBuildRowUI(), and PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard().

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

References BS_ITEM_TYPE_DIELECTRIC, BS_ITEM_TYPE_SOLDERMASK, and m_Type.

Referenced by PANEL_SETUP_BOARD_STACKUP::lazyBuildRowUI(), 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 284 of file board_stackup.cpp.

References BS_ITEM_TYPE_DIELECTRIC, BS_ITEM_TYPE_SOLDERMASK, and m_Type.

Referenced by PANEL_SETUP_BOARD_STACKUP::lazyBuildRowUI(), 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 291 of file board_stackup.cpp.

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

Referenced by GERBER_JOBFILE_WRITER::addJSONMaterialStackup().

◆ IsColorEditable()

bool BOARD_STACKUP_ITEM::IsColorEditable ( ) const
Returns
true if the color is editable

Definition at line 306 of file board_stackup.cpp.

References BS_ITEM_TYPE_DIELECTRIC, BS_ITEM_TYPE_SILKSCREEN, BS_ITEM_TYPE_SOLDERMASK, and m_Type.

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

◆ IsEnabled()

bool BOARD_STACKUP_ITEM::IsEnabled ( ) const
inline

Definition at line 159 of file board_stackup.h.

References m_enabled.

Referenced by PANEL_SETUP_BOARD_STACKUP::onUnitsChanged().

◆ IsMaterialEditable()

bool BOARD_STACKUP_ITEM::IsMaterialEditable ( ) const
Returns
true if the material is editable

Definition at line 298 of file board_stackup.cpp.

References BS_ITEM_TYPE_DIELECTRIC, BS_ITEM_TYPE_SILKSCREEN, BS_ITEM_TYPE_SOLDERMASK, and m_Type.

Referenced by HasMaterialValue(), PANEL_SETUP_BOARD_STACKUP::lazyBuildRowUI(), PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard(), and PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup().

◆ IsThicknessEditable()

bool BOARD_STACKUP_ITEM::IsThicknessEditable ( ) const
Returns
true if Thickness is editable

Definition at line 314 of file board_stackup.cpp.

References BS_ITEM_TYPE_COPPER, BS_ITEM_TYPE_DIELECTRIC, BS_ITEM_TYPE_SOLDERMASK, and m_Type.

Referenced by GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), PANEL_SETUP_BOARD_STACKUP::computeBoardThickness(), PANEL_SETUP_BOARD_STACKUP::lazyBuildRowUI(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), PANEL_SETUP_BOARD_STACKUP::onUnitsChanged(), PANEL_SETUP_BOARD_STACKUP::setDefaultLayerWidths(), PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard(), and PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup().

◆ IsThicknessLocked()

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

Definition at line 206 of file board_stackup.cpp.

References GetSublayersCount(), and m_DielectricPrmsList.

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

◆ operator!=()

bool BOARD_STACKUP_ITEM::operator!= ( const BOARD_STACKUP_ITEM &  aOther) const
inline

Definition at line 102 of file board_stackup.h.

References operator==().

◆ operator==()

bool BOARD_STACKUP_ITEM::operator== ( const BOARD_STACKUP_ITEM &  aOther) const

Definition at line 112 of file board_stackup.cpp.

References m_DielectricLayerId, m_DielectricPrmsList, m_enabled, m_LayerId, m_LayerName, m_Type, and m_TypeName.

Referenced by operator!=().

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

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

References m_LayerId.

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

◆ SetColor()

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

Definition at line 223 of file board_stackup.cpp.

References GetSublayersCount(), and m_DielectricPrmsList.

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

◆ SetDielectricLayerId()

void BOARD_STACKUP_ITEM::SetDielectricLayerId ( int  aLayerId)
inline

Definition at line 179 of file board_stackup.h.

References m_DielectricLayerId.

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

◆ SetEnabled()

void BOARD_STACKUP_ITEM::SetEnabled ( bool  aEnable)
inline

Definition at line 175 of file board_stackup.h.

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

References GetSublayersCount(), and m_DielectricPrmsList.

Referenced by BOARD_STACKUP_ITEM(), CADSTAR_PCB_ARCHIVE_LOADER::initStackupItem(), PANEL_SETUP_BOARD_STACKUP::onMaterialChange(), PCB_IO_KICAD_SEXPR_PARSER::parseBoardStackup(), and PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup().

◆ SetLayerName()

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

Definition at line 177 of file board_stackup.h.

References m_LayerName.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::initStackupItem(), PANEL_SETUP_BOARD_STACKUP::lazyBuildRowUI(), and PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup().

◆ SetLossTangent()

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

Definition at line 241 of file board_stackup.cpp.

References GetSublayersCount(), and m_DielectricPrmsList.

Referenced by BOARD_STACKUP_ITEM(), CADSTAR_PCB_ARCHIVE_LOADER::initStackupItem(), PANEL_SETUP_BOARD_STACKUP::onMaterialChange(), PCB_IO_KICAD_SEXPR_PARSER::parseBoardStackup(), and PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup().

◆ SetMaterial()

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

Definition at line 268 of file board_stackup.cpp.

References GetSublayersCount(), and m_DielectricPrmsList.

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

◆ SetThickness()

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

Definition at line 232 of file board_stackup.cpp.

References GetSublayersCount(), and m_DielectricPrmsList.

Referenced by BOARD_STACKUP_ITEM(), BOARD_STACKUP::BuildDefaultStackupList(), CADSTAR_PCB_ARCHIVE_LOADER::initStackupItem(), PANEL_SETUP_BOARD_STACKUP::onThicknessChange(), PCB_IO_KICAD_SEXPR_PARSER::parseBoardStackup(), and PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup().

◆ SetThicknessLocked()

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

Definition at line 259 of file board_stackup.cpp.

References GetSublayersCount(), and m_DielectricPrmsList.

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

◆ SetTypeName()

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

Definition at line 178 of file board_stackup.h.

References m_TypeName.

Referenced by BOARD_STACKUP::BuildDefaultStackupList(), PCB_IO_KICAD_SEXPR_PARSER::parseBoardStackup(), and PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup().

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

Referenced by BOARD_STACKUP_ITEM(), GetDielectricLayerId(), operator==(), 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 202 of file board_stackup.h.

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

◆ m_enabled

bool BOARD_STACKUP_ITEM::m_enabled
private

Definition at line 204 of file board_stackup.h.

Referenced by BOARD_STACKUP_ITEM(), IsEnabled(), operator==(), 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 192 of file board_stackup.h.

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

◆ m_LayerName

wxString BOARD_STACKUP_ITEM::m_LayerName
private

Definition at line 190 of file board_stackup.h.

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

◆ m_Type

BOARD_STACKUP_ITEM_TYPE BOARD_STACKUP_ITEM::m_Type
private

Definition at line 189 of file board_stackup.h.

Referenced by BOARD_STACKUP_ITEM(), GetType(), HasEpsilonRValue(), HasLossTangentValue(), IsColorEditable(), IsMaterialEditable(), IsThicknessEditable(), and operator==().

◆ m_TypeName

wxString BOARD_STACKUP_ITEM::m_TypeName
private

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

Definition at line 191 of file board_stackup.h.

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

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