PARAM_SCALED< ValueType > Class Template Reference

Represents a parameter that has a scaling factor between the value in the file and the value used internally (i.e. More...

#include <parameters.h>

Inheritance diagram for PARAM_SCALED< ValueType >:

Public Member Functions
	PARAM_SCALED (const std::string &aJsonPath, ValueType *aPtr, ValueType aDefault, double aScale=1.0, bool aReadOnly=false)
	PARAM_SCALED (const std::string &aJsonPath, ValueType *aPtr, ValueType aDefault, ValueType aMin, ValueType aMax, double aScale=1.0, bool aReadOnly=false)
void	Load (JSON_SETTINGS *aSettings, bool aResetIfMissing=true) const override
	Loads the value of this parameter from JSON to the underlying storage. More...
void	Store (JSON_SETTINGS *aSettings) const override
	Stores the value of this parameter to the given JSON_SETTINGS object. More...
ValueType	GetDefault () const
virtual void	SetDefault () override
bool	MatchesFile (JSON_SETTINGS *aSettings) const override
	Checks whether the parameter in memory matches the one in a given JSON file. More...
const std::string &	GetJsonPath () const

Protected Attributes
std::string	m_path
	the string used to store the param in json files More...
bool	m_readOnly
	! True if the parameter pointer should never be overwritten More...

Private Attributes
ValueType *	m_ptr
ValueType	m_default
ValueType	m_min
ValueType	m_max
bool	m_use_minmax
double	m_scale

Detailed Description

template<typename ValueType>
class PARAM_SCALED< ValueType >

Represents a parameter that has a scaling factor between the value in the file and the value used internally (i.e.

the value pointer). This basically only makes sense to use with int or double as ValueType.

Template Parameters

ValueType

is the internal type: the file always stores a double.

Definition at line 334 of file parameters.h.

Constructor & Destructor Documentation

PARAM_SCALED() [1/2]

template<typename ValueType >

PARAM_SCALED< ValueType >::PARAM_SCALED ( const std::string &  aJsonPath, ValueType *  aPtr, ValueType  aDefault, double  aScale = 1.0, bool  aReadOnly = false  )

inline

Definition at line 337 of file parameters.h.

 :
 PARAM_BASE( aJsonPath, aReadOnly ),
 m_ptr( aPtr ),
 m_default( aDefault ),
 m_min(),
 m_max(),
 m_use_minmax( false ),
 m_scale( aScale )
 { }

PARAM_SCALED() [2/2]

template<typename ValueType >

PARAM_SCALED< ValueType >::PARAM_SCALED ( const std::string &  aJsonPath, ValueType *  aPtr, ValueType  aDefault, ValueType  aMin, ValueType  aMax, double  aScale = 1.0, bool  aReadOnly = false  )

inline

Definition at line 348 of file parameters.h.

 :
 PARAM_BASE( aJsonPath, aReadOnly ),
 m_ptr( aPtr ),
 m_default( aDefault ),
 m_min( aMin ),
 m_max( aMax ),
 m_use_minmax( true ),
 m_scale( aScale )
 { }

Member Function Documentation

GetDefault()

template<typename ValueType >

ValueType PARAM_SCALED< ValueType >::GetDefault ( ) const

inline

Definition at line 387 of file parameters.h.

 {
 return m_default;
 }

References PARAM_SCALED< ValueType >::m_default.

GetJsonPath()

const std::string & PARAM_BASE::GetJsonPath ( ) const

inlineinherited

Returns

the path name of the parameter used to store it in the json file mainly useful in error messages

Definition at line 69 of file parameters.h.

{ return m_path; }

References PARAM_BASE::m_path.

Load()

template<typename ValueType >

void PARAM_SCALED< ValueType >::Load ( JSON_SETTINGS *  aSettings, bool  aResetIfMissing = true  ) const

inlineoverridevirtual

Loads the value of this parameter from JSON to the underlying storage.

Parameters

aSettings	is the JSON_SETTINGS object to load from.
aResetIfMissing	if true will set the parameter to its default value if load fails

Implements PARAM_BASE.

Definition at line 359 of file parameters.h.

 {
 if( m_readOnly )
 return;
 
 double dval = m_default * m_scale;
 
 if( std::optional<double> optval = aSettings->Get<double>( m_path ) )
 dval = *optval;
 else if( !aResetIfMissing )
 return;
 
 ValueType val = KiROUND<ValueType>( dval / m_scale );
 
 if( m_use_minmax )
 {
 if( val > m_max || val < m_min )
 val = m_default;
 }
 
 *m_ptr = val;
 }

References JSON_SETTINGS::Get(), PARAM_SCALED< ValueType >::m_default, PARAM_SCALED< ValueType >::m_max, PARAM_SCALED< ValueType >::m_min, PARAM_BASE::m_path, PARAM_SCALED< ValueType >::m_ptr, PARAM_BASE::m_readOnly, PARAM_SCALED< ValueType >::m_scale, and PARAM_SCALED< ValueType >::m_use_minmax.

MatchesFile()

template<typename ValueType >

bool PARAM_SCALED< ValueType >::MatchesFile ( JSON_SETTINGS *  aSettings ) const

inlineoverridevirtual

Checks whether the parameter in memory matches the one in a given JSON file.

Parameters

aSettings

is a JSON_SETTINGS to check the JSON file contents of

Returns

true if the parameter in memory matches its value in the file

Implements PARAM_BASE.

Definition at line 397 of file parameters.h.

 {
 if( std::optional<double> optval = aSettings->Get<double>( m_path ) )
 return *optval == ( *m_ptr * m_scale );
 
 return false;
 }

References JSON_SETTINGS::Get(), PARAM_BASE::m_path, PARAM_SCALED< ValueType >::m_ptr, and PARAM_SCALED< ValueType >::m_scale.

SetDefault()

template<typename ValueType >

virtual void PARAM_SCALED< ValueType >::SetDefault ( )

inlineoverridevirtual

Implements PARAM_BASE.

Definition at line 392 of file parameters.h.

 {
 *m_ptr = m_default;
 }

References PARAM_SCALED< ValueType >::m_default, and PARAM_SCALED< ValueType >::m_ptr.

Store()

template<typename ValueType >

void PARAM_SCALED< ValueType >::Store ( JSON_SETTINGS *  aSettings ) const

inlineoverridevirtual

Stores the value of this parameter to the given JSON_SETTINGS object.

Parameters

aSettings

is the JSON_SETTINGS object to store into.

Implements PARAM_BASE.

Definition at line 382 of file parameters.h.

 {
 aSettings->Set<double>( m_path, *m_ptr * m_scale );
 }

References PARAM_BASE::m_path, PARAM_SCALED< ValueType >::m_ptr, PARAM_SCALED< ValueType >::m_scale, and JSON_SETTINGS::Set().

Member Data Documentation

m_default

template<typename ValueType >

ValueType PARAM_SCALED< ValueType >::m_default

private

Definition at line 407 of file parameters.h.

Referenced by PARAM_SCALED< ValueType >::GetDefault(), PARAM_SCALED< ValueType >::Load(), and PARAM_SCALED< ValueType >::SetDefault().

m_max

template<typename ValueType >

ValueType PARAM_SCALED< ValueType >::m_max

private

Definition at line 409 of file parameters.h.

Referenced by PARAM_SCALED< ValueType >::Load().

m_min

template<typename ValueType >

ValueType PARAM_SCALED< ValueType >::m_min

private

Definition at line 408 of file parameters.h.

Referenced by PARAM_SCALED< ValueType >::Load().

m_path

std::string PARAM_BASE::m_path

protectedinherited

the string used to store the param in json files

Definition at line 75 of file parameters.h.

Referenced by PARAM_BASE::GetJsonPath(), COLOR_MAP_PARAM::Load(), PARAM< ValueType >::Load(), PARAM_ENUM< EnumType >::Load(), PARAM_SCALED< ValueType >::Load(), COLOR_MAP_PARAM::MatchesFile(), PARAM< ValueType >::MatchesFile(), PARAM_PATH::MatchesFile(), PARAM_ENUM< EnumType >::MatchesFile(), PARAM_SCALED< ValueType >::MatchesFile(), PARAM_PATH_LIST::MatchesFile(), PARAM_WXSTRING_MAP::MatchesFile(), COLOR_MAP_PARAM::Store(), PARAM< ValueType >::Store(), PARAM_PATH::Store(), PARAM_ENUM< EnumType >::Store(), PARAM_LAMBDA< ValueType >::Store(), PARAM_SCALED< ValueType >::Store(), and PARAM_PATH_LIST::Store().

m_ptr

template<typename ValueType >

ValueType* PARAM_SCALED< ValueType >::m_ptr

private

Definition at line 406 of file parameters.h.

Referenced by PARAM_SCALED< ValueType >::Load(), PARAM_SCALED< ValueType >::MatchesFile(), PARAM_SCALED< ValueType >::SetDefault(), and PARAM_SCALED< ValueType >::Store().

m_readOnly

bool PARAM_BASE::m_readOnly

protectedinherited

! True if the parameter pointer should never be overwritten

Definition at line 78 of file parameters.h.

Referenced by COLOR_MAP_PARAM::Load(), PARAM< ValueType >::Load(), PARAM_PATH::Load(), PARAM_ENUM< EnumType >::Load(), PARAM_SCALED< ValueType >::Load(), PARAM_PATH_LIST::Load(), and PARAM_WXSTRING_MAP::Load().

m_scale

template<typename ValueType >

double PARAM_SCALED< ValueType >::m_scale

private

Definition at line 411 of file parameters.h.

Referenced by PARAM_SCALED< ValueType >::Load(), PARAM_SCALED< ValueType >::MatchesFile(), and PARAM_SCALED< ValueType >::Store().

m_use_minmax

template<typename ValueType >

bool PARAM_SCALED< ValueType >::m_use_minmax

private

Definition at line 410 of file parameters.h.

Referenced by PARAM_SCALED< ValueType >::Load().

---

The documentation for this class was generated from the following file:

• parameters.h