KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Classes | Public Member Functions | Protected Attributes | Private Attributes | List of all members
ODB_MATRIX_ENTITY Class Reference

#include <odb_entity.h>

Inheritance diagram for ODB_MATRIX_ENTITY:
ODB_ENTITY_BASE

Classes

struct  MATRIX_LAYER
 

Public Member Functions

 ODB_MATRIX_ENTITY (BOARD *aBoard, PCB_IO_ODBPP *aPlugin)
 
virtual ~ODB_MATRIX_ENTITY ()=default
 
virtual std::string GetEntityName () override
 
virtual void GenerateFiles (ODB_TREE_WRITER &writer) override
 
virtual void InitEntityData () override
 
void InitMatrixLayerData ()
 
void GenerateStackupFile (ODB_TREE_WRITER &writer)
 
const std::vector< MATRIX_LAYER > & GetMatrixLayers () const
 
void AddStep (const wxString &aStepName)
 
void AddMatrixLayerField (MATRIX_LAYER &aMLayer, PCB_LAYER_ID aLayer)
 
void AddDrillMatrixLayer ()
 
void AddRoutMatrixLayer ()
 
void AddAuxilliaryMatrixLayer ()
 
void AddCOMPMatrixLayer (PCB_LAYER_ID aCompSide)
 
void EnsureUniqueLayerNames ()
 
virtual bool CreateDirectoryTree (ODB_TREE_WRITER &writer)
 

Protected Attributes

BOARD * m_board
 
std::vector< std::string > m_fileName
 
PCB_IO_ODBPP * m_plugin
 

Private Attributes

std::map< wxString, std::pair< unsigned int, uint32_t > > m_matrixSteps
 
std::vector< MATRIX_LAYER > m_matrixLayers
 
unsigned int m_row = 1
 
unsigned int m_col = 1
 
bool m_hasTopComp = false
 
bool m_hasBotComp = false
 

Detailed Description

Definition at line 86 of file odb_entity.h.

Constructor & Destructor Documentation

◆ ODB_MATRIX_ENTITY()

ODB_MATRIX_ENTITY::ODB_MATRIX_ENTITY ( BOARD * aBoard,
PCB_IO_ODBPP * aPlugin )
inline

Definition at line 89 of file odb_entity.h.

References ODB_ENTITY_BASE::ODB_ENTITY_BASE().

◆ ~ODB_MATRIX_ENTITY()

virtual ODB_MATRIX_ENTITY::~ODB_MATRIX_ENTITY ( )
virtualdefault

Member Function Documentation

◆ AddAuxilliaryMatrixLayer()

void ODB_MATRIX_ENTITY::AddAuxilliaryMatrixLayer ( )

Definition at line 1010 of file odb_entity.cpp.

References BOARD, CAPPING, COVERING, DOCUMENT, FILLING, ODB::GenLegalEntityName(), ODB_LAYER_NAME::m_auxKey, ODB_LAYER_NAME::m_auxType, ODB_ENTITY_BASE::m_board, DRILL_OPERATION::m_BottomCovered, DRILL_OPERATION::m_BottomPlugged, DRILL_OPERATION::m_BottomTented, DRILL_OPERATION::m_Capped, ODB_MATRIX_ENTITY::MATRIX_LAYER::m_context, DRILL_OPERATION::m_Filled, ODB_MATRIX_ENTITY::MATRIX_LAYER::m_info, ODB_LAYER_NAME::m_layer, m_matrixLayers, ODB_ENTITY_BASE::m_plugin, ODB_MATRIX_ENTITY::MATRIX_LAYER::m_polarity, ODB_LAYER_NAME::m_role, m_row, ODB_MATRIX_ENTITY::MATRIX_LAYER::m_span, DRILL_OPERATION::m_TopCovered, DRILL_OPERATION::m_TopLayer, DRILL_OPERATION::m_TopPlugged, DRILL_OPERATION::m_TopTented, ODB_MATRIX_ENTITY::MATRIX_LAYER::m_type, model, PCB_VIA_T, PLUGGING, POSITIVE, TENTING, top(), UNDEFINED_LAYER, via, and VIA_PROTECTION.

Referenced by InitMatrixLayerData().

◆ AddCOMPMatrixLayer()

void ODB_MATRIX_ENTITY::AddCOMPMatrixLayer ( PCB_LAYER_ID aCompSide)

Definition at line 996 of file odb_entity.cpp.

References BOARD, COMPONENT, F_Cu, ODB_LAYER_NAME::m_componentSide, ODB_MATRIX_ENTITY::MATRIX_LAYER::m_context, m_hasBotComp, m_hasTopComp, ODB_MATRIX_ENTITY::MATRIX_LAYER::m_info, m_matrixLayers, ODB_LAYER_NAME::m_role, m_row, and ODB_MATRIX_ENTITY::MATRIX_LAYER::m_type.

Referenced by InitMatrixLayerData().

◆ AddDrillMatrixLayer()

void ODB_MATRIX_ENTITY::AddDrillMatrixLayer ( )

Definition at line 871 of file odb_entity.cpp.

References B_Cu, BACKDRILL, BOARD, DRILL, F_Cu, ODB::GenLegalEntityName(), ODB_MATRIX_ENTITY::MATRIX_LAYER::m_addType, ODB_ENTITY_BASE::m_board, DRILL_OPERATION::m_BottomLayer, ODB_MATRIX_ENTITY::MATRIX_LAYER::m_context, ODB_LAYER_NAME::m_drillSpan, ODB_MATRIX_ENTITY::MATRIX_LAYER::m_info, DRILL_SPAN::m_IsBackdrill, m_matrixLayers, DRILL_OPERATION::m_NotPlated, ODB_ENTITY_BASE::m_plugin, ODB_MATRIX_ENTITY::MATRIX_LAYER::m_polarity, ODB_LAYER_NAME::m_role, m_row, DRILL_OPERATION::m_SourceItem, ODB_MATRIX_ENTITY::MATRIX_LAYER::m_span, DRILL_OPERATION::m_TopLayer, ODB_MATRIX_ENTITY::MATRIX_LAYER::m_type, model, name, NPTH, pad, DRILL_SPAN::Pair(), PCB_VIA_T, POSITIVE, PTH, and EDA_ITEM::Type().

Referenced by InitMatrixLayerData().

◆ AddMatrixLayerField()

void ODB_MATRIX_ENTITY::AddMatrixLayerField ( MATRIX_LAYER & aMLayer,
PCB_LAYER_ID aLayer )

Definition at line 762 of file odb_entity.cpp.

References B_Adhes, B_CrtYd, B_Fab, B_Mask, B_Paste, B_SilkS, BOARD, Cmts_User, DOCUMENT, Dwgs_User, Eco1_User, Eco2_User, F_Adhes, F_CrtYd, F_Fab, F_Mask, F_Paste, F_SilkS, IsCopperLayer(), LT_MIXED, LT_POWER, ODB_ENTITY_BASE::m_board, ODB_MATRIX_ENTITY::MATRIX_LAYER::m_context, ODB_MATRIX_ENTITY::MATRIX_LAYER::m_info, ODB_LAYER_NAME::m_layer, m_matrixLayers, ODB_MATRIX_ENTITY::MATRIX_LAYER::m_polarity, m_row, ODB_MATRIX_ENTITY::MATRIX_LAYER::m_type, Margin, MISC, MIXED, POSITIVE, POWER_GROUND, SIGNAL, SILK_SCREEN, SOLDER_MASK, SOLDER_PASTE, UNDEFINED, User_1, User_10, User_11, User_12, User_13, User_14, User_15, User_16, User_17, User_18, User_19, User_2, User_20, User_21, User_22, User_23, User_24, User_25, User_26, User_27, User_28, User_29, User_3, User_30, User_31, User_32, User_33, User_34, User_35, User_36, User_37, User_38, User_39, User_4, User_40, User_41, User_42, User_43, User_44, User_45, User_5, User_6, User_7, User_8, and User_9.

Referenced by InitMatrixLayerData().

◆ AddRoutMatrixLayer()

void ODB_MATRIX_ENTITY::AddRoutMatrixLayer ( )

Definition at line 985 of file odb_entity.cpp.

References B_Cu, F_Cu, ODB::GenLegalEntityName(), ODB_ENTITY_BASE::m_board, ODB_MATRIX_ENTITY::MATRIX_LAYER::m_info, m_matrixLayers, ODB_LAYER_NAME::m_role, m_row, ODB_MATRIX_ENTITY::MATRIX_LAYER::m_span, ODB_MATRIX_ENTITY::MATRIX_LAYER::m_type, and ROUT.

Referenced by InitMatrixLayerData().

◆ AddStep()

void ODB_MATRIX_ENTITY::AddStep ( const wxString & aStepName)

Definition at line 385 of file odb_entity.cpp.

References ODB::GenLegalEntityName(), m_col, m_matrixSteps, and ODB_ENTITY_BASE::m_plugin.

Referenced by InitEntityData().

◆ CreateDirectoryTree()

bool ODB_ENTITY_BASE::CreateDirectoryTree ( ODB_TREE_WRITER & writer)
virtualinherited

Reimplemented in ODB_STEP_ENTITY.

Definition at line 147 of file odb_entity.cpp.

References ODB_TREE_WRITER::CreateEntityDirectory(), GetEntityName(), and ODB_TREE_WRITER::GetRootPath().

◆ EnsureUniqueLayerNames()

void ODB_MATRIX_ENTITY::EnsureUniqueLayerNames ( )

Definition at line 1130 of file odb_entity.cpp.

References index, m_matrixLayers, and ODB::UniqueNames().

Referenced by InitMatrixLayerData().

◆ GenerateFiles()

void ODB_MATRIX_ENTITY::GenerateFiles ( ODB_TREE_WRITER & writer)
overridevirtual

Reimplemented from ODB_ENTITY_BASE.

Definition at line 1145 of file odb_entity.cpp.

References ODB_TREE_WRITER::CreateFileProxy(), GenerateStackupFile(), m_matrixLayers, m_matrixSteps, ODB_ENTITY_BASE::m_plugin, ODB_TEXT_WRITER::MakeArrayProxy(), FAB::STACKUP, ODB_TEXT_WRITER::write_line_enum(), and ODB_TEXT_WRITER::WriteEquationLine().

◆ GenerateStackupFile()

void ODB_MATRIX_ENTITY::GenerateStackupFile ( ODB_TREE_WRITER & writer)

Definition at line 1207 of file odb_entity.cpp.

References _, B_Mask, BOARD, BS_ITEM_TYPE_COPPER, BS_ITEM_TYPE_SOLDERMASK, CORE, ODB::Data2String(), DIELECTRIC, ODB::Double2String(), DRILL, F_Mask, BOARD_STACKUP_ITEM::GetEpsilonR(), BOARD_STACKUP_ITEM::GetLossTangent(), ODB::EnumStringMap< T >::GetMap(), BOARD_STACKUP_ITEM::GetMaterial(), BOARD_STACKUP_ITEM::GetSpecFreq(), BOARD_STACKUP_ITEM::GetThickness(), BOARD_STACKUP_ITEM::GetType(), group, BOARD_STACKUP_ITEM::HasEpsilonRValue(), BOARD_STACKUP_ITEM::HasLossTangentValue(), IsCopperLayer(), BOARD_STACKUP_ITEM::IsEnabled(), IsPrmSpecified(), BOARD_STACKUP_ITEM::IsThicknessEditable(), FAB_STACKUP::ItemForLayer(), ODB_ENTITY_BASE::m_board, m_matrixLayers, ODB_ENTITY_BASE::m_plugin, ODB_FORMAT::m_unitsStr, PREPREG, ROUT, ODB_STEP_ENTITY::STEP_NAME, and FAB_STACKUP::Thickness().

Referenced by GenerateFiles().

◆ GetEntityName()

virtual std::string ODB_MATRIX_ENTITY::GetEntityName ( )
inlineoverridevirtual

Implements ODB_ENTITY_BASE.

Definition at line 95 of file odb_entity.h.

◆ GetMatrixLayers()

const std::vector< MATRIX_LAYER > & ODB_MATRIX_ENTITY::GetMatrixLayers ( ) const
inline

Definition at line 127 of file odb_entity.h.

References m_matrixLayers.

Referenced by PreviewOdbMatrix().

◆ InitEntityData()

void ODB_MATRIX_ENTITY::InitEntityData ( )
overridevirtual

Reimplemented from ODB_ENTITY_BASE.

Definition at line 392 of file odb_entity.cpp.

References AddStep(), InitMatrixLayerData(), and ODB_STEP_ENTITY::STEP_NAME.

Referenced by PreviewOdbMatrix().

◆ InitMatrixLayerData()

void ODB_MATRIX_ENTITY::InitMatrixLayerData ( )

Definition at line 400 of file odb_entity.cpp.

References _, AddAuxilliaryMatrixLayer(), AddCOMPMatrixLayer(), AddDrillMatrixLayer(), AddMatrixLayerField(), AddRoutMatrixLayer(), B_Cu, BACKDRILL, BOARD, BOARD_LAYER, BS_ITEM_TYPE_DIELECTRIC, COMPONENT, CORE, DIELECTRIC, DRILL, end, EnsureUniqueLayerNames(), ODB::Enum2String(), F_Cu, ODB::GenLegalEntityName(), BOARD_STACKUP_ITEM::GetBrdLayerId(), BOARD_STACKUP::GetCount(), BOARD_STACKUP_ITEM::GetDielectricLayerId(), BOARD_STACKUP_ITEM::GetLayerName(), BOARD_STACKUP::GetList(), BOARD_STACKUP_ITEM::GetMaterial(), BOARD_STACKUP_ITEM::GetSublayersCount(), BOARD_STACKUP_ITEM::GetType(), BOARD_STACKUP_ITEM::GetTypeName(), ODB_FORMAT::Includes(), index, isCopper(), IsExternalCopperLayer(), IsValidLayer(), KEY_CORE, ODB_LAYER_NAME::m_auxKey, ODB_ENTITY_BASE::m_board, ODB_MATRIX_ENTITY::MATRIX_LAYER::m_context, ODB_MATRIX_ENTITY::MATRIX_LAYER::m_cuBottom, ODB_MATRIX_ENTITY::MATRIX_LAYER::m_cuTop, ODB_MATRIX_ENTITY::MATRIX_LAYER::m_dielectricName, ODB_MATRIX_ENTITY::MATRIX_LAYER::m_diType, ODB_LAYER_NAME::m_drillSpan, m_hasBotComp, m_hasTopComp, ODB_MATRIX_ENTITY::MATRIX_LAYER::m_info, ODB_LAYER_NAME::m_layer, ODB_FORMAT::m_layerOverrides, m_matrixLayers, ODB_ENTITY_BASE::m_plugin, ODB_MATRIX_ENTITY::MATRIX_LAYER::m_polarity, ODB_MATRIX_ENTITY::MATRIX_LAYER::m_ref, ODB_LAYER_NAME::m_role, m_row, ODB_FORMAT::m_sections, ODB_MATRIX_ENTITY::MATRIX_LAYER::m_span, ODB_LAYER_NAME::m_stackupItem, ODB_LAYER_NAME::m_sublayer, ODB_MATRIX_ENTITY::MATRIX_LAYER::m_type, MIXED, name, ODB::OverridableLayerTypes(), POSITIVE, POWER_GROUND, PREPREG, ROUT, RPT_SEVERITY_WARNING, SECTION, SIGNAL, SILK_SCREEN, SOLDER_MASK, SOLDER_PASTE, top(), UNDEFINED_LAYER, and VIA_PROTECTION.

Referenced by InitEntityData().

Member Data Documentation

◆ m_board

BOARD* ODB_ENTITY_BASE::m_board
protectedinherited

Definition at line 62 of file odb_entity.h.

Referenced by ODB_MATRIX_ENTITY::AddAuxilliaryMatrixLayer(), ODB_MATRIX_ENTITY::AddDrillMatrixLayer(), ODB_MATRIX_ENTITY::AddMatrixLayerField(), ODB_MATRIX_ENTITY::AddRoutMatrixLayer(), ODB_LAYER_ENTITY::GenAttrList(), ODB_MISC_ENTITY::GenerateAttrListFile(), ODB_STEP_ENTITY::GenerateEdaFiles(), ODB_MISC_ENTITY::GenerateFiles(), ODB_MISC_ENTITY::GenerateMetadataFile(), ODB_STEP_ENTITY::GenerateProfileFile(), ODB_MATRIX_ENTITY::GenerateStackupFile(), ODB_STEP_ENTITY::InitEdaData(), ODB_LAYER_ENTITY::InitFeatureData(), ODB_MATRIX_ENTITY::InitMatrixLayerData(), ODB_LAYER_ENTITY::InitRoutData(), ODB_STEP_ENTITY::MakeLayerEntity(), ODB_ENTITY_BASE(), and ODB_ENTITY_BASE().

◆ m_col

unsigned int ODB_MATRIX_ENTITY::m_col = 1
private

Definition at line 142 of file odb_entity.h.

Referenced by AddStep().

◆ m_fileName

std::vector<std::string> ODB_ENTITY_BASE::m_fileName
protectedinherited

Definition at line 63 of file odb_entity.h.

◆ m_hasBotComp

bool ODB_MATRIX_ENTITY::m_hasBotComp = false
private

Definition at line 144 of file odb_entity.h.

Referenced by AddCOMPMatrixLayer(), and InitMatrixLayerData().

◆ m_hasTopComp

bool ODB_MATRIX_ENTITY::m_hasTopComp = false
private

Definition at line 143 of file odb_entity.h.

Referenced by AddCOMPMatrixLayer(), and InitMatrixLayerData().

◆ m_matrixLayers

std::vector<MATRIX_LAYER> ODB_MATRIX_ENTITY::m_matrixLayers
private

Definition at line 140 of file odb_entity.h.

Referenced by AddAuxilliaryMatrixLayer(), AddCOMPMatrixLayer(), AddDrillMatrixLayer(), AddMatrixLayerField(), AddRoutMatrixLayer(), EnsureUniqueLayerNames(), GenerateFiles(), GenerateStackupFile(), GetMatrixLayers(), and InitMatrixLayerData().

◆ m_matrixSteps

std::map<wxString, std::pair<unsigned int, uint32_t> > ODB_MATRIX_ENTITY::m_matrixSteps
private

Definition at line 139 of file odb_entity.h.

Referenced by AddStep(), and GenerateFiles().

◆ m_plugin

PCB_IO_ODBPP* ODB_ENTITY_BASE::m_plugin
protectedinherited

Definition at line 64 of file odb_entity.h.

Referenced by ODB_MATRIX_ENTITY::AddAuxilliaryMatrixLayer(), ODB_MATRIX_ENTITY::AddDrillMatrixLayer(), ODB_MATRIX_ENTITY::AddStep(), ODB_LAYER_ENTITY::GenAttrList(), ODB_MISC_ENTITY::GenerateAttrListFile(), ODB_STEP_ENTITY::GenerateAttrListFile(), ODB_STEP_ENTITY::GenerateEdaFiles(), ODB_MATRIX_ENTITY::GenerateFiles(), ODB_MISC_ENTITY::GenerateFiles(), ODB_STEP_ENTITY::GenerateFiles(), ODB_MISC_ENTITY::GenerateMetadataFile(), ODB_STEP_ENTITY::GenerateNetlistsFiles(), ODB_STEP_ENTITY::GenerateProfileFile(), ODB_MATRIX_ENTITY::GenerateStackupFile(), ODB_STEP_ENTITY::GenerateStepHeaderFile(), ODB_MISC_ENTITY::GenerateUserAttrFile(), ODB_LAYER_ENTITY::InitAuxilliaryData(), ODB_LAYER_ENTITY::InitComponentData(), ODB_LAYER_ENTITY::InitDrillData(), ODB_STEP_ENTITY::InitEdaData(), ODB_MATRIX_ENTITY::InitMatrixLayerData(), ODB_LAYER_ENTITY::InitRoutData(), ODB_STEP_ENTITY::MakeLayerEntity(), ODB_ENTITY_BASE(), ODB_ENTITY_BASE(), and ODB_MISC_ENTITY::ODB_MISC_ENTITY().

◆ m_row

unsigned int ODB_MATRIX_ENTITY::m_row = 1
private

Definition at line 141 of file odb_entity.h.

Referenced by AddAuxilliaryMatrixLayer(), AddCOMPMatrixLayer(), AddDrillMatrixLayer(), AddMatrixLayerField(), AddRoutMatrixLayer(), and InitMatrixLayerData().

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