KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | Private Attributes | List of all members
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 (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.
 
EnumType GetDefault () const
 
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

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 227 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 230 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 EnumType >
EnumType PARAM_ENUM< EnumType >::GetDefault ( ) const
inline

Definition at line 264 of file parameters.h.

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

◆ Load()

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

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 ( 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 274 of file parameters.h.

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

◆ SetClearUnknownKeys()

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

Definition at line 80 of file parameters.h.

◆ SetDefault()

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

Implements PARAM_BASE.

Definition at line 269 of file parameters.h.

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

References PARAM_BASE::m_path, and 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 EnumType >
EnumType PARAM_ENUM< EnumType >::m_default
private

Definition at line 286 of file parameters.h.

Referenced by PARAM_ENUM< EnumType >::GetDefault(), PARAM_ENUM< EnumType >::Load(), and PARAM_ENUM< EnumType >::SetDefault().

◆ m_max

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

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

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

◆ 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 EnumType >
EnumType* PARAM_ENUM< EnumType >::m_ptr
private

Definition at line 283 of file parameters.h.

Referenced by PARAM_ENUM< EnumType >::Load(), and PARAM_ENUM< EnumType >::SetDefault().

◆ 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().

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