KiCad PCB EDA Suite
PARAM_CFG_INT Class Reference

Configuration parameter - Integer Class. More...

#include <config_params.h>

Inheritance diagram for PARAM_CFG_INT:
PARAM_CFG PARAM_CFG_INT_WITH_SCALE

Public Member Functions

 PARAM_CFG_INT (const wxString &ident, int *ptparam, int default_val=0, int min=std::numeric_limits< int >::min(), int max=std::numeric_limits< int >::max(), const wxChar *group=nullptr, const wxString &legacy_ident=wxEmptyString)
 
 PARAM_CFG_INT (bool Insetup, const wxString &ident, int *ptparam, int default_val=0, int min=std::numeric_limits< int >::min(), int max=std::numeric_limits< int >::max(), const wxChar *group=nullptr, const wxString &legacy_ident=wxEmptyString)
 
virtual void ReadParam (wxConfigBase *aConfig) const override
 Function ReadParam reads the value of the parameter stored in aConfig. More...
 
virtual void SaveParam (wxConfigBase *aConfig) const override
 Function SaveParam saves the value of the parameter stored in aConfig. More...
 

Public Attributes

int * m_Pt_param
 Pointer to the parameter value. More...
 
int m_Min
 
int m_Max
 Minimum and maximum values of the param type. More...
 
int m_Default
 The default value of the parameter. More...
 
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
 

Detailed Description

Configuration parameter - Integer Class.

Definition at line 136 of file config_params.h.

Constructor & Destructor Documentation

◆ PARAM_CFG_INT() [1/2]

PARAM_CFG_INT::PARAM_CFG_INT ( const wxString &  ident,
int *  ptparam,
int  default_val = 0,
int  min = std::numeric_limits<int>::min(),
int  max = std::numeric_limits<int>::max(),
const wxChar *  group = nullptr,
const wxString &  legacy_ident = wxEmptyString 
)

Definition at line 145 of file config_params.cpp.

146  :
147  PARAM_CFG( ident, PARAM_INT, group, legacy )
148 {
149  m_Pt_param = ptparam;
150  m_Default = default_val;
151  m_Min = min;
152  m_Max = max;
153 }
int m_Default
The default value of the parameter.
int * 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)
int m_Max
Minimum and maximum values of the param type.

References m_Default, m_Max, m_Min, and m_Pt_param.

◆ PARAM_CFG_INT() [2/2]

PARAM_CFG_INT::PARAM_CFG_INT ( bool  Insetup,
const wxString &  ident,
int *  ptparam,
int  default_val = 0,
int  min = std::numeric_limits<int>::min(),
int  max = std::numeric_limits<int>::max(),
const wxChar *  group = nullptr,
const wxString &  legacy_ident = wxEmptyString 
)

Definition at line 156 of file config_params.cpp.

157  :
158  PARAM_CFG( ident, PARAM_INT, group, legacy )
159 {
160  m_Pt_param = ptparam;
161  m_Default = default_val;
162  m_Min = min;
163  m_Max = max;
164  m_Setup = setup;
165 }
bool m_Setup
Install or Project based parameter, true == install.
int m_Default
The default value of the parameter.
int * 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)
int m_Max
Minimum and maximum values of the param type.

References m_Default, m_Max, m_Min, m_Pt_param, and PARAM_CFG::m_Setup.

Member Function Documentation

◆ ReadParam()

void PARAM_CFG_INT::ReadParam ( wxConfigBase *  aConfig) const
overridevirtual

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

Parameters
aConfig= the wxConfigBase that holds the parameter

Reimplemented from PARAM_CFG.

Reimplemented in PARAM_CFG_INT_WITH_SCALE.

Definition at line 168 of file config_params.cpp.

169 {
170  if( !m_Pt_param || !aConfig )
171  return;
172 
173  int itmp = m_Default;
174 
175  if( !aConfig->Read( m_Ident, &itmp ) && m_Ident_legacy != wxEmptyString )
176  aConfig->Read( m_Ident_legacy, &itmp );
177 
178  if( (itmp < m_Min) || (itmp > m_Max) )
179  itmp = m_Default;
180 
181  *m_Pt_param = itmp;
182 }
wxString m_Ident
Keyword in config data.
int m_Default
The default value of the parameter.
wxString m_Ident_legacy
int * m_Pt_param
Pointer to the parameter value.
int m_Max
Minimum and maximum values of the param type.

References m_Default, PARAM_CFG::m_Ident, PARAM_CFG::m_Ident_legacy, m_Max, m_Min, and m_Pt_param.

◆ SaveParam()

void PARAM_CFG_INT::SaveParam ( wxConfigBase *  aConfig) const
overridevirtual

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

Parameters
aConfig= the wxConfigBase that can store the parameter

Reimplemented from PARAM_CFG.

Reimplemented in PARAM_CFG_INT_WITH_SCALE.

Definition at line 185 of file config_params.cpp.

186 {
187  if( !m_Pt_param || !aConfig )
188  return;
189 
190  aConfig->Write( m_Ident, *m_Pt_param );
191 }
wxString m_Ident
Keyword in config data.
int * m_Pt_param
Pointer to the parameter value.

References PARAM_CFG::m_Ident, and m_Pt_param.

Member Data Documentation

◆ m_Default

int PARAM_CFG_INT::m_Default

The default value of the parameter.

Definition at line 141 of file config_params.h.

Referenced by PARAM_CFG_INT(), ReadParam(), and PARAM_CFG_INT_WITH_SCALE::ReadParam().

◆ 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_Max

int PARAM_CFG_INT::m_Max

Minimum and maximum values of the param type.

Definition at line 140 of file config_params.h.

Referenced by PARAM_CFG_INT(), ReadParam(), and PARAM_CFG_INT_WITH_SCALE::ReadParam().

◆ m_Min

int PARAM_CFG_INT::m_Min

Definition at line 140 of file config_params.h.

Referenced by PARAM_CFG_INT(), ReadParam(), and PARAM_CFG_INT_WITH_SCALE::ReadParam().

◆ m_Pt_param

int* PARAM_CFG_INT::m_Pt_param

Pointer to the parameter value.

Definition at line 139 of file config_params.h.

Referenced by PARAM_CFG_INT(), ReadParam(), PARAM_CFG_INT_WITH_SCALE::ReadParam(), SaveParam(), and PARAM_CFG_INT_WITH_SCALE::SaveParam().

◆ m_Setup

bool PARAM_CFG::m_Setup
inherited

◆ 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 files: