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

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 190 of file board_design_settings.cpp.

Constructor & Destructor Documentation

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

Definition at line 196 of file board_design_settings.cpp.

196  :
197  PARAM_CFG_BASE( wxEmptyString, PARAM_VIADIMENSIONS, group )
198  {
199  m_Pt_param = ptparam;
200  }
std::vector< VIA_DIMENSION > * m_Pt_param
Pointer to the parameter value.
PARAM_CFG_BASE(const wxString &ident, const paramcfg_id type, const wxChar *group=NULL, const wxString &legacy_ident=wxEmptyString)

Member Function Documentation

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_BASE.

Definition at line 202 of file board_design_settings.cpp.

References ViaDiameterKey, and ViaDrillKey.

203  {
204  if( !m_Pt_param || !aConfig )
205  return;
206 
207  m_Pt_param->clear();
208 
209  for( int index = 1; ; ++index )
210  {
211  double diameter = 0.0, drill = 0.0;
212 
213  wxString key = ViaDiameterKey;
214 
215  if( !aConfig->Read( key << index, &diameter ) )
216  break;
217 
218  key = ViaDrillKey;
219  drill = aConfig->ReadDouble( key << index, 0.0 );
220 
221  m_Pt_param->emplace_back( VIA_DIMENSION( Millimeter2iu( diameter ),
222  Millimeter2iu( drill ) ) );
223  }
224  }
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
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_BASE.

Definition at line 226 of file board_design_settings.cpp.

References ViaDiameterKey, and ViaDrillKey.

227  {
228  if( !m_Pt_param || !aConfig )
229  return;
230 
231  for( size_t index = 1; index <= m_Pt_param->size(); ++index )
232  {
233  wxString key = ViaDiameterKey;
234  aConfig->Write( key << index, Iu2Millimeter( m_Pt_param->at( index - 1 ).m_Diameter ) );
235  key = ViaDrillKey;
236  aConfig->Write( key << index, Iu2Millimeter( m_Pt_param->at( index - 1 ).m_Drill ) );
237  }
238  }
std::vector< VIA_DIMENSION > * m_Pt_param
Pointer to the parameter value.
#define ViaDiameterKey
#define ViaDrillKey

Member Data Documentation

wxString PARAM_CFG_BASE::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_BASE::PARAM_CFG_BASE().

wxString PARAM_CFG_BASE::m_Ident_legacy
inherited
std::vector<VIA_DIMENSION>* PARAM_CFG_VIADIMENSIONS::m_Pt_param
protected

Pointer to the parameter value.

Definition at line 193 of file board_design_settings.cpp.

bool PARAM_CFG_BASE::m_Setup
inherited
paramcfg_id PARAM_CFG_BASE::m_Type
inherited

Type of parameter.

Definition at line 103 of file config_params.h.

Referenced by PARAM_CFG_BASE::PARAM_CFG_BASE(), and PARAM_CFG_INT_WITH_SCALE::PARAM_CFG_INT_WITH_SCALE().


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