KiCad PCB EDA Suite
|
#include <parameters.h>
Public Member Functions | |
PARAM_LIST (const std::string &aJsonPath, std::vector< Type > *aPtr, std::initializer_list< Type > aDefault, bool aReadOnly=false) | |
PARAM_LIST (const std::string &aJsonPath, std::vector< Type > *aPtr, std::vector< Type > aDefault, 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... | |
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::vector< Type > * | m_ptr |
std::vector< Type > | 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... | |
Definition at line 415 of file parameters.h.
|
inline |
Definition at line 418 of file parameters.h.
|
inline |
Definition at line 425 of file parameters.h.
|
inlineinherited |
Definition at line 69 of file parameters.h.
References PARAM_BASE::m_path.
|
overridevirtual |
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 80 of file parameters.cpp.
References JSON_SETTINGS::GetJson().
Referenced by PARAM_PATH_LIST::Load().
|
overridevirtual |
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 115 of file parameters.cpp.
References JSON_SETTINGS::GetJson().
|
inlineoverridevirtual |
Implements PARAM_BASE.
Definition at line 436 of file parameters.h.
References PARAM_LIST< Type >::m_default, and PARAM_LIST< Type >::m_ptr.
|
overridevirtual |
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 103 of file parameters.cpp.
References JSON_SETTINGS::Set().
|
protected |
Definition at line 446 of file parameters.h.
Referenced by PARAM_LIST< Type >::SetDefault().
|
protectedinherited |
the string used to store the param in json files
Definition at line 75 of file parameters.h.
Referenced by PARAM_BASE::GetJsonPath(), COLOR_MAP_PARAM::Load(), PARAM< ValueType >::Load(), PARAM_ENUM< EnumType >::Load(), PARAM_SCALED< ValueType >::Load(), PARAM_WXSTRING_MAP::Load(), COLOR_MAP_PARAM::MatchesFile(), PARAM< ValueType >::MatchesFile(), PARAM_PATH::MatchesFile(), PARAM_ENUM< EnumType >::MatchesFile(), PARAM_SCALED< ValueType >::MatchesFile(), PARAM_PATH_LIST::MatchesFile(), PARAM_WXSTRING_MAP::MatchesFile(), COLOR_MAP_PARAM::Store(), PARAM< ValueType >::Store(), PARAM_PATH::Store(), PARAM_ENUM< EnumType >::Store(), PARAM_LAMBDA< ValueType >::Store(), PARAM_SCALED< ValueType >::Store(), PARAM_PATH_LIST::Store(), and PARAM_WXSTRING_MAP::Store().
|
protected |
Definition at line 444 of file parameters.h.
Referenced by PARAM_LIST< Type >::SetDefault().
|
protectedinherited |
! True if the parameter pointer should never be overwritten
Definition at line 78 of file parameters.h.
Referenced by COLOR_MAP_PARAM::Load(), PARAM< ValueType >::Load(), PARAM_PATH::Load(), PARAM_ENUM< EnumType >::Load(), PARAM_SCALED< ValueType >::Load(), PARAM_PATH_LIST::Load(), and PARAM_WXSTRING_MAP::Load().