![]() |
KiCad PCB EDA Suite
|
#include <parameters.h>
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 | IsDefault () const override |
Checks whether or not this param has been changed from its default value. More... | |
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 () |
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 |
Definition at line 88 of file parameters.h.
|
inline |
Definition at line 91 of file parameters.h.
|
inline |
Definition at line 101 of file parameters.h.
|
inline |
Definition at line 137 of file parameters.h.
|
inlineinherited |
Definition at line 74 of file parameters.h.
References PARAM_BASE::m_path.
|
inlineoverridevirtual |
Checks whether or not this param has been changed from its default value.
Implements PARAM_BASE.
Definition at line 147 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 111 of file parameters.h.
Referenced by PARAM_PATH::Load().
|
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 152 of file parameters.h.
|
inlineoverridevirtual |
|
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 132 of file parameters.h.
|
protected |
Definition at line 167 of file parameters.h.
Referenced by PARAM< wxString >::GetDefault(), PARAM< wxString >::IsDefault(), PARAM< wxString >::Load(), and PARAM< wxString >::SetDefault().
|
private |
Definition at line 162 of file parameters.h.
Referenced by PARAM< wxString >::Load().
|
private |
Definition at line 161 of file parameters.h.
Referenced by PARAM< wxString >::Load().
|
protectedinherited |
the string used to store the param in json files
Definition at line 80 of file parameters.h.
Referenced by PARAM_BASE::GetJsonPath(), PARAM< wxString >::Load(), COLOR_MAP_PARAM::Load(), PARAM_ENUM< EnumType >::Load(), PARAM_LAMBDA< nlohmann::json >::Load(), PARAM_SCALED< ValueType >::Load(), PARAM_LIST< wxString >::Load(), PARAM_MAP< Value >::Load(), PARAM_WXSTRING_MAP::Load(), PARAM< wxString >::MatchesFile(), COLOR_MAP_PARAM::MatchesFile(), PARAM_PATH::MatchesFile(), PARAM_ENUM< EnumType >::MatchesFile(), PARAM_LAMBDA< nlohmann::json >::MatchesFile(), PARAM_SCALED< ValueType >::MatchesFile(), PARAM_LIST< wxString >::MatchesFile(), PARAM_PATH_LIST::MatchesFile(), PARAM_MAP< Value >::MatchesFile(), PARAM_WXSTRING_MAP::MatchesFile(), PARAM< wxString >::Store(), COLOR_MAP_PARAM::Store(), PARAM_PATH::Store(), PARAM_ENUM< EnumType >::Store(), PARAM_LAMBDA< nlohmann::json >::Store(), PARAM_SCALED< ValueType >::Store(), PARAM_LIST< wxString >::Store(), PARAM_PATH_LIST::Store(), PARAM_MAP< Value >::Store(), and PARAM_WXSTRING_MAP::Store().
|
protected |
Definition at line 166 of file parameters.h.
Referenced by PARAM< wxString >::IsDefault(), PARAM< wxString >::Load(), PARAM< wxString >::MatchesFile(), PARAM< wxString >::SetDefault(), and PARAM< wxString >::Store().
|
protectedinherited |
! True if the parameter pointer should never be overwritten
Definition at line 83 of file parameters.h.
Referenced by PARAM< wxString >::Load(), COLOR_MAP_PARAM::Load(), PARAM_PATH::Load(), PARAM_ENUM< EnumType >::Load(), PARAM_LAMBDA< nlohmann::json >::Load(), PARAM_SCALED< ValueType >::Load(), PARAM_LIST< wxString >::Load(), PARAM_PATH_LIST::Load(), PARAM_MAP< Value >::Load(), and PARAM_WXSTRING_MAP::Load().
|
private |
Definition at line 163 of file parameters.h.
Referenced by PARAM< wxString >::Load().