#include <parameters.h>

Inheritance diagram for PARAM< ValueType >:

Public Member Functions
	PARAM (const std::string &aJsonPath, ValueType *aPtr, const ValueType &aDefault, bool aReadOnly=false)

	PARAM (const std::string &aJsonPath, ValueType *aPtr, const ValueType &aDefault, const ValueType &aMin, const ValueType &aMax, bool aReadOnly=false)

void	Load (const 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.

ValueType	GetDefault () const

void	SetDefault () override

bool	MatchesFile (const 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

void	SetClearUnknownKeys (bool aSet=true)

Protected Attributes
ValueType *	m_ptr

ValueType	m_default

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

ValueType	m_max

bool	m_use_minmax

Detailed Description

template<typename ValueType>
class PARAM< ValueType >

Definition at line 92 of file parameters.h.

Constructor & Destructor Documentation

◆ PARAM() [1/2]

template<typename ValueType>

PARAM< ValueType >::PARAM	(	const std::string &	aJsonPath,
		ValueType *	aPtr,
		const ValueType &	aDefault,
		bool	aReadOnly = false )

inline

Definition at line 95 of file parameters.h.

References m_default, m_max, m_min, m_ptr, m_use_minmax, and PARAM_BASE::PARAM_BASE().

◆ PARAM() [2/2]

template<typename ValueType>

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

inline

Definition at line 105 of file parameters.h.

References m_default, m_max, m_min, m_ptr, m_use_minmax, and PARAM_BASE::PARAM_BASE().

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.

References m_clearUnknownKeys.

◆ GetDefault()

template<typename ValueType>

ValueType PARAM< ValueType >::GetDefault ( ) const

inline

Definition at line 143 of file parameters.h.

References 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 72 of file parameters.h.

References m_path.

◆ Load()

template<typename ValueType>

void PARAM< ValueType >::Load	(	const 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.

Reimplemented in PARAM_PATH.

Definition at line 115 of file parameters.h.

References JSON_SETTINGS::Get(), m_default, m_max, m_min, PARAM_BASE::m_path, m_ptr, PARAM_BASE::m_readOnly, and m_use_minmax.

Referenced by PARAM_PATH::Load().

◆ MatchesFile()

template<typename ValueType>

bool PARAM< ValueType >::MatchesFile ( const 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.

Reimplemented in PARAM_PATH.

Definition at line 153 of file parameters.h.

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

◆ SetClearUnknownKeys()

void PARAM_BASE::SetClearUnknownKeys ( bool aSet = true )

inlineinherited

Definition at line 80 of file parameters.h.

References m_clearUnknownKeys.

Referenced by PARAM_MAP< Value >::PARAM_MAP().

◆ SetDefault()

template<typename ValueType>

void PARAM< ValueType >::SetDefault ( )

inlineoverridevirtual

Implements PARAM_BASE.

Definition at line 148 of file parameters.h.

References m_default, and m_ptr.

◆ Store()

template<typename ValueType>

void PARAM< ValueType >::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.

Reimplemented in PARAM_PATH.

Definition at line 138 of file parameters.h.

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

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

◆ m_default

template<typename ValueType>

ValueType PARAM< ValueType >::m_default

protected

Definition at line 168 of file parameters.h.

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

◆ m_max

template<typename ValueType>

ValueType PARAM< ValueType >::m_max

private

Definition at line 163 of file parameters.h.

Referenced by Load(), PARAM(), and PARAM().

◆ m_min

template<typename ValueType>

ValueType PARAM< ValueType >::m_min

private

Definition at line 162 of file parameters.h.

Referenced by Load(), PARAM(), and PARAM().

◆ m_path

std::string PARAM_BASE::m_path

protectedinherited

Address of the param in the json files.

Definition at line 83 of file parameters.h.

Referenced by GetJsonPath(), COLOR_MAP_PARAM::Load(), PARAM< ValueType >::Load(), PARAM_ENUM< EnumType >::Load(), PARAM_LAMBDA< ValueType >::Load(), PARAM_LIST< Type >::Load(), PARAM_MAP< Value >::Load(), PARAM_SCALED< ValueType >::Load(), PARAM_SET< 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_MAP< Value >::MatchesFile(), PARAM_SCALED< ValueType >::MatchesFile(), PARAM_SET< Type >::MatchesFile(), PARAM_WXSTRING_MAP::MatchesFile(), PARAM_BASE(), COLOR_MAP_PARAM::Store(), PARAM< ValueType >::Store(), PARAM_ENUM< EnumType >::Store(), PARAM_LAMBDA< ValueType >::Store(), PARAM_LIST< Type >::Store(), PARAM_MAP< Value >::Store(), PARAM_SCALED< ValueType >::Store(), PARAM_SET< Type >::Store(), and PARAM_WXSTRING_MAP::Store().

◆ m_ptr

template<typename ValueType>

ValueType* PARAM< ValueType >::m_ptr

protected

Definition at line 167 of file parameters.h.

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

◆ m_readOnly

bool PARAM_BASE::m_readOnly

protectedinherited

Indicates param pointer should never be overwritten.

Definition at line 84 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_MAP< Value >::Load(), PARAM_SCALED< ValueType >::Load(), PARAM_SET< Type >::Load(), PARAM_WXSTRING_MAP::Load(), and PARAM_BASE().

◆ m_use_minmax

template<typename ValueType>

bool PARAM< ValueType >::m_use_minmax

private

Definition at line 164 of file parameters.h.

Referenced by Load(), PARAM(), and PARAM().

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() [1/2]

◆ PARAM() [2/2]

Member Function Documentation

◆ ClearUnknownKeys()

◆ GetDefault()

◆ GetJsonPath()

◆ Load()

◆ MatchesFile()

◆ SetClearUnknownKeys()

◆ SetDefault()

◆ Store()

Member Data Documentation

◆ m_clearUnknownKeys

◆ m_default

◆ m_max

◆ m_min

◆ m_path

◆ m_ptr

◆ m_readOnly

◆ m_use_minmax