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 aReadOnly=false)
 
 PARAM_LIST (const std::string &aJsonPath, std::vector< Type > *aPtr, std::vector< Type > 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. More...
 
void Store (JSON_SETTINGS *aSettings) const override
 Stores the value of this parameter to the given JSON_SETTINGS object. More...
 
void SetDefault () override
 
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 () const
 
bool ClearUnknownKeys () const
 

Protected Attributes

std::vector< Type > * m_ptr
 
std::vector< Type > m_default
 
std::string m_path
 Address of the param in the json files. More...
 
bool m_readOnly
 Indicates param pointer should never be overwritten. More...
 
bool m_clearUnknownKeys
 Keys should be cleared from source rather than merged. More...
 

Detailed Description

template<typename Type>
class PARAM_LIST< Type >

Definition at line 474 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  aReadOnly = false 
)
inline

Definition at line 477 of file parameters.h.

◆ 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  aReadOnly = false 
)
inline

Definition at line 484 of file parameters.h.

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

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

◆ Load()

template<typename Type >
void PARAM_LIST< Type >::Load ( 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.

Definition at line 491 of file parameters.h.

References JSON_SETTINGS::GetJson(), PARAM_LIST< Type >::m_default, PARAM_BASE::m_path, PARAM_LIST< Type >::m_ptr, and PARAM_BASE::m_readOnly.

Referenced by PARAM_PATH_LIST::Load().

◆ MatchesFile()

template<typename Type >
bool PARAM_LIST< Type >::MatchesFile ( 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.

Definition at line 527 of file parameters.h.

References JSON_SETTINGS::GetJson(), PARAM_BASE::m_path, and PARAM_LIST< Type >::m_ptr.

◆ SetDefault()

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

Implements PARAM_BASE.

Definition at line 522 of file parameters.h.

References PARAM_LIST< Type >::m_default, and PARAM_LIST< Type >::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.

Definition at line 512 of file parameters.h.

References PARAM_BASE::m_path, PARAM_LIST< Type >::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 84 of file parameters.h.

◆ m_default

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

Definition at line 556 of file parameters.h.

Referenced by PARAM_LIST< Type >::Load(), and PARAM_LIST< Type >::SetDefault().

◆ m_path

◆ m_ptr

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

◆ m_readOnly

bool PARAM_BASE::m_readOnly
protectedinherited

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