stackup_predefined_prms.h File Reference

#include <wx/string.h>
#include <wx/arrstr.h>
#include <wx/colour.h>
#include <layer_ids.h>
#include <i18n_utility.h>
#include <gal/color4d.h>
#include <board_stackup_manager/board_stackup.h>

Go to the source code of this file.

Classes
class	FAB_LAYER_COLOR

Macros
#define	KEY_CORE   wxT( "core" )
#define	KEY_PREPREG   wxT( "prepreg" )
#define	KEY_COPPER   wxT( "copper" )
#define	DEFAULT_SOLDERMASK_OPACITY   0.83
#define	DEFAULT_EPSILON_R_SOLDERMASK   3.3
#define	DEFAULT_EPSILON_R_SILKSCREEN   1.0

Functions
wxString	NotSpecifiedPrm ()
bool	IsPrmSpecified (const wxString &aPrmValue)
wxArrayString	GetStandardCopperFinishes (bool aTranslate)
const std::vector< FAB_LAYER_COLOR > &	GetStandardColors (BOARD_STACKUP_ITEM_TYPE aType)
int	GetColorUserDefinedListIdx (BOARD_STACKUP_ITEM_TYPE aType)
KIGFX::COLOR4D	GetDefaultUserColor (BOARD_STACKUP_ITEM_TYPE aType)
KIGFX::COLOR4D	GetStandardColor (BOARD_STACKUP_ITEM_TYPE aType, int aIdx)
const wxString &	GetStandardColorName (BOARD_STACKUP_ITEM_TYPE aType, int aIdx)
bool	IsCustomColorIdx (BOARD_STACKUP_ITEM_TYPE aType, int aIdx)
bool	IsColorNameNormalized (const wxString &aName)

Macro Definition Documentation

DEFAULT_EPSILON_R_SILKSCREEN

#define DEFAULT_EPSILON_R_SILKSCREEN   1.0

Definition at line 69 of file stackup_predefined_prms.h.

DEFAULT_EPSILON_R_SOLDERMASK

#define DEFAULT_EPSILON_R_SOLDERMASK   3.3

Definition at line 66 of file stackup_predefined_prms.h.

DEFAULT_SOLDERMASK_OPACITY

#define DEFAULT_SOLDERMASK_OPACITY   0.83

Definition at line 63 of file stackup_predefined_prms.h.

KEY_COPPER

#define KEY_COPPER   wxT( "copper" )

Definition at line 47 of file stackup_predefined_prms.h.

KEY_CORE

#define KEY_CORE   wxT( "core" )

Definition at line 44 of file stackup_predefined_prms.h.

KEY_PREPREG

#define KEY_PREPREG   wxT( "prepreg" )

Definition at line 45 of file stackup_predefined_prms.h.

Function Documentation

GetColorUserDefinedListIdx()

int GetColorUserDefinedListIdx

(

BOARD_STACKUP_ITEM_TYPE

aType

)

Returns

the index of the user defined color in ColorStandardList

Definition at line 110 of file stackup_predefined_prms.cpp.

References GetStandardColors().

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

GetDefaultUserColor()

KIGFX::COLOR4D GetDefaultUserColor ( BOARD_STACKUP_ITEM_TYPE  aType )

inline

Definition at line 127 of file stackup_predefined_prms.h.

References GetColorUserDefinedListIdx(), and GetStandardColors().

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

GetStandardColor()

KIGFX::COLOR4D GetStandardColor ( BOARD_STACKUP_ITEM_TYPE  aType, int  aIdx  )

inline

Definition at line 132 of file stackup_predefined_prms.h.

References GetStandardColors().

Referenced by PANEL_SETUP_BOARD_STACKUP::createColorBox(), and PANEL_SETUP_BOARD_STACKUP::GetSelectedColor().

GetStandardColorName()

const wxString & GetStandardColorName ( BOARD_STACKUP_ITEM_TYPE  aType, int  aIdx  )

inline

Definition at line 137 of file stackup_predefined_prms.h.

References GetStandardColors().

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

GetStandardColors()

const std::vector< FAB_LAYER_COLOR > & GetStandardColors

(

BOARD_STACKUP_ITEM_TYPE

aType

)

Returns

a list of standard FAB_LAYER_COLOR items for silkscreen and solder mask.

Definition at line 98 of file stackup_predefined_prms.cpp.

References BS_ITEM_TYPE_DIELECTRIC, BS_ITEM_TYPE_SILKSCREEN, BS_ITEM_TYPE_SOLDERMASK, dielectricColors, dummy, and gbrjobColors.

Referenced by GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), colorFromStackup(), PANEL_SETUP_BOARD_STACKUP::createColorBox(), PCB_IO_IPC2581::generateContentStackup(), GetColorUserDefinedListIdx(), GetDefaultUserColor(), GetStandardColor(), GetStandardColorName(), PANEL_SETUP_BOARD_STACKUP::lazyBuildRowUI(), PANEL_SETUP_BOARD_STACKUP::onMaterialChange(), and PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard().

GetStandardCopperFinishes()

wxArrayString GetStandardCopperFinishes

(

bool

aTranslate

)

Returns

a wxArray of standard copper finish names.

Parameters

aTranslate

= false for the initial names, true for translated names

Definition at line 87 of file stackup_predefined_prms.cpp.

References arrayDim(), and copperFinishType.

Referenced by PANEL_SETUP_BOARD_FINISH::PANEL_SETUP_BOARD_FINISH(), PANEL_SETUP_BOARD_FINISH::synchronizeWithBoard(), and PANEL_SETUP_BOARD_FINISH::TransferDataFromWindow().

IsColorNameNormalized()

bool IsColorNameNormalized

(

const wxString &

aName

)

Returns

true if aName is a color name acceptable in gerber job files

Parameters

aName

is a color name like red, blue... (case insensitive)

Definition at line 117 of file stackup_predefined_prms.cpp.

Referenced by FAB_LAYER_COLOR::GetColorAsString().

IsCustomColorIdx()

bool IsCustomColorIdx ( BOARD_STACKUP_ITEM_TYPE  aType, int  aIdx  )

inline

Definition at line 142 of file stackup_predefined_prms.h.

References GetColorUserDefinedListIdx().

Referenced by PANEL_SETUP_BOARD_STACKUP::createColorBox(), PANEL_SETUP_BOARD_STACKUP::GetSelectedColor(), PANEL_SETUP_BOARD_STACKUP::onColorSelected(), and PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup().

IsPrmSpecified()

bool IsPrmSpecified

(

const wxString &

aPrmValue

)

Returns

true if the param value is specified: not empty not NotSpecifiedPrm() value or its translation

Definition at line 868 of file board_stackup.cpp.

References NotSpecifiedPrm().

Referenced by GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), colorFromStackup(), BOARD_STACKUP::FormatBoardStackup(), PCB_IO_IPC2581::generateContentStackup(), BOARD_STACKUP_ITEM::HasMaterialValue(), PANEL_SETUP_BOARD_STACKUP::lazyBuildRowUI(), PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard(), and PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup().

NotSpecifiedPrm()

wxString NotSpecifiedPrm ( )

inline

Definition at line 51 of file stackup_predefined_prms.h.

References _HKI.

Referenced by BOARD_ADAPTER::BOARD_ADAPTER(), BOARD_STACKUP_ITEM::BOARD_STACKUP_ITEM(), IsPrmSpecified(), PANEL_SETUP_BOARD_STACKUP::lazyBuildRowUI(), ALTIUM_PCB::ParseBoard6Data(), PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard(), and PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup().