PARAM_LAMBDA< ValueType > Class Template Reference

Like a normal param, but with custom getter and setter functions. More...

#include <parameters.h>

Inheritance diagram for PARAM_LAMBDA< ValueType >:

Public Member Functions
	PARAM_LAMBDA (const std::string &aJsonPath, std::function< ValueType()> aGetter, std::function< void(ValueType)> aSetter, ValueType aDefault, 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
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_default
std::function< ValueType()>	m_getter
std::function< void(ValueType)>	m_setter

Detailed Description

template<typename ValueType>
class PARAM_LAMBDA< ValueType >

Like a normal param, but with custom getter and setter functions.

Template Parameters

ValueType

is the value to store

Definition at line 280 of file parameters.h.

Constructor & Destructor Documentation

PARAM_LAMBDA()

template<typename ValueType>

PARAM_LAMBDA< ValueType >::PARAM_LAMBDA ( const std::string &  aJsonPath, std::function< ValueType()>  aGetter, std::function< void(ValueType)>  aSetter, ValueType  aDefault, bool  aReadOnly = false  )

inline

Definition at line 283 of file parameters.h.

 :
 PARAM_BASE( aJsonPath, aReadOnly ),
 m_default( aDefault ),
 m_getter( aGetter ),
 m_setter( aSetter )
 { }

Member Function Documentation

GetDefault()

template<typename ValueType>

ValueType PARAM_LAMBDA< ValueType >::GetDefault ( ) const

inline

Definition at line 305 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_LAMBDA< ValueType >::Load ( JSON_SETTINGS *  aSettings, bool  aResetIfMissing = true  ) const

overridevirtual

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 31 of file parameters.cpp.

{
 if( m_readOnly )
 return;

 if( std::is_same<ValueType, nlohmann::json>::value )
 {
 if( OPT<nlohmann::json> optval = aSettings->GetJson( m_path ) )
 m_setter( *optval );
 else
 m_setter( m_default );
 }
 else
 {
 if( OPT<ValueType> optval = aSettings->Get<ValueType>( m_path ) )
 m_setter( *optval );
 else
 m_setter( m_default );
 }
}

MatchesFile()

template<typename ValueType >

bool PARAM_LAMBDA< ValueType >::MatchesFile ( JSON_SETTINGS *  aSettings ) const

overridevirtual

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 54 of file parameters.cpp.

{
 if( std::is_same<ValueType, nlohmann::json>::value )
 {
 if( OPT<nlohmann::json> optval = aSettings->GetJson( m_path ) )
 return *optval == m_getter();
 }
 else
 {
 if( OPT<ValueType> optval = aSettings->Get<ValueType>( m_path ) )
 return *optval == m_getter();
 }

 // Not in file
 return false;
}

SetDefault()

template<typename ValueType>

void PARAM_LAMBDA< ValueType >::SetDefault ( )

inlineoverridevirtual

Implements PARAM_BASE.

Definition at line 310 of file parameters.h.

 {
 m_setter( m_default );
 }

Store()

template<typename ValueType>

void PARAM_LAMBDA< 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 294 of file parameters.h.

 {
 try
 {
 aSettings->Set<ValueType>( m_path, m_getter() );
 }
 catch( ... )
 {
 }
 }

Member Data Documentation

m_default

template<typename ValueType>

ValueType PARAM_LAMBDA< ValueType >::m_default

private

Definition at line 318 of file parameters.h.

Referenced by PARAM_LAMBDA< nlohmann::json >::GetDefault(), and PARAM_LAMBDA< nlohmann::json >::SetDefault().

m_getter

template<typename ValueType>

std::function<ValueType()> PARAM_LAMBDA< ValueType >::m_getter

private

Definition at line 320 of file parameters.h.

Referenced by PARAM_LAMBDA< nlohmann::json >::Store().

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

template<typename ValueType>

std::function<void( ValueType )> PARAM_LAMBDA< ValueType >::m_setter

private

Definition at line 322 of file parameters.h.

Referenced by PARAM_LAMBDA< nlohmann::json >::SetDefault().

---

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

• parameters.h
• parameters.cpp