#include <parameters.h>
Public Member Functions | |
| PARAM_LIST (const std::string &aJsonPath, std::vector< Type > *aPtr, std::initializer_list< Type > aDefault, bool aResetIfEmpty=false) | |
| PARAM_LIST (const std::string &aJsonPath, std::vector< Type > *aPtr, std::vector< Type > aDefault, bool aResetIfEmpty=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. | |
| 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 |
| void | SetClearUnknownKeys (bool aSet=true) |
Protected Attributes | |
| std::vector< Type > * | m_ptr |
| std::vector< Type > | m_default |
| bool | m_resetIfEmpty |
| 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. | |
Detailed Description
class PARAM_LIST< Type >
Definition at line 475 of file parameters.h.
Constructor & Destructor Documentation
◆ PARAM_LIST() [1/2]
|
inline |
Definition at line 478 of file parameters.h.
◆ PARAM_LIST() [2/2]
|
inline |
Definition at line 486 of file parameters.h.
Member Function Documentation
◆ ClearUnknownKeys()
|
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.
◆ GetJsonPath()
|
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.
◆ Load()
|
inlineoverridevirtual |
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 494 of file parameters.h.
References JSON_SETTINGS::GetJson(), PARAM_LIST< Type >::m_default, PARAM_BASE::m_path, PARAM_LIST< Type >::m_ptr, PARAM_BASE::m_readOnly, and PARAM_LIST< Type >::m_resetIfEmpty.
Referenced by PARAM_PATH_LIST::Load().
◆ MatchesFile()
|
inlineoverridevirtual |
Checks whether the parameter in memory matches the one in a given JSON file.
- Parameters
-
aSettings is a JSON_SETTINGS to check the JSON file contents of
- Returns
- true if the parameter in memory matches its value in the file
Implements PARAM_BASE.
Definition at line 535 of file parameters.h.
References JSON_SETTINGS::GetJson(), PARAM_BASE::m_path, and PARAM_LIST< Type >::m_ptr.
◆ SetClearUnknownKeys()
|
inlineinherited |
Definition at line 80 of file parameters.h.
◆ SetDefault()
|
inlineoverridevirtual |
Implements PARAM_BASE.
Definition at line 530 of file parameters.h.
References PARAM_LIST< Type >::m_default, and PARAM_LIST< Type >::m_ptr.
◆ Store()
|
inlineoverridevirtual |
Stores the value of this parameter to the given JSON_SETTINGS object.
- Parameters
-
aSettings is the JSON_SETTINGS object to store into.
Implements PARAM_BASE.
Definition at line 520 of file parameters.h.
References PARAM_BASE::m_path, PARAM_LIST< Type >::m_ptr, and JSON_SETTINGS::Set().
Member Data Documentation
◆ 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 85 of file parameters.h.
◆ m_default
|
protected |
Definition at line 564 of file parameters.h.
Referenced by PARAM_LIST< Type >::Load(), and PARAM_LIST< Type >::SetDefault().
◆ m_path
|
protectedinherited |
Address of the param in the json files.
Definition at line 83 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_ptr
|
protected |
Definition at line 563 of file parameters.h.
Referenced by PARAM_LIST< Type >::Load(), PARAM_LIST< Type >::MatchesFile(), PARAM_LIST< Type >::SetDefault(), and PARAM_LIST< Type >::Store().
◆ m_readOnly
|
protectedinherited |
Indicates param pointer should never be overwritten.
Definition at line 84 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().
◆ m_resetIfEmpty
|
protected |
Definition at line 565 of file parameters.h.
Referenced by PARAM_LIST< Type >::Load().
The documentation for this class was generated from the following file:
