A helper for <wxString, wxString> maps. More...

#include <parameters.h>

Inheritance diagram for PARAM_WXSTRING_MAP:

Public Member Functions
	PARAM_WXSTRING_MAP (const std::string &aJsonPath, std::map< wxString, wxString > *aPtr, std::initializer_list< std::pair< const wxString, wxString > > 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...

virtual 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
std::map< wxString, wxString > *	m_ptr

std::map< wxString, wxString >	m_default

Detailed Description

A helper for <wxString, wxString> maps.

Definition at line 579 of file parameters.h.

Constructor & Destructor Documentation

◆ PARAM_WXSTRING_MAP()

PARAM_WXSTRING_MAP::PARAM_WXSTRING_MAP	(	const std::string &	aJsonPath,
		std::map< wxString, wxString > *	aPtr,
		std::initializer_list< std::pair< const wxString, wxString > >	aDefault,
		bool	aReadOnly = `false`
	)

inline

Definition at line 582 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()

void PARAM_WXSTRING_MAP::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 302 of file parameters.cpp.

References JSON_SETTINGS::GetJson(), PARAM_BASE::m_path, m_ptr, and PARAM_BASE::m_readOnly.

◆ MatchesFile()

bool PARAM_WXSTRING_MAP::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 338 of file parameters.cpp.

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

◆ SetDefault()

virtual void PARAM_WXSTRING_MAP::SetDefault ( )

inlineoverridevirtual

Implements PARAM_BASE.

Definition at line 594 of file parameters.h.

References m_default, and m_ptr.

◆ Store()

void PARAM_WXSTRING_MAP::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 324 of file parameters.cpp.

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

Member Data Documentation

◆ m_default

std::map<wxString, wxString> PARAM_WXSTRING_MAP::m_default

private

Definition at line 604 of file parameters.h.

Referenced by SetDefault().

◆ m_path

std::string PARAM_BASE::m_path

protectedinherited

◆ m_ptr

std::map<wxString, wxString>* PARAM_WXSTRING_MAP::m_ptr

private

Definition at line 602 of file parameters.h.

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

◆ 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 Load().

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

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PARAM_WXSTRING_MAP()

Member Function Documentation

◆ GetJsonPath()

◆ Load()

◆ MatchesFile()

◆ SetDefault()

◆ Store()

Member Data Documentation

◆ m_default

◆ m_path

◆ m_ptr

◆ m_readOnly