KiCad PCB EDA Suite
Loading...
Searching...
No Matches
PARAM_LIST< Type > Class Template Reference

#include <parameters.h>

Inheritance diagram for PARAM_LIST< Type >:
PARAM_BASE

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

template<typename Type>
class PARAM_LIST< Type >

Definition at line 476 of file parameters.h.

Constructor & Destructor Documentation

◆ PARAM_LIST() [1/2]

template<typename Type>
PARAM_LIST< Type >::PARAM_LIST ( const std::string & aJsonPath,
std::vector< Type > * aPtr,
std::initializer_list< Type > aDefault,
bool aResetIfEmpty = false )
inline

Definition at line 479 of file parameters.h.

References m_default, m_ptr, m_resetIfEmpty, and PARAM_BASE::PARAM_BASE().

◆ PARAM_LIST() [2/2]

template<typename Type>
PARAM_LIST< Type >::PARAM_LIST ( const std::string & aJsonPath,
std::vector< Type > * aPtr,
std::vector< Type > aDefault,
bool aResetIfEmpty = false )
inline

Definition at line 487 of file parameters.h.

References m_default, m_ptr, m_resetIfEmpty, move, and PARAM_BASE::PARAM_BASE().

Member Function Documentation

◆ 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.

References m_clearUnknownKeys.

◆ 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.

References m_path.

◆ Load()

template<typename Type>
void PARAM_LIST< Type >::Load ( const JSON_SETTINGS & aSettings,
bool aResetIfMissing = true ) const
inlineoverridevirtual

Loads the value of this parameter from JSON to the underlying storage.

Parameters
aSettingsis the JSON_SETTINGS object to load from.
aResetIfMissingif true will set the parameter to its default value if load fails

Implements PARAM_BASE.

Reimplemented in PARAM_PATH_LIST.

Definition at line 495 of file parameters.h.

References JSON_SETTINGS::GetJson(), m_default, PARAM_BASE::m_path, m_ptr, PARAM_BASE::m_readOnly, and m_resetIfEmpty.

Referenced by PARAM_PATH_LIST::Load().

◆ MatchesFile()

template<typename Type>
bool PARAM_LIST< Type >::MatchesFile ( const JSON_SETTINGS & aSettings) const
inlineoverridevirtual

Checks whether the parameter in memory matches the one in a given JSON file.

Parameters
aSettingsis 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.

Reimplemented in PARAM_PATH_LIST.

Definition at line 536 of file parameters.h.

References JSON_SETTINGS::GetJson(), PARAM_BASE::m_path, and m_ptr.

◆ SetClearUnknownKeys()

void PARAM_BASE::SetClearUnknownKeys ( bool aSet = true)
inlineinherited

Definition at line 80 of file parameters.h.

References m_clearUnknownKeys.

Referenced by PARAM_MAP< Value >::PARAM_MAP().

◆ SetDefault()

template<typename Type>
void PARAM_LIST< Type >::SetDefault ( )
inlineoverridevirtual

Implements PARAM_BASE.

Definition at line 531 of file parameters.h.

References m_default, and m_ptr.

◆ Store()

template<typename Type>
void PARAM_LIST< Type >::Store ( JSON_SETTINGS * aSettings) const
inlineoverridevirtual

Stores the value of this parameter to the given JSON_SETTINGS object.

Parameters
aSettingsis the JSON_SETTINGS object to store into.

Implements PARAM_BASE.

Reimplemented in PARAM_PATH_LIST.

Definition at line 521 of file parameters.h.

References PARAM_BASE::m_path, m_ptr, and JSON_SETTINGS::Set().

Member Data Documentation

◆ 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 85 of file parameters.h.

Referenced by ClearUnknownKeys(), PARAM_BASE(), PARAM_WXSTRING_MAP::PARAM_WXSTRING_MAP(), and SetClearUnknownKeys().

◆ m_default

template<typename Type>
std::vector<Type> PARAM_LIST< Type >::m_default
protected

Definition at line 565 of file parameters.h.

Referenced by Load(), PARAM_LIST(), PARAM_LIST(), and SetDefault().

◆ m_path

◆ m_ptr

template<typename Type>
std::vector<Type>* PARAM_LIST< Type >::m_ptr
protected

Definition at line 564 of file parameters.h.

Referenced by Load(), MatchesFile(), PARAM_LIST(), PARAM_LIST(), SetDefault(), and Store().

◆ m_readOnly

◆ m_resetIfEmpty

template<typename Type>
bool PARAM_LIST< Type >::m_resetIfEmpty
protected

Definition at line 566 of file parameters.h.

Referenced by Load(), PARAM_LIST(), and PARAM_LIST().


The documentation for this class was generated from the following file: