KiCad PCB EDA Suite
|
Stores an enum as an integer. More...
#include <parameters.h>
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 |
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 |
Stores an enum as an integer.
Definition at line 225 of file parameters.h.
|
inline |
Definition at line 228 of file parameters.h.
|
inlineinherited |
Definition at line 78 of file parameters.h.
|
inline |
Definition at line 262 of file parameters.h.
References PARAM_ENUM< EnumType >::m_default.
|
inlineinherited |
Definition at line 72 of file parameters.h.
|
inlineoverridevirtual |
Loads the value of this parameter from JSON to the underlying storage.
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 238 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.
|
inlineoverridevirtual |
Checks whether the parameter in memory matches the one in a given JSON file.
aSettings | is a JSON_SETTINGS to check the JSON file contents of |
Implements PARAM_BASE.
Definition at line 272 of file parameters.h.
References JSON_SETTINGS::Get(), and PARAM_BASE::m_path.
|
inlineoverridevirtual |
Implements PARAM_BASE.
Definition at line 267 of file parameters.h.
References PARAM_ENUM< EnumType >::m_default, and PARAM_ENUM< EnumType >::m_ptr.
|
inlineoverridevirtual |
Stores the value of this parameter to the given JSON_SETTINGS object.
aSettings | is the JSON_SETTINGS object to store into. |
Implements PARAM_BASE.
Definition at line 257 of file parameters.h.
References PARAM_BASE::m_path, and JSON_SETTINGS::Set().
|
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 83 of file parameters.h.
|
private |
Definition at line 284 of file parameters.h.
Referenced by PARAM_ENUM< EnumType >::GetDefault(), PARAM_ENUM< EnumType >::Load(), and PARAM_ENUM< EnumType >::SetDefault().
|
private |
Definition at line 283 of file parameters.h.
Referenced by PARAM_ENUM< EnumType >::Load().
|
private |
Definition at line 282 of file parameters.h.
Referenced by PARAM_ENUM< EnumType >::Load().
|
protectedinherited |
Address of the param in the json files.
Definition at line 81 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().
|
private |
Definition at line 281 of file parameters.h.
Referenced by PARAM_ENUM< EnumType >::Load(), and PARAM_ENUM< EnumType >::SetDefault().
|
protectedinherited |
Indicates param pointer should never be overwritten.
Definition at line 82 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().