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

#include <config_params.h>

Inheritance diagram for PARAM_CFG_DOUBLE:

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.

 :
 PARAM_CFG( ident, PARAM_DOUBLE, group )
{
 m_Pt_param = ptparam;
 m_Default = default_val;
 m_Min = min;
 m_Max = max;
}

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.

 :
 PARAM_CFG( ident, PARAM_DOUBLE, group )
{
 m_Pt_param = ptparam;
 m_Default = default_val;
 m_Min = min;
 m_Max = max;
 m_Setup = Insetup;
}

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

aConfig the wxConfigBase that holds the parameter.

Reimplemented from PARAM_CFG.

Definition at line 273 of file config_params.cpp.

{
 if( !m_Pt_param || !aConfig )
 return;
 
 double dtmp = m_Default;
 aConfig->Read( m_Ident, &dtmp );
 
 if( (dtmp < m_Min) || (dtmp > m_Max) )
 dtmp = m_Default;
 
 *m_Pt_param = dtmp;
}

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

aConfig the wxConfigBase that can store the parameter.

Reimplemented from PARAM_CFG.

Definition at line 288 of file config_params.cpp.

{
 if( !m_Pt_param || !aConfig )
 return;
 
 // We cannot use aConfig->Write for a double, because
 // this function uses a format with very few digits in mantissa,
 // and truncature issues are frequent.
 // We uses our function.
 ConfigBaseWriteDouble( aConfig, m_Ident, *m_Pt_param );
}

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

wxString PARAM_CFG::m_Ident

inherited

◆ m_Ident_legacy

wxString PARAM_CFG::m_Ident_legacy

inherited

Definition at line 109 of file config_params.h.

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

◆ 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

Install or Project based parameter, true == install.

Definition at line 105 of file config_params.h.

Referenced by PARAM_CFG::PARAM_CFG(), PARAM_CFG_BOOL::PARAM_CFG_BOOL(), PARAM_CFG_DOUBLE(), PARAM_CFG_INT::PARAM_CFG_INT(), PARAM_CFG_WXSTRING::PARAM_CFG_WXSTRING(), and PARAM_CFG_WXSTRING_SET::PARAM_CFG_WXSTRING_SET().

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

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PARAM_CFG_DOUBLE() [1/2]

◆ PARAM_CFG_DOUBLE() [2/2]

Member Function Documentation

◆ ReadParam()

◆ SaveParam()

Member Data Documentation

◆ m_Default

◆ m_Group

◆ m_Ident

◆ m_Ident_legacy

◆ m_Max

◆ m_Min

◆ m_Pt_param

◆ m_Setup

◆ m_Type