KiCad PCB EDA Suite
PARAM< ValueType > Class Template Reference

#include <parameters.h>

Inheritance diagram for PARAM< ValueType >:
PARAM_BASE

Public Member Functions

 PARAM (const std::string &aJsonPath, ValueType *aPtr, ValueType aDefault, bool aReadOnly=false)
 
 PARAM (const std::string &aJsonPath, ValueType *aPtr, ValueType aDefault, ValueType aMin, ValueType aMax, 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
 
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

ValueType * m_ptr
 
ValueType m_default
 
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_min
 
ValueType m_max
 
bool m_use_minmax
 

Detailed Description

template<typename ValueType>
class PARAM< ValueType >

Definition at line 83 of file parameters.h.

Constructor & Destructor Documentation

◆ PARAM() [1/2]

template<typename ValueType >
PARAM< ValueType >::PARAM ( const std::string &  aJsonPath,
ValueType *  aPtr,
ValueType  aDefault,
bool  aReadOnly = false 
)
inline

Definition at line 86 of file parameters.h.

87 :
88 PARAM_BASE( aJsonPath, aReadOnly ),
89 m_min(),
90 m_max(),
91 m_use_minmax( false ),
92 m_ptr( aPtr ),
93 m_default( aDefault )
94 { }
PARAM_BASE(std::string aJsonPath, bool aReadOnly)
Definition: parameters.h:36
ValueType * m_ptr
Definition: parameters.h:156
ValueType m_default
Definition: parameters.h:157
bool m_use_minmax
Definition: parameters.h:153
ValueType m_min
Definition: parameters.h:151
ValueType m_max
Definition: parameters.h:152

◆ PARAM() [2/2]

template<typename ValueType >
PARAM< ValueType >::PARAM ( const std::string &  aJsonPath,
ValueType *  aPtr,
ValueType  aDefault,
ValueType  aMin,
ValueType  aMax,
bool  aReadOnly = false 
)
inline

Definition at line 96 of file parameters.h.

97 :
98 PARAM_BASE( aJsonPath, aReadOnly ),
99 m_min( aMin ),
100 m_max( aMax ),
101 m_use_minmax( true ),
102 m_ptr( aPtr ),
103 m_default( aDefault )
104 { }

Member Function Documentation

◆ GetDefault()

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

Definition at line 132 of file parameters.h.

133 {
134 return m_default;
135 }

References PARAM< 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.

69{ return m_path; }
std::string m_path
the string used to store the param in json files
Definition: parameters.h:75

References PARAM_BASE::m_path.

◆ Load()

template<typename ValueType >
void PARAM< ValueType >::Load ( 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 106 of file parameters.h.

107 {
108 if( m_readOnly )
109 return;
110
111 if( std::optional<ValueType> optval = aSettings->Get<ValueType>( m_path ) )
112 {
113 ValueType val = *optval;
114
115 if( m_use_minmax )
116 {
117 if( m_max < val || val < m_min )
118 val = m_default;
119 }
120
121 *m_ptr = val;
122 }
123 else if( aResetIfMissing )
124 *m_ptr = m_default;
125 }
std::optional< ValueType > Get(const std::string &aPath) const
Fetches a value from within the JSON document.
bool m_readOnly
! True if the parameter pointer should never be overwritten
Definition: parameters.h:78

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

Referenced by PARAM_PATH::Load().

◆ MatchesFile()

template<typename ValueType >
bool PARAM< ValueType >::MatchesFile ( 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 142 of file parameters.h.

143 {
144 if( std::optional<ValueType> optval = aSettings->Get<ValueType>( m_path ) )
145 return *optval == *m_ptr;
146
147 return false;
148 }

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

◆ SetDefault()

template<typename ValueType >
void PARAM< ValueType >::SetDefault ( )
inlineoverridevirtual

Implements PARAM_BASE.

Definition at line 137 of file parameters.h.

138 {
139 *m_ptr = m_default;
140 }

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

◆ Store()

template<typename ValueType >
void PARAM< 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 127 of file parameters.h.

128 {
129 aSettings->Set<ValueType>( m_path, *m_ptr );
130 }
void Set(const std::string &aPath, ValueType aVal)
Stores a value into the JSON document Will throw an exception if ValueType isn't something that the l...

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

Member Data Documentation

◆ m_default

template<typename ValueType >
ValueType PARAM< ValueType >::m_default
protected

◆ m_max

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

Definition at line 152 of file parameters.h.

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

◆ m_min

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

Definition at line 151 of file parameters.h.

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

◆ m_path

◆ m_ptr

template<typename ValueType >
ValueType* PARAM< ValueType >::m_ptr
protected

◆ m_readOnly

bool PARAM_BASE::m_readOnly
protectedinherited

◆ m_use_minmax

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

Definition at line 153 of file parameters.h.

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


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