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

Public Member Functions

 PARAM_CFG_TRACKWIDTHS (std::vector< int > *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< int > * m_Pt_param
 Pointer to the parameter value. More...
 

Detailed Description

Definition at line 258 of file board_design_settings.cpp.

Constructor & Destructor Documentation

◆ PARAM_CFG_TRACKWIDTHS()

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

Definition at line 264 of file board_design_settings.cpp.

264  :
265  PARAM_CFG( wxEmptyString, PARAM_TRACKWIDTHS, group )
266  {
267  m_Pt_param = ptparam;
268  }
PARAM_CFG(const wxString &ident, const paramcfg_id type, const wxChar *group=NULL, const wxString &legacy_ident=wxEmptyString)
std::vector< int > * m_Pt_param
Pointer to the parameter value.

References m_Pt_param.

Member Function Documentation

◆ ReadParam()

void PARAM_CFG_TRACKWIDTHS::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 270 of file board_design_settings.cpp.

271  {
272  if( !m_Pt_param || !aConfig )
273  return;
274 
275  m_Pt_param->clear();
276 
277  for( int index = 1; ; ++index )
278  {
279  wxString key = TrackWidthKey;
280  double width;
281 
282  if( !aConfig->Read( key << index, &width ) )
283  break;
284 
285  m_Pt_param->push_back( Millimeter2iu( width ) );
286  }
287  }
#define TrackWidthKey
std::vector< int > * m_Pt_param
Pointer to the parameter value.

References m_Pt_param, and TrackWidthKey.

◆ SaveParam()

void PARAM_CFG_TRACKWIDTHS::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 289 of file board_design_settings.cpp.

290  {
291  if( !m_Pt_param || !aConfig )
292  return;
293 
294  for( size_t index = 1; index <= m_Pt_param->size(); ++index )
295  {
296  wxString key = TrackWidthKey;
297  aConfig->Write( key << index, Iu2Millimeter( m_Pt_param->at( index - 1 ) ) );
298  }
299  }
#define TrackWidthKey
std::vector< int > * m_Pt_param
Pointer to the parameter value.

References m_Pt_param, and TrackWidthKey.

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<int>* PARAM_CFG_TRACKWIDTHS::m_Pt_param
protected

Pointer to the parameter value.

Definition at line 261 of file board_design_settings.cpp.

Referenced by PARAM_CFG_TRACKWIDTHS(), 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: