PARAM_WXSTRING_MAP Class Reference

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

Detailed Description

A helper for <wxString, wxString> maps.

Definition at line 724 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 727 of file parameters.h.

                                        :
            PARAM_BASE( aJsonPath, aReadOnly ),
            m_ptr( aPtr ),
            m_default( aDefault )
    { }

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

Definition at line 74 of file parameters.h.

{ return m_path; }

References PARAM_BASE::m_path.

IsDefault()

bool PARAM_WXSTRING_MAP::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 775 of file parameters.h.

    {
        return *m_ptr == m_default;
    }

References m_default, and m_ptr.

Load()

void PARAM_WXSTRING_MAP::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 735 of file parameters.h.

    {
        if( m_readOnly )
            return;

        if( OPT<nlohmann::json> js = aSettings->GetJson( m_path ) )
        {
            if( js->is_object() )
            {
                m_ptr->clear();

                for( const auto& el : js->items() )
                {
                    ( *m_ptr )[wxString( el.key().c_str(), wxConvUTF8 )] =
                            el.value().get<wxString>();
                }
            }
        }
        else if( aResetIfMissing )
            *m_ptr = m_default;
    }

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

MatchesFile()

bool PARAM_WXSTRING_MAP::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 780 of file parameters.h.

    {
        if( OPT<nlohmann::json> js = aSettings->GetJson( m_path ) )
        {
            if( js->is_object() )
            {
                if( m_ptr->size() != js->size() )
                    return false;

                std::map<wxString, wxString> val;

                for( const auto& el : js->items() )
                {
                    wxString key( el.key().c_str(), wxConvUTF8 );
                    val[key] = el.value().get<wxString>();
                }

                return val == *m_ptr;
            }
        }

        return false;
    }

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

    {
        *m_ptr = m_default;
    }

References m_default, and m_ptr.

Store()

void PARAM_WXSTRING_MAP::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 757 of file parameters.h.

    {
        nlohmann::json js( {} );

        for( const auto& el : *m_ptr )
        {
            std::string key( el.first.ToUTF8() );
            js[ key ] = el.second;
        }

        aSettings->Set<nlohmann::json>( m_path, js );
    }

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

Referenced by IsDefault(), Load(), and SetDefault().

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.

Referenced by PARAM_BASE::GetJsonPath(), PARAM< wxString >::Load(), COLOR_MAP_PARAM::Load(), PARAM_ENUM< EnumType >::Load(), PARAM_LAMBDA< nlohmann::json >::Load(), PARAM_SCALED< ValueType >::Load(), PARAM_LIST< wxString >::Load(), PARAM_MAP< Value >::Load(), Load(), PARAM< wxString >::MatchesFile(), COLOR_MAP_PARAM::MatchesFile(), PARAM_PATH::MatchesFile(), PARAM_ENUM< EnumType >::MatchesFile(), PARAM_LAMBDA< nlohmann::json >::MatchesFile(), PARAM_SCALED< ValueType >::MatchesFile(), PARAM_LIST< wxString >::MatchesFile(), PARAM_PATH_LIST::MatchesFile(), PARAM_MAP< Value >::MatchesFile(), 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_LIST< wxString >::Store(), PARAM_PATH_LIST::Store(), PARAM_MAP< Value >::Store(), and Store().

m_ptr

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

private

Definition at line 805 of file parameters.h.

Referenced by IsDefault(), 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 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 Load().

---

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

• parameters.h