PARAM< ValueType > Class Template Reference

#include <parameters.h>

Inheritance diagram for PARAM< ValueType >:

Public Member Functions
	PARAM (const std::string &aJsonPath, ValueType *aPtr, ValueType aDefault, bool aReadOnly=false)
	PARAM (const std::string &aJsonPath, ValueType *aPtr, ValueType aDefault, ValueType aMin, ValueType 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...
ValueType	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
ValueType *	m_ptr
ValueType	m_default
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
ValueType	m_min
ValueType	m_max
bool	m_use_minmax

Detailed Description

template<typename ValueType>
class PARAM< ValueType >

Definition at line 82 of file parameters.h.

Constructor & Destructor Documentation

PARAM() [1/2]

template<typename ValueType>

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

inline

Definition at line 85 of file parameters.h.

 :
 PARAM_BASE( aJsonPath, aReadOnly ),
 m_min(),
 m_max(),
 m_use_minmax( false ),
 m_ptr( aPtr ),
 m_default( aDefault )
 { }

PARAM() [2/2]

template<typename ValueType>

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

inline

Definition at line 95 of file parameters.h.

 :
 PARAM_BASE( aJsonPath, aReadOnly ),
 m_min( aMin ),
 m_max( aMax ),
 m_use_minmax( true ),
 m_ptr( aPtr ),
 m_default( aDefault )
 { }

Member Function Documentation

GetDefault()

template<typename ValueType>

ValueType PARAM< ValueType >::GetDefault ( ) const

inline

Definition at line 131 of file parameters.h.

 {
 return 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 68 of file parameters.h.

{ return m_path; }

References PARAM_BASE::m_path.

Load()

template<typename ValueType>

void PARAM< ValueType >::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 105 of file parameters.h.

 {
 if( m_readOnly )
 return;

 if( OPT<ValueType> optval = aSettings->Get<ValueType>( m_path ) )
 {
 ValueType val = *optval;

 if( m_use_minmax )
 {
 if( m_max < val || val < m_min )
 val = m_default;
 }

 *m_ptr = val;
 }
 else if( aResetIfMissing )
 *m_ptr = m_default;
 }

Referenced by PARAM_PATH::Load().

MatchesFile()

template<typename ValueType>

bool PARAM< ValueType >::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 141 of file parameters.h.

 {
 if( OPT<ValueType> optval = aSettings->Get<ValueType>( m_path ) )
 return *optval == *m_ptr;

 return false;
 }

SetDefault()

template<typename ValueType>

void PARAM< ValueType >::SetDefault ( )

inlineoverridevirtual

Implements PARAM_BASE.

Definition at line 136 of file parameters.h.

 {
 *m_ptr = m_default;
 }

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.

Definition at line 126 of file parameters.h.

 {
 aSettings->Set<ValueType>( m_path, *m_ptr );
 }

Member Data Documentation

m_default

template<typename ValueType>

ValueType PARAM< ValueType >::m_default

protected

Definition at line 156 of file parameters.h.

Referenced by PARAM< wxString >::GetDefault(), PARAM< wxString >::Load(), and PARAM< wxString >::SetDefault().

m_max

template<typename ValueType>

ValueType PARAM< ValueType >::m_max

private

Definition at line 151 of file parameters.h.

Referenced by PARAM< wxString >::Load().

m_min

template<typename ValueType>

ValueType PARAM< ValueType >::m_min

private

Definition at line 150 of file parameters.h.

Referenced by PARAM< wxString >::Load().

m_path

std::string PARAM_BASE::m_path

protectedinherited

the string used to store the param in json files

Definition at line 74 of file parameters.h.

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

m_ptr

template<typename ValueType>

ValueType* PARAM< ValueType >::m_ptr

protected

Definition at line 155 of file parameters.h.

Referenced by PARAM< wxString >::Load(), PARAM< wxString >::MatchesFile(), PARAM< wxString >::SetDefault(), and PARAM< wxString >::Store().

m_readOnly

bool PARAM_BASE::m_readOnly

protectedinherited

! True if the parameter pointer should never be overwritten

Definition at line 77 of file parameters.h.

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

m_use_minmax

template<typename ValueType>

bool PARAM< ValueType >::m_use_minmax

private

Definition at line 152 of file parameters.h.

Referenced by PARAM< wxString >::Load().

---

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

• parameters.h