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	IsDefault () const override
	Checks whether or not this param has been changed from its default value. More...

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 296 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 299 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 340 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 usefull in error messages

Definition at line 74 of file parameters.h.

74 { return m_path; }

PARAM_BASE::m_path

std::string m_path

the string used to store the param in json files

Definition: parameters.h:80

References PARAM_BASE::m_path.

◆ IsDefault()

template<typename ValueType>

bool PARAM_LAMBDA< ValueType >::IsDefault ( ) const

inlineoverridevirtual

Checks whether or not this param has been changed from its default value.

Returns: true if the parameter in memory matches its default value

Implements PARAM_BASE.

Definition at line 350 of file parameters.h.

     {
         return m_getter() == m_default;
     }

◆ Load()

template<typename ValueType>

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

     {
         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

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

     {
         if( std::is_same<ValueType, nlohmann::json>::value )
         {
             if( OPT<nlohmann::json> optval = aSettings->GetJson( m_path ) )
                 return *optval == m_default;
         }
         else
         {
             if( OPT<ValueType> optval = aSettings->Get<ValueType>( m_path ) )
                 return *optval == m_default;
         }
 
         // Not in file
         return false;
     }

◆ SetDefault()

template<typename ValueType>

void PARAM_LAMBDA< ValueType >::SetDefault ( )

inlineoverridevirtual

Implements PARAM_BASE.

Definition at line 345 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 329 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 373 of file parameters.h.

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

◆ m_getter

template<typename ValueType>

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

private

Definition at line 375 of file parameters.h.

Referenced by PARAM_LAMBDA< nlohmann::json >::IsDefault(), and 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 80 of file parameters.h.

◆ m_readOnly

bool PARAM_BASE::m_readOnly

protectedinherited

! True if the parameter pointer should never be overwritten

Definition at line 83 of file parameters.h.

Referenced by PARAM< wxString >::Load(), COLOR_MAP_PARAM::Load(), PARAM_PATH::Load(), PARAM_ENUM< EnumType >::Load(), PARAM_LAMBDA< nlohmann::json >::Load(), PARAM_SCALED< ValueType >::Load(), PARAM_LIST< wxString >::Load(), PARAM_PATH_LIST::Load(), PARAM_MAP< Value >::Load(), and PARAM_WXSTRING_MAP::Load().

◆ m_setter

template<typename ValueType>

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

private

Definition at line 377 of file parameters.h.

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

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

parameters.h

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

template<typename ValueType> class PARAM_LAMBDA< ValueType >

Constructor & Destructor Documentation

◆ PARAM_LAMBDA()

Member Function Documentation

◆ GetDefault()

◆ GetJsonPath()

◆ IsDefault()

◆ Load()

◆ MatchesFile()

◆ SetDefault()

◆ Store()

Member Data Documentation

◆ m_default

◆ m_getter

◆ m_path

◆ m_readOnly

◆ m_setter

template<typename ValueType>
class PARAM_LAMBDA< ValueType >