KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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 168 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 243 of file config_params.cpp.

References 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 255 of file config_params.cpp.

References 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 272 of file config_params.cpp.

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 287 of file config_params.cpp.

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 182 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 102 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 183 of file config_params.h.

Referenced by PARAM_CFG_DOUBLE(), and ReadParam().

◆ m_Min

double PARAM_CFG_DOUBLE::m_Min

Definition at line 183 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 181 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 101 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: