COLOR_MAP_PARAM Class Reference

#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. 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

Protected Attributes
std::string	m_path
	the string used to store the param in json files More...
bool	m_readOnly
	! True if the parameter pointer should never be overwritten 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

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 69 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

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

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

aSettings

is 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_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

std::string PARAM_BASE::m_path

protectedinherited

the string used to store the param in json files

Definition at line 75 of file parameters.h.

Referenced by PARAM_BASE::GetJsonPath(), Load(), PARAM< ValueType >::Load(), PARAM_ENUM< EnumType >::Load(), PARAM_SCALED< ValueType >::Load(), MatchesFile(), PARAM< ValueType >::MatchesFile(), PARAM_PATH::MatchesFile(), PARAM_ENUM< EnumType >::MatchesFile(), PARAM_SCALED< ValueType >::MatchesFile(), PARAM_PATH_LIST::MatchesFile(), PARAM_WXSTRING_MAP::MatchesFile(), Store(), PARAM< ValueType >::Store(), PARAM_PATH::Store(), PARAM_ENUM< EnumType >::Store(), PARAM_LAMBDA< ValueType >::Store(), PARAM_SCALED< ValueType >::Store(), and PARAM_PATH_LIST::Store().

m_readOnly

bool PARAM_BASE::m_readOnly

protectedinherited

! True if the parameter pointer should never be overwritten

Definition at line 78 of file parameters.h.

Referenced by Load(), PARAM< ValueType >::Load(), PARAM_PATH::Load(), PARAM_ENUM< EnumType >::Load(), PARAM_SCALED< ValueType >::Load(), and PARAM_PATH_LIST::Load().

---

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

• color_settings.h