KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
PARAM_SET< Type > Class Template Reference

#include <parameters.h>

Inheritance diagram for PARAM_SET< Type >:
PARAM_BASE

Public Member Functions

 PARAM_SET (const std::string &aJsonPath, std::set< Type > *aPtr, std::initializer_list< Type > aDefault, bool aReadOnly=false)
 
 PARAM_SET (const std::string &aJsonPath, std::set< Type > *aPtr, std::set< 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.
 
void Store (JSON_SETTINGS *aSettings) const override
 Stores the value of this parameter to the given JSON_SETTINGS object.
 
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::set< Type > * m_ptr
 
std::set< Type > m_default
 
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_SET< Type >

Definition at line 577 of file parameters.h.

Constructor & Destructor Documentation

◆ PARAM_SET() [1/2]

template<typename Type >
PARAM_SET< Type >::PARAM_SET ( const std::string &  aJsonPath,
std::set< Type > *  aPtr,
std::initializer_list< Type >  aDefault,
bool  aReadOnly = false 
)
inline

Definition at line 580 of file parameters.h.

◆ PARAM_SET() [2/2]

template<typename Type >
PARAM_SET< Type >::PARAM_SET ( const std::string &  aJsonPath,
std::set< Type > *  aPtr,
std::set< Type >  aDefault,
bool  aReadOnly = false 
)
inline

Definition at line 587 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 78 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 72 of file parameters.h.

◆ Load()

template<typename Type >
void PARAM_SET< 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 594 of file parameters.h.

References JSON_SETTINGS::GetJson().

◆ MatchesFile()

template<typename Type >
bool PARAM_SET< 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 631 of file parameters.h.

References JSON_SETTINGS::GetJson().

◆ SetDefault()

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

Implements PARAM_BASE.

Definition at line 626 of file parameters.h.

◆ Store()

template<typename Type >
void PARAM_SET< 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 615 of file parameters.h.

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

◆ m_default

template<typename Type >
std::set<Type> PARAM_SET< Type >::m_default
protected

Definition at line 651 of file parameters.h.

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

template<typename Type >
std::set<Type>* PARAM_SET< Type >::m_ptr
protected

Definition at line 650 of file parameters.h.

◆ m_readOnly

bool PARAM_BASE::m_readOnly
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().

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