PARAM_LIST< Type > Class Template Reference

#include <parameters.h>

Inheritance diagram for PARAM_LIST< Type >:

Public Member Functions
	PARAM_LIST (const std::string &aJsonPath, std::vector< Type > *aPtr, std::initializer_list< Type > aDefault, bool aReadOnly=false)
	PARAM_LIST (const std::string &aJsonPath, std::vector< Type > *aPtr, std::vector< Type > 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...
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::vector< Type > *	m_ptr
std::vector< Type >	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...

Detailed Description

template<typename Type>
class PARAM_LIST< Type >

Definition at line 415 of file parameters.h.

Constructor & Destructor Documentation

PARAM_LIST() [1/2]

template<typename Type >

PARAM_LIST< Type >::PARAM_LIST ( const std::string &  aJsonPath, std::vector< Type > *  aPtr, std::initializer_list< Type >  aDefault, bool  aReadOnly = false  )

inline

Definition at line 418 of file parameters.h.

PARAM_LIST() [2/2]

template<typename Type >

PARAM_LIST< Type >::PARAM_LIST ( const std::string &  aJsonPath, std::vector< Type > *  aPtr, std::vector< Type >  aDefault, bool  aReadOnly = false  )

inline

Definition at line 425 of file parameters.h.

Member Function Documentation

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

void PARAM_LIST< 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 80 of file parameters.cpp.

References JSON_SETTINGS::GetJson().

Referenced by PARAM_PATH_LIST::Load().

MatchesFile()

template<typename ValueType >

bool PARAM_LIST< 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 115 of file parameters.cpp.

References JSON_SETTINGS::GetJson().

SetDefault()

template<typename Type >

void PARAM_LIST< Type >::SetDefault ( )

inlineoverridevirtual

Implements PARAM_BASE.

Definition at line 436 of file parameters.h.

References PARAM_LIST< Type >::m_default, and PARAM_LIST< Type >::m_ptr.

Store()

template<typename ValueType >

void PARAM_LIST< ValueType >::Store ( JSON_SETTINGS *  aSettings ) const

overridevirtual

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

References JSON_SETTINGS::Set().

Member Data Documentation

m_default

template<typename Type >

std::vector<Type> PARAM_LIST< Type >::m_default

protected

Definition at line 446 of file parameters.h.

Referenced by PARAM_LIST< Type >::SetDefault().

m_path

std::string PARAM_BASE::m_path

protectedinherited

the string used to store the param in json files

Definition at line 75 of file parameters.h.

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

m_ptr

template<typename Type >

std::vector<Type>* PARAM_LIST< Type >::m_ptr

protected

Definition at line 444 of file parameters.h.

Referenced by PARAM_LIST< Type >::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 files:

• parameters.h
• parameters.cpp