#include <color_settings.h>

Inheritance diagram for COLOR_MAP_PARAM:

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.

void	Store (JSON_SETTINGS *aSettings) const override
	Stores the value of this parameter to the given JSON_SETTINGS object.

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.

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.

Private Attributes
int	m_key

COLOR4D	m_default

std::unordered_map< int, COLOR4D > *	m_map

Detailed Description

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

◆ GetDefault()

COLOR4D COLOR_MAP_PARAM::GetDefault ( ) const

inline

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

◆ GetKey()

int COLOR_MAP_PARAM::GetKey ( ) const

inline

Definition at line 137 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

aSettings	is the JSON_SETTINGS object to load from.
aResetIfMissing	if true will set the parameter to its default value if load fails

Implements PARAM_BASE.

Definition at line 121 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

aSettings is 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 152 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 147 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

aSettings is the JSON_SETTINGS object to store into.

Implements PARAM_BASE.

Definition at line 132 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 83 of file parameters.h.

◆ m_default

COLOR4D COLOR_MAP_PARAM::m_default

private

Definition at line 164 of file color_settings.h.

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

◆ m_key

int COLOR_MAP_PARAM::m_key

private

Definition at line 162 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 166 of file color_settings.h.

Referenced by MatchesFile().

◆ m_path

std::string PARAM_BASE::m_path

protectedinherited

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

color_settings.h

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ COLOR_MAP_PARAM()

Member Function Documentation

◆ ClearUnknownKeys()

◆ GetDefault()

◆ GetJsonPath()

◆ GetKey()

◆ Load()

◆ MatchesFile()

◆ SetDefault()

◆ Store()

Member Data Documentation

◆ m_clearUnknownKeys

◆ m_default

◆ m_key

◆ m_map

◆ m_path

◆ m_readOnly