#include <board_project_settings.h>
|
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.
|
|
Definition at line 188 of file board_project_settings.h.
◆ PARAM_LAYER_PRESET()
PARAM_LAYER_PRESET::PARAM_LAYER_PRESET |
( |
const std::string & |
aPath, |
|
|
std::vector< LAYER_PRESET > * |
aPresetList |
|
) |
| |
◆ 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()
nlohmann::json PARAM_LAMBDA< nlohmann::json >::GetDefault |
( |
| ) |
const |
|
inlineinherited |
◆ 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.
◆ jsonToPresets()
void PARAM_LAYER_PRESET::jsonToPresets |
( |
const nlohmann::json & |
aJson | ) |
|
|
private |
◆ Load()
|
inlineoverridevirtualinherited |
Loads the value of this parameter from JSON to the underlying storage.
- Parameters
-
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 305 of file parameters.h.
◆ MatchesFile()
|
inlineoverridevirtualinherited |
Checks whether the parameter in memory matches the one in a given JSON file.
- Parameters
-
- Returns
- true if the parameter in memory matches its value in the file
Implements PARAM_BASE.
Definition at line 347 of file parameters.h.
◆ presetsToJson()
nlohmann::json PARAM_LAYER_PRESET::presetsToJson |
( |
| ) |
|
|
private |
◆ SetDefault()
|
inlineoverridevirtualinherited |
◆ Store()
|
inlineoverridevirtualinherited |
◆ 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 83 of file parameters.h.
◆ m_default
◆ m_getter
std::function<nlohmann::json ()> PARAM_LAMBDA< nlohmann::json >::m_getter |
|
privateinherited |
◆ m_path
std::string PARAM_BASE::m_path |
|
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().
◆ m_presets
◆ m_readOnly
bool PARAM_BASE::m_readOnly |
|
protectedinherited |
◆ m_setter
std::function<void( nlohmann::json )> PARAM_LAMBDA< nlohmann::json >::m_setter |
|
privateinherited |
The documentation for this class was generated from the following files: