KiCad PCB EDA Suite
PARAM_ENUM< EnumType > Class Template Reference

Stores an enum as an integer. More...

#include <parameters.h>

Inheritance diagram for PARAM_ENUM< EnumType >:
PARAM_BASE

Public Member Functions

 PARAM_ENUM (const std::string &aJsonPath, EnumType *aPtr, EnumType aDefault, EnumType aMin, EnumType 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...
 
EnumType 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

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

EnumType * m_ptr
 
EnumType m_min
 
EnumType m_max
 
EnumType m_default
 

Detailed Description

template<typename EnumType>
class PARAM_ENUM< EnumType >

Stores an enum as an integer.

Definition at line 216 of file parameters.h.

Constructor & Destructor Documentation

◆ PARAM_ENUM()

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

Definition at line 219 of file parameters.h.

220 :
221 PARAM_BASE( aJsonPath, aReadOnly ),
222 m_ptr( aPtr ),
223 m_min( aMin ),
224 m_max( aMax ),
225 m_default( aDefault )
226 {
227 }
PARAM_BASE(std::string aJsonPath, bool aReadOnly)
Definition: parameters.h:36
EnumType m_default
Definition: parameters.h:273
EnumType * m_ptr
Definition: parameters.h:270
EnumType m_min
Definition: parameters.h:271
EnumType m_max
Definition: parameters.h:272

Member Function Documentation

◆ GetDefault()

template<typename EnumType >
EnumType PARAM_ENUM< EnumType >::GetDefault ( ) const
inline

Definition at line 251 of file parameters.h.

252 {
253 return m_default;
254 }

References PARAM_ENUM< EnumType >::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 EnumType >
void PARAM_ENUM< EnumType >::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 229 of file parameters.h.

230 {
231 if( m_readOnly )
232 return;
233
234 if( std::optional<int> val = aSettings->Get<int>( m_path ) )
235 {
236 if( *val >= static_cast<int>( m_min ) && *val <= static_cast<int>( m_max ) )
237 *m_ptr = static_cast<EnumType>( *val );
238 else if( aResetIfMissing )
239 *m_ptr = m_default;
240
241 }
242 else if( aResetIfMissing )
243 *m_ptr = m_default;
244 }
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_ENUM< EnumType >::m_default, PARAM_ENUM< EnumType >::m_max, PARAM_ENUM< EnumType >::m_min, PARAM_BASE::m_path, PARAM_ENUM< EnumType >::m_ptr, and PARAM_BASE::m_readOnly.

◆ MatchesFile()

template<typename EnumType >
bool PARAM_ENUM< EnumType >::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 261 of file parameters.h.

262 {
263 if( std::optional<int> val = aSettings->Get<int>( m_path ) )
264 return *val == static_cast<int>( *m_ptr );
265
266 return false;
267 }

References JSON_SETTINGS::Get(), and PARAM_BASE::m_path.

◆ SetDefault()

template<typename EnumType >
void PARAM_ENUM< EnumType >::SetDefault ( )
inlineoverridevirtual

Implements PARAM_BASE.

Definition at line 256 of file parameters.h.

257 {
258 *m_ptr = m_default;
259 }

References PARAM_ENUM< EnumType >::m_default, and PARAM_ENUM< EnumType >::m_ptr.

◆ Store()

template<typename EnumType >
void PARAM_ENUM< EnumType >::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 246 of file parameters.h.

247 {
248 aSettings->Set<int>( m_path, static_cast<int>( *m_ptr ) );
249 }
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, and JSON_SETTINGS::Set().

Member Data Documentation

◆ m_default

template<typename EnumType >
EnumType PARAM_ENUM< EnumType >::m_default
private

◆ m_max

template<typename EnumType >
EnumType PARAM_ENUM< EnumType >::m_max
private

Definition at line 272 of file parameters.h.

Referenced by PARAM_ENUM< EnumType >::Load().

◆ m_min

template<typename EnumType >
EnumType PARAM_ENUM< EnumType >::m_min
private

Definition at line 271 of file parameters.h.

Referenced by PARAM_ENUM< EnumType >::Load().

◆ m_path

◆ m_ptr

template<typename EnumType >
EnumType* PARAM_ENUM< EnumType >::m_ptr
private

◆ m_readOnly

bool PARAM_BASE::m_readOnly
protectedinherited

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