DIELECTRIC_SUBSTRATE_LIST Class Reference

#include <dielectric_material.h>

Public Types
enum	DL_MATERIAL_LIST_TYPE { DL_MATERIAL_DIELECTRIC , DL_MATERIAL_SOLDERMASK , DL_MATERIAL_SILKSCREEN }

Public Member Functions
	DIELECTRIC_SUBSTRATE_LIST (DL_MATERIAL_LIST_TYPE aListType)
int	GetCount ()
DIELECTRIC_SUBSTRATE *	GetSubstrate (int aIdx)
DIELECTRIC_SUBSTRATE *	GetSubstrate (const wxString &aName)
	The comparison is case insensitive.
int	FindSubstrate (DIELECTRIC_SUBSTRATE *aItem)
	Find a item in list similar to aItem.
int	FindSubstrate (const wxString &aName, double aEpsilonR, double aLossTg)
	Find a item in list having the same parameters.
int	AppendSubstrate (DIELECTRIC_SUBSTRATE &aItem)
	Append a item in list similar to aItem.
void	DeleteSubstrate (int aIdx)
	Delete the specified item in the substrate list.

Private Attributes
std::vector< DIELECTRIC_SUBSTRATE >	m_substrateList
	< The list of available substrates. It contains at least predefined substrates

Detailed Description

Definition at line 48 of file dielectric_material.h.

Member Enumeration Documentation

DL_MATERIAL_LIST_TYPE

enum DIELECTRIC_SUBSTRATE_LIST::DL_MATERIAL_LIST_TYPE

Enumerator
DL_MATERIAL_DIELECTRIC
DL_MATERIAL_SOLDERMASK
DL_MATERIAL_SILKSCREEN

Definition at line 54 of file dielectric_material.h.

Constructor & Destructor Documentation

DIELECTRIC_SUBSTRATE_LIST()

DIELECTRIC_SUBSTRATE_LIST::DIELECTRIC_SUBSTRATE_LIST

(

DL_MATERIAL_LIST_TYPE

aListType

)

Parameters

aForDielectric

set to DL_MATERIAL_DIELECTRIC to build a dielectric material list or DL_MATERIAL_SOLDERMASK to build a solder mask material list.

Definition at line 87 of file dielectric_material.cpp.

References arrayDim(), DL_MATERIAL_DIELECTRIC, DL_MATERIAL_SILKSCREEN, DL_MATERIAL_SOLDERMASK, m_substrateList, silkscreenMaterial, solderMaskMaterial, and substrateMaterial.

Member Function Documentation

AppendSubstrate()

int DIELECTRIC_SUBSTRATE_LIST::AppendSubstrate ( DIELECTRIC_SUBSTRATE & aItem )

inline

Append a item in list similar to aItem.

Parameters

aItem

is the item to append.

Returns

the index of the new item in list.

Definition at line 113 of file dielectric_material.h.

References GetCount(), and m_substrateList.

Referenced by PANEL_SETUP_BOARD_STACKUP::onMaterialChange().

DeleteSubstrate()

void DIELECTRIC_SUBSTRATE_LIST::DeleteSubstrate ( int aIdx )

inline

Delete the specified item in the substrate list.

Parameters

aInd	is the index in the substrate list to delete

Definition at line 124 of file dielectric_material.h.

References m_substrateList.

FindSubstrate() [1/2]

int DIELECTRIC_SUBSTRATE_LIST::FindSubstrate	(	const wxString &	aName,
		double	aEpsilonR,
		double	aLossTg )

Find a item in list having the same parameters.

Parameters

aName	is the name to match (case insensitive).
aEpsilonR	is the relative permeability to match.
aLossTg	is the loss tangent to match.

Returns

the index of similar item in list or -1 if not found.

Definition at line 153 of file dielectric_material.cpp.

References m_substrateList.

FindSubstrate() [2/2]

int DIELECTRIC_SUBSTRATE_LIST::FindSubstrate

(

DIELECTRIC_SUBSTRATE *

aItem

)

Find a item in list similar to aItem.

The comparison is for the name case insensitive, and EpsilonR and LossTg must match.

Parameters

aItem

is the item to match.

Returns

the index of similar item in list or -1 if not found.

Definition at line 131 of file dielectric_material.cpp.

References DIELECTRIC_SUBSTRATE::m_EpsilonR, DIELECTRIC_SUBSTRATE::m_LossTangent, DIELECTRIC_SUBSTRATE::m_Name, and m_substrateList.

Referenced by PANEL_SETUP_BOARD_STACKUP::onMaterialChange().

GetCount()

int DIELECTRIC_SUBSTRATE_LIST::GetCount ( )

inline

Returns

the number of substrates in list

Definition at line 70 of file dielectric_material.h.

References m_substrateList.

Referenced by AppendSubstrate(), and GetSubstrate().

GetSubstrate() [1/2]

DIELECTRIC_SUBSTRATE * DIELECTRIC_SUBSTRATE_LIST::GetSubstrate

(

const wxString &

aName

)

The comparison is case insensitive.

Parameters

aName

is the name of the substrate in substrate list.

Returns

the substrate in list of name aName if not found return nullptr.

Definition at line 119 of file dielectric_material.cpp.

References m_substrateList.

GetSubstrate() [2/2]

DIELECTRIC_SUBSTRATE * DIELECTRIC_SUBSTRATE_LIST::GetSubstrate

(

int

aIdx

)

Returns

the substrate in list of index aIdx if incorrect return nullptr.

Parameters

aIdx	is the index in substrate list.

Definition at line 110 of file dielectric_material.cpp.

References GetCount(), and m_substrateList.

Member Data Documentation

m_substrateList

std::vector<DIELECTRIC_SUBSTRATE> DIELECTRIC_SUBSTRATE_LIST::m_substrateList

private

< The list of available substrates. It contains at least predefined substrates

Definition at line 51 of file dielectric_material.h.

Referenced by AppendSubstrate(), DeleteSubstrate(), DIELECTRIC_SUBSTRATE_LIST(), FindSubstrate(), FindSubstrate(), GetCount(), GetSubstrate(), and GetSubstrate().

---

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

• dielectric_material.h
• dielectric_material.cpp