Stores an enum as an integer. More...

#include <parameters.h>

Inheritance diagram for PARAM_ENUM< EnumType >:

Public Member Functions
	PARAM_ENUM (const std::string &aJsonPath, EnumType *aPtr, EnumType aDefault, EnumType aMin, EnumType aMax, 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...

EnumType	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
EnumType *	m_ptr

EnumType	m_min

EnumType	m_max

EnumType	m_default

Detailed Description

template<typename EnumType>
class PARAM_ENUM< EnumType >

Stores an enum as an integer.

Definition at line 216 of file parameters.h.

Constructor & Destructor Documentation

◆ PARAM_ENUM()

template<typename EnumType >

PARAM_ENUM< EnumType >::PARAM_ENUM	(	const std::string &	aJsonPath,
		EnumType *	aPtr,
		EnumType	aDefault,
		EnumType	aMin,
		EnumType	aMax,
		bool	aReadOnly = `false`
	)

inline

Definition at line 219 of file parameters.h.

Member Function Documentation

◆ GetDefault()

template<typename EnumType >

EnumType PARAM_ENUM< EnumType >::GetDefault ( ) const

inline

Definition at line 251 of file parameters.h.

References PARAM_ENUM< EnumType >::m_default.

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

◆ Load()

template<typename EnumType >

void PARAM_ENUM< EnumType >::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 229 of file parameters.h.

References JSON_SETTINGS::Get(), PARAM_ENUM< EnumType >::m_default, PARAM_ENUM< EnumType >::m_max, PARAM_ENUM< EnumType >::m_min, PARAM_BASE::m_path, PARAM_ENUM< EnumType >::m_ptr, and PARAM_BASE::m_readOnly.

◆ MatchesFile()

template<typename EnumType >

bool PARAM_ENUM< EnumType >::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 261 of file parameters.h.

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

◆ SetDefault()

template<typename EnumType >

void PARAM_ENUM< EnumType >::SetDefault ( )

inlineoverridevirtual

Implements PARAM_BASE.

Definition at line 256 of file parameters.h.

References PARAM_ENUM< EnumType >::m_default, and PARAM_ENUM< EnumType >::m_ptr.

◆ Store()

template<typename EnumType >

void PARAM_ENUM< EnumType >::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 246 of file parameters.h.

References PARAM_BASE::m_path, and JSON_SETTINGS::Set().

Member Data Documentation

◆ m_default

template<typename EnumType >

EnumType PARAM_ENUM< EnumType >::m_default

private

Definition at line 273 of file parameters.h.

Referenced by PARAM_ENUM< EnumType >::GetDefault(), PARAM_ENUM< EnumType >::Load(), and PARAM_ENUM< EnumType >::SetDefault().

◆ m_max

template<typename EnumType >

EnumType PARAM_ENUM< EnumType >::m_max

private

Definition at line 272 of file parameters.h.

Referenced by PARAM_ENUM< EnumType >::Load().

◆ m_min

template<typename EnumType >

EnumType PARAM_ENUM< EnumType >::m_min

private

Definition at line 271 of file parameters.h.

Referenced by PARAM_ENUM< EnumType >::Load().

◆ m_path

std::string PARAM_BASE::m_path

protectedinherited

◆ m_ptr

template<typename EnumType >

EnumType* PARAM_ENUM< EnumType >::m_ptr

private

Definition at line 270 of file parameters.h.

Referenced by PARAM_ENUM< EnumType >::Load(), and PARAM_ENUM< EnumType >::SetDefault().

◆ 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 COLOR_MAP_PARAM::Load(), PARAM< ValueType >::Load(), PARAM_PATH::Load(), PARAM_ENUM< EnumType >::Load(), PARAM_SCALED< ValueType >::Load(), PARAM_PATH_LIST::Load(), and PARAM_WXSTRING_MAP::Load().

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

parameters.h

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PARAM_ENUM()

Member Function Documentation

◆ GetDefault()

◆ GetJsonPath()

◆ Load()

◆ MatchesFile()

◆ SetDefault()

◆ Store()

Member Data Documentation

◆ m_default

◆ m_max

◆ m_min

◆ m_path

◆ m_ptr

◆ m_readOnly