KiCad PCB EDA Suite
PARAM_CFG_DOUBLE Class Reference

Configuration object for double precision floating point numbers. More...

#include <config_params.h>

Inheritance diagram for PARAM_CFG_DOUBLE:
PARAM_CFG

Public Member Functions

 PARAM_CFG_DOUBLE (const wxString &ident, double *ptparam, double default_val=0.0, double min=0.0, double max=10000.0, const wxChar *group=nullptr)
 
 PARAM_CFG_DOUBLE (bool Insetup, const wxString &ident, double *ptparam, double default_val=0.0, double min=0.0, double max=10000.0, const wxChar *group=nullptr)
 
virtual void ReadParam (wxConfigBase *aConfig) const override
 Read the value of the parameter stored in aConfig. More...
 
virtual void SaveParam (wxConfigBase *aConfig) const override
 Save the value of the parameter stored in aConfig. More...
 

Public Attributes

double * m_Pt_param
 Pointer to the parameter value. More...
 
double m_Default
 The default value of the parameter. More...
 
double m_Min
 
double m_Max
 Minimum and maximum values of the param type. 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 object for double precision floating point numbers.

Definition at line 170 of file config_params.h.

Constructor & Destructor Documentation

◆ PARAM_CFG_DOUBLE() [1/2]

PARAM_CFG_DOUBLE::PARAM_CFG_DOUBLE ( const wxString &  ident,
double *  ptparam,
double  default_val = 0.0,
double  min = 0.0,
double  max = 10000.0,
const wxChar *  group = nullptr 
)

Definition at line 244 of file config_params.cpp.

246  :
247  PARAM_CFG( ident, PARAM_DOUBLE, group )
248 {
249  m_Pt_param = ptparam;
250  m_Default = default_val;
251  m_Min = min;
252  m_Max = max;
253 }
double * m_Pt_param
Pointer to the parameter value.
PARAM_CFG(const wxString &ident, const paramcfg_id type, const wxChar *group=nullptr, const wxString &legacy_ident=wxEmptyString)
double m_Max
Minimum and maximum values of the param type.
double m_Default
The default value of the parameter.

References group, m_Default, m_Max, m_Min, and m_Pt_param.

◆ PARAM_CFG_DOUBLE() [2/2]

PARAM_CFG_DOUBLE::PARAM_CFG_DOUBLE ( bool  Insetup,
const wxString &  ident,
double *  ptparam,
double  default_val = 0.0,
double  min = 0.0,
double  max = 10000.0,
const wxChar *  group = nullptr 
)

Definition at line 256 of file config_params.cpp.

262  :
263  PARAM_CFG( ident, PARAM_DOUBLE, group )
264 {
265  m_Pt_param = ptparam;
266  m_Default = default_val;
267  m_Min = min;
268  m_Max = max;
269  m_Setup = Insetup;
270 }
bool m_Setup
Install or Project based parameter, true == install.
double * m_Pt_param
Pointer to the parameter value.
PARAM_CFG(const wxString &ident, const paramcfg_id type, const wxChar *group=nullptr, const wxString &legacy_ident=wxEmptyString)
double m_Max
Minimum and maximum values of the param type.
double m_Default
The default value of the parameter.

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

Member Function Documentation

◆ ReadParam()

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

Read the value of the parameter stored in aConfig.

Parameters
aConfigthe wxConfigBase that holds the parameter.

Reimplemented from PARAM_CFG.

Definition at line 273 of file config_params.cpp.

274 {
275  if( !m_Pt_param || !aConfig )
276  return;
277 
278  double dtmp = m_Default;
279  aConfig->Read( m_Ident, &dtmp );
280 
281  if( (dtmp < m_Min) || (dtmp > m_Max) )
282  dtmp = m_Default;
283 
284  *m_Pt_param = dtmp;
285 }
wxString m_Ident
Keyword in config data.
double * m_Pt_param
Pointer to the parameter value.
double m_Max
Minimum and maximum values of the param type.
double m_Default
The default value of the parameter.

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

◆ SaveParam()

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

Save the value of the parameter stored in aConfig.

Parameters
aConfigthe wxConfigBase that can store the parameter.

Reimplemented from PARAM_CFG.

Definition at line 288 of file config_params.cpp.

289 {
290  if( !m_Pt_param || !aConfig )
291  return;
292 
293  // We cannot use aConfig->Write for a double, because
294  // this function uses a format with very few digits in mantissa,
295  // and truncature issues are frequent.
296  // We uses our function.
298 }
wxString m_Ident
Keyword in config data.
double * m_Pt_param
Pointer to the parameter value.
void ConfigBaseWriteDouble(wxConfigBase *aConfig, const wxString &aKey, double aValue)
A helper function to write doubles in configuration file.

References ConfigBaseWriteDouble(), PARAM_CFG::m_Ident, and m_Pt_param.

Member Data Documentation

◆ m_Default

double PARAM_CFG_DOUBLE::m_Default

The default value of the parameter.

Definition at line 184 of file config_params.h.

Referenced by PARAM_CFG_DOUBLE(), and 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

double PARAM_CFG_DOUBLE::m_Max

Minimum and maximum values of the param type.

Definition at line 185 of file config_params.h.

Referenced by PARAM_CFG_DOUBLE(), and ReadParam().

◆ m_Min

double PARAM_CFG_DOUBLE::m_Min

Definition at line 185 of file config_params.h.

Referenced by PARAM_CFG_DOUBLE(), and ReadParam().

◆ m_Pt_param

double* PARAM_CFG_DOUBLE::m_Pt_param

Pointer to the parameter value.

Definition at line 183 of file config_params.h.

Referenced by PARAM_CFG_DOUBLE(), ReadParam(), and 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: