KiCad PCB EDA Suite
Loading...
Searching...
No Matches
COLOR_MAP_PARAM Class Reference

#include <color_settings.h>

Inheritance diagram for COLOR_MAP_PARAM:
PARAM_BASE

Public Member Functions

 COLOR_MAP_PARAM (const std::string &aJsonPath, int aMapKey, COLOR4D aDefault, std::unordered_map< int, COLOR4D > *aMap, 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...
 
int GetKey () const
 
COLOR4D GetDefault () const
 
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::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...
 

Private Attributes

int m_key
 
COLOR4D m_default
 
std::unordered_map< int, COLOR4D > * m_map
 

Detailed Description

Definition at line 116 of file color_settings.h.

Constructor & Destructor Documentation

◆ COLOR_MAP_PARAM()

COLOR_MAP_PARAM::COLOR_MAP_PARAM ( const std::string &  aJsonPath,
int  aMapKey,
COLOR4D  aDefault,
std::unordered_map< int, COLOR4D > *  aMap,
bool  aReadOnly = false 
)
inline

Definition at line 119 of file color_settings.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 76 of file parameters.h.

References PARAM_BASE::m_clearUnknownKeys.

◆ GetDefault()

COLOR4D COLOR_MAP_PARAM::GetDefault ( ) const
inline

Definition at line 146 of file color_settings.h.

References m_default.

Referenced by COLOR_SETTINGS::GetDefaultColor().

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

References PARAM_BASE::m_path.

◆ GetKey()

int COLOR_MAP_PARAM::GetKey ( ) const
inline

Definition at line 141 of file color_settings.h.

References m_key.

Referenced by COLOR_SETTINGS::GetDefaultColor().

◆ Load()

void COLOR_MAP_PARAM::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 125 of file color_settings.h.

References JSON_SETTINGS::Get(), m_default, m_key, PARAM_BASE::m_path, and PARAM_BASE::m_readOnly.

◆ MatchesFile()

bool COLOR_MAP_PARAM::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 156 of file color_settings.h.

References JSON_SETTINGS::Get(), m_key, m_map, and PARAM_BASE::m_path.

◆ SetDefault()

void COLOR_MAP_PARAM::SetDefault ( )
inlineoverridevirtual

Implements PARAM_BASE.

Definition at line 151 of file color_settings.h.

References m_default, and m_key.

◆ Store()

void COLOR_MAP_PARAM::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 136 of file color_settings.h.

References m_key, PARAM_BASE::m_path, 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 81 of file parameters.h.

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

◆ m_default

COLOR4D COLOR_MAP_PARAM::m_default
private

Definition at line 168 of file color_settings.h.

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

◆ m_key

int COLOR_MAP_PARAM::m_key
private

Definition at line 166 of file color_settings.h.

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

◆ m_map

std::unordered_map<int, COLOR4D>* COLOR_MAP_PARAM::m_map
private

Definition at line 170 of file color_settings.h.

Referenced by MatchesFile().

◆ m_path

◆ m_readOnly

bool PARAM_BASE::m_readOnly
protectedinherited

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