KiCad PCB EDA Suite
|
Represents a map of <std::string, Value>. More...
#include <parameters.h>
Public Member Functions | |
PARAM_MAP (const std::string &aJsonPath, std::map< std::string, Value > *aPtr, std::initializer_list< std::pair< const std::string, Value > > 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. | |
void | Store (JSON_SETTINGS *aSettings) const override |
Stores the value of this parameter to the given JSON_SETTINGS object. | |
virtual void | SetDefault () override |
bool | MatchesFile (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 | |
std::map< std::string, Value > * | m_ptr |
std::map< std::string, Value > | m_default |
Represents a map of <std::string, Value>.
The key parameter has to be a string in JSON.
The key must be stored in UTF-8 format, so any translated strings or strings provided by the user as a key must be converted to UTF-8 at the site where they are placed in the underlying map that this PARAM_MAP points to.
Values must also be in UTF-8, but if you use wxString as the value type, this conversion will be done automatically by the to_json and from_json helpers defined in json_settings.cpp
Value | is the value type of the map |
Definition at line 723 of file parameters.h.
|
inline |
Definition at line 726 of file parameters.h.
|
inlineinherited |
Definition at line 78 of file parameters.h.
|
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 734 of file parameters.h.
References JSON_SETTINGS::GetJson().
|
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 768 of file parameters.h.
References JSON_SETTINGS::GetJson().
|
inlineoverridevirtual |
Implements PARAM_BASE.
Definition at line 763 of file parameters.h.
|
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 753 of file parameters.h.
References 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 791 of file parameters.h.
|
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 790 of file parameters.h.
|
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().