KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
PARAM_BASE Class Referenceabstract

#include <parameters.h>

Inheritance diagram for PARAM_BASE:
PARAM< wxString > PARAM_LAMBDA< nlohmann::json > PARAM_LIST< wxString > COLOR_MAP_PARAM PARAM< ValueType > PARAM_ENUM< EnumType > PARAM_LAMBDA< ValueType > PARAM_LIST< Type > PARAM_MAP< Value > PARAM_SCALED< ValueType > PARAM_SET< Type > PARAM_WXSTRING_MAP

Public Member Functions

 PARAM_BASE (std::string aJsonPath, bool aReadOnly)
 
virtual ~PARAM_BASE ()=default
 
virtual void Load (JSON_SETTINGS *aSettings, bool aResetIfMissing=true) const =0
 Loads the value of this parameter from JSON to the underlying storage.
 
virtual void Store (JSON_SETTINGS *aSettings) const =0
 Stores the value of this parameter to the given JSON_SETTINGS object.
 
virtual void SetDefault ()=0
 
virtual bool MatchesFile (JSON_SETTINGS *aSettings) const =0
 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::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

Definition at line 35 of file parameters.h.

Constructor & Destructor Documentation

◆ PARAM_BASE()

PARAM_BASE::PARAM_BASE ( std::string  aJsonPath,
bool  aReadOnly 
)
inline

Definition at line 38 of file parameters.h.

◆ ~PARAM_BASE()

virtual PARAM_BASE::~PARAM_BASE ( )
virtualdefault

Member Function Documentation

◆ ClearUnknownKeys()

bool PARAM_BASE::ClearUnknownKeys ( ) const
inline
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
inline
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()

virtual void PARAM_BASE::Load ( JSON_SETTINGS *  aSettings,
bool  aResetIfMissing = true 
) const
pure virtual

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

Implemented in COLOR_MAP_PARAM, PARAM< ValueType >, PARAM< wxString >, PARAM_PATH, PARAM_ENUM< EnumType >, PARAM_LAMBDA< ValueType >, PARAM_LAMBDA< nlohmann::json >, PARAM_SCALED< ValueType >, PARAM_LIST< Type >, PARAM_LIST< wxString >, PARAM_SET< Type >, PARAM_PATH_LIST, PARAM_MAP< Value >, and PARAM_WXSTRING_MAP.

◆ MatchesFile()

virtual bool PARAM_BASE::MatchesFile ( JSON_SETTINGS *  aSettings) const
pure virtual

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

Implemented in COLOR_MAP_PARAM, PARAM< ValueType >, PARAM< wxString >, PARAM_PATH, PARAM_ENUM< EnumType >, PARAM_LAMBDA< ValueType >, PARAM_LAMBDA< nlohmann::json >, PARAM_SCALED< ValueType >, PARAM_LIST< Type >, PARAM_LIST< wxString >, PARAM_SET< Type >, PARAM_PATH_LIST, PARAM_MAP< Value >, and PARAM_WXSTRING_MAP.

◆ SetDefault()

virtual void PARAM_BASE::SetDefault ( )
pure virtual

Implemented in COLOR_MAP_PARAM, PARAM< ValueType >, PARAM< wxString >, PARAM_ENUM< EnumType >, PARAM_LAMBDA< ValueType >, PARAM_LAMBDA< nlohmann::json >, PARAM_SCALED< ValueType >, PARAM_LIST< Type >, PARAM_LIST< wxString >, PARAM_SET< Type >, PARAM_MAP< Value >, and PARAM_WXSTRING_MAP.

◆ Store()

virtual void PARAM_BASE::Store ( JSON_SETTINGS *  aSettings) const
pure virtual

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

Parameters
aSettingsis the JSON_SETTINGS object to store into.

Implemented in COLOR_MAP_PARAM, PARAM< ValueType >, PARAM< wxString >, PARAM_PATH, PARAM_ENUM< EnumType >, PARAM_LAMBDA< ValueType >, PARAM_LAMBDA< nlohmann::json >, PARAM_SCALED< ValueType >, PARAM_LIST< Type >, PARAM_LIST< wxString >, PARAM_SET< Type >, PARAM_PATH_LIST, PARAM_MAP< Value >, and PARAM_WXSTRING_MAP.

Member Data Documentation

◆ m_clearUnknownKeys

bool PARAM_BASE::m_clearUnknownKeys
protected

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_path

std::string PARAM_BASE::m_path
protected

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_readOnly

bool PARAM_BASE::m_readOnly
protected

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: