KiCad PCB EDA Suite
PARAM_CFG_VIADIMENSIONS Class Reference
Inheritance diagram for PARAM_CFG_VIADIMENSIONS:
PARAM_CFG

Public Member Functions

 PARAM_CFG_VIADIMENSIONS (std::vector< VIA_DIMENSION > *ptparam, const wxChar *group=nullptr)
 
void ReadParam (wxConfigBase *aConfig) const override
 Function ReadParam reads the value of the parameter stored in aConfig. More...
 
void SaveParam (wxConfigBase *aConfig) const override
 Function SaveParam saves the value of the parameter stored in aConfig. More...
 

Public Attributes

wxString m_Ident
 Keyword in config data. More...
 
paramcfg_id m_Type
 Type of parameter. More...
 
wxString m_Group
 Group name (this is like a path in the config data) More...
 
bool m_Setup
 Install or Project based parameter, true == install. More...
 
wxString m_Ident_legacy
 

Protected Attributes

std::vector< VIA_DIMENSION > * m_Pt_param
 Pointer to the parameter value. More...
 

Detailed Description

Definition at line 303 of file board_design_settings.cpp.

Constructor & Destructor Documentation

◆ PARAM_CFG_VIADIMENSIONS()

PARAM_CFG_VIADIMENSIONS::PARAM_CFG_VIADIMENSIONS ( std::vector< VIA_DIMENSION > *  ptparam,
const wxChar *  group = nullptr 
)
inline

Definition at line 309 of file board_design_settings.cpp.

309  :
310  PARAM_CFG( wxEmptyString, PARAM_VIADIMENSIONS, group )
311  {
312  m_Pt_param = ptparam;
313  }
std::vector< VIA_DIMENSION > * m_Pt_param
Pointer to the parameter value.
PARAM_CFG(const wxString &ident, const paramcfg_id type, const wxChar *group=NULL, const wxString &legacy_ident=wxEmptyString)

References m_Pt_param.

Member Function Documentation

◆ ReadParam()

void PARAM_CFG_VIADIMENSIONS::ReadParam ( wxConfigBase *  aConfig) const
inlineoverridevirtual

Function ReadParam reads the value of the parameter stored in aConfig.

Parameters
aConfig= the wxConfigBase that holds the parameter

Reimplemented from PARAM_CFG.

Definition at line 315 of file board_design_settings.cpp.

316  {
317  if( !m_Pt_param || !aConfig )
318  return;
319 
320  m_Pt_param->clear();
321 
322  for( int index = 1; ; ++index )
323  {
324  double diameter = 0.0, drill = 0.0;
325 
326  wxString key = ViaDiameterKey;
327 
328  if( !aConfig->Read( key << index, &diameter ) )
329  break;
330 
331  key = ViaDrillKey;
332  drill = aConfig->ReadDouble( key << index, 0.0 );
333 
334  m_Pt_param->emplace_back( VIA_DIMENSION( Millimeter2iu( diameter ),
335  Millimeter2iu( drill ) ) );
336  }
337  }
Struct VIA_DIMENSION is a small helper container to handle a stock of specific vias each with unique ...
std::vector< VIA_DIMENSION > * m_Pt_param
Pointer to the parameter value.
#define ViaDiameterKey
#define ViaDrillKey

References m_Pt_param, ViaDiameterKey, and ViaDrillKey.

◆ SaveParam()

void PARAM_CFG_VIADIMENSIONS::SaveParam ( wxConfigBase *  aConfig) const
inlineoverridevirtual

Function SaveParam saves the value of the parameter stored in aConfig.

Parameters
aConfig= the wxConfigBase that can store the parameter

Reimplemented from PARAM_CFG.

Definition at line 339 of file board_design_settings.cpp.

340  {
341  if( !m_Pt_param || !aConfig )
342  return;
343 
344  for( size_t index = 1; index <= m_Pt_param->size(); ++index )
345  {
346  wxString key = ViaDiameterKey;
347  aConfig->Write( key << index, Iu2Millimeter( m_Pt_param->at( index - 1 ).m_Diameter ) );
348  key = ViaDrillKey;
349  aConfig->Write( key << index, Iu2Millimeter( m_Pt_param->at( index - 1 ).m_Drill ) );
350  }
351  }
std::vector< VIA_DIMENSION > * m_Pt_param
Pointer to the parameter value.
#define ViaDiameterKey
#define ViaDrillKey

References m_Pt_param, ViaDiameterKey, and ViaDrillKey.

Member Data Documentation

◆ m_Group

wxString PARAM_CFG::m_Group
inherited

Group name (this is like a path in the config data)

Definition at line 104 of file config_params.h.

Referenced by PARAM_CFG::PARAM_CFG().

◆ m_Ident

◆ m_Ident_legacy

wxString PARAM_CFG::m_Ident_legacy
inherited

◆ m_Pt_param

std::vector<VIA_DIMENSION>* PARAM_CFG_VIADIMENSIONS::m_Pt_param
protected

Pointer to the parameter value.

Definition at line 306 of file board_design_settings.cpp.

Referenced by PARAM_CFG_VIADIMENSIONS(), ReadParam(), and SaveParam().

◆ m_Setup

◆ m_Type

paramcfg_id PARAM_CFG::m_Type
inherited

Type of parameter.

Definition at line 103 of file config_params.h.

Referenced by dumpParamCfg(), PARAM_CFG::PARAM_CFG(), and PARAM_CFG_INT_WITH_SCALE::PARAM_CFG_INT_WITH_SCALE().


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