KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | Private Attributes | List of all members
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 >:
PARAM_BASE

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 (const JSON_SETTINGS &aSettings, bool aResetIfMissing=true) const override
 Loads the value of this parameter from JSON to the underlying storage.
 
void Store (JSON_SETTINGS *aSettings) const override
 Stores the value of this parameter to the given JSON_SETTINGS object.
 
ValueType GetDefault () const
 
virtual void SetDefault () override
 
bool MatchesFile (const JSON_SETTINGS &aSettings) const override
 Checks whether the parameter in memory matches the one in a given JSON file.
 
const std::string & GetJsonPath () const
 
bool ClearUnknownKeys () const
 
void SetClearUnknownKeys (bool aSet=true)
 

Protected Attributes

std::string m_path
 Address of the param in the json files.
 
bool m_readOnly
 Indicates param pointer should never be overwritten.
 
bool m_clearUnknownKeys
 Keys should be cleared from source rather than merged.
 

Private Attributes

ValueType * m_ptr
 
ValueType m_default
 
ValueType m_min
 
ValueType m_max
 
bool m_use_minmax
 
double m_scale
 
double m_invScale
 

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
ValueTypeis the internal type: the file always stores a double.

Definition at line 391 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 394 of file parameters.h.

◆ 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 406 of file parameters.h.

Member Function Documentation

◆ ClearUnknownKeys()

bool PARAM_BASE::ClearUnknownKeys ( ) const
inlineinherited
Returns
true if keys should be cleared from source file rather than merged. Useful for things such as text variables that are semantically an array but stored as a map.

Definition at line 78 of file parameters.h.

◆ GetDefault()

template<typename ValueType >
ValueType PARAM_SCALED< ValueType >::GetDefault ( ) const
inline

Definition at line 446 of file parameters.h.

◆ 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 72 of file parameters.h.

◆ Load()

template<typename ValueType >
void PARAM_SCALED< ValueType >::Load ( const JSON_SETTINGS &  aSettings,
bool  aResetIfMissing = true 
) const
inlineoverridevirtual

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

Parameters
aSettingsis the JSON_SETTINGS object to load from.
aResetIfMissingif true will set the parameter to its default value if load fails

Implements PARAM_BASE.

Definition at line 418 of file parameters.h.

References JSON_SETTINGS::Get().

◆ MatchesFile()

template<typename ValueType >
bool PARAM_SCALED< ValueType >::MatchesFile ( const JSON_SETTINGS &  aSettings) const
inlineoverridevirtual

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

Parameters
aSettingsis 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 456 of file parameters.h.

References JSON_SETTINGS::Get().

◆ SetClearUnknownKeys()

void PARAM_BASE::SetClearUnknownKeys ( bool  aSet = true)
inlineinherited

Definition at line 80 of file parameters.h.

◆ SetDefault()

template<typename ValueType >
virtual void PARAM_SCALED< ValueType >::SetDefault ( )
inlineoverridevirtual

Implements PARAM_BASE.

Definition at line 451 of file parameters.h.

◆ 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
aSettingsis the JSON_SETTINGS object to store into.

Implements PARAM_BASE.

Definition at line 441 of file parameters.h.

References JSON_SETTINGS::Set().

Member Data Documentation

◆ m_clearUnknownKeys

bool PARAM_BASE::m_clearUnknownKeys
protectedinherited

Keys should be cleared from source rather than merged.

This is useful for things that are semantically an array but stored as a map, such as textVars.

Definition at line 85 of file parameters.h.

◆ m_default

template<typename ValueType >
ValueType PARAM_SCALED< ValueType >::m_default
private

Definition at line 466 of file parameters.h.

◆ m_invScale

template<typename ValueType >
double PARAM_SCALED< ValueType >::m_invScale
private

Definition at line 471 of file parameters.h.

◆ m_max

template<typename ValueType >
ValueType PARAM_SCALED< ValueType >::m_max
private

Definition at line 468 of file parameters.h.

◆ m_min

template<typename ValueType >
ValueType PARAM_SCALED< ValueType >::m_min
private

Definition at line 467 of file parameters.h.

◆ m_path

std::string PARAM_BASE::m_path
protectedinherited

Address of the param in the json files.

Definition at line 83 of file parameters.h.

Referenced by COLOR_MAP_PARAM::Load(), PARAM< ValueType >::Load(), PARAM_ENUM< EnumType >::Load(), PARAM_LAMBDA< ValueType >::Load(), PARAM_LIST< Type >::Load(), PARAM_WXSTRING_MAP::Load(), COLOR_MAP_PARAM::MatchesFile(), PARAM< ValueType >::MatchesFile(), PARAM_ENUM< EnumType >::MatchesFile(), PARAM_LAMBDA< ValueType >::MatchesFile(), PARAM_LIST< Type >::MatchesFile(), PARAM_PATH_LIST::MatchesFile(), PARAM_WXSTRING_MAP::MatchesFile(), COLOR_MAP_PARAM::Store(), PARAM< ValueType >::Store(), PARAM_ENUM< EnumType >::Store(), PARAM_LAMBDA< ValueType >::Store(), PARAM_LIST< Type >::Store(), PARAM_PATH_LIST::Store(), and PARAM_WXSTRING_MAP::Store().

◆ m_ptr

template<typename ValueType >
ValueType* PARAM_SCALED< ValueType >::m_ptr
private

Definition at line 465 of file parameters.h.

◆ m_readOnly

bool PARAM_BASE::m_readOnly
protectedinherited

Indicates param pointer should never be overwritten.

Definition at line 84 of file parameters.h.

Referenced by COLOR_MAP_PARAM::Load(), PARAM< ValueType >::Load(), PARAM_ENUM< EnumType >::Load(), PARAM_LAMBDA< ValueType >::Load(), PARAM_LIST< Type >::Load(), and PARAM_WXSTRING_MAP::Load().

◆ m_scale

template<typename ValueType >
double PARAM_SCALED< ValueType >::m_scale
private

Definition at line 470 of file parameters.h.

◆ m_use_minmax

template<typename ValueType >
bool PARAM_SCALED< ValueType >::m_use_minmax
private

Definition at line 469 of file parameters.h.

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