PARAM_PATH_LIST Class Reference

Represents a list of strings holding directory paths. More...

#include <parameters.h>

Inheritance diagram for PARAM_PATH_LIST:

Public Member Functions
	PARAM_PATH_LIST (const std::string &aJsonPath, std::vector< wxString > *aPtr, std::initializer_list< wxString > aDefault, bool aReadOnly=false)
	PARAM_PATH_LIST (const std::string &aJsonPath, std::vector< wxString > *aPtr, std::vector< 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...
bool	MatchesFile (JSON_SETTINGS *aSettings) const override
	Checks whether the parameter in memory matches the one in a given JSON file. More...
void	SetDefault () override
bool	IsDefault () const override
	Checks whether or not this param has been changed from its default value. More...
const std::string &	GetJsonPath () const

Protected Attributes
std::vector< wxString > *	m_ptr
std::vector< wxString >	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...

Private Member Functions
wxString	toFileFormat (const wxString &aString) const
wxString	fromFileFormat (const wxString &aString) const

Detailed Description

Represents a list of strings holding directory paths.

Normalizes paths to unix directory separator style in the file.

Definition at line 560 of file parameters.h.

Constructor & Destructor Documentation

PARAM_PATH_LIST() [1/2]

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

inline

Definition at line 563 of file parameters.h.

                                                                                      :
            PARAM_LIST( aJsonPath, aPtr, aDefault, aReadOnly )
    { }

PARAM_PATH_LIST() [2/2]

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

inline

Definition at line 568 of file parameters.h.

                                                                            :
            PARAM_LIST( aJsonPath, aPtr, aDefault, aReadOnly )
    { }

Member Function Documentation

fromFileFormat()

wxString PARAM_PATH_LIST::fromFileFormat ( const wxString &  aString ) const

inlineprivate

Definition at line 620 of file parameters.h.

    {
        wxString ret = aString;
#ifdef __WINDOWS__
        ret.Replace( wxT( "/" ), wxT( "\\" ) );
#endif
        return ret;
    }

Referenced by Load(), and MatchesFile().

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_LIST< wxString >::IsDefault ( ) const

inlineoverridevirtualinherited

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

    {
        return *m_ptr == m_default;
    }

Load()

void PARAM_PATH_LIST::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 573 of file parameters.h.

    {
        if( m_readOnly )
            return;

        PARAM_LIST::Load( aSettings, aResetIfMissing );

        for( size_t i = 0; i < m_ptr->size(); i++ )
            ( *m_ptr )[i] = fromFileFormat( ( *m_ptr )[i] );
    }

References fromFileFormat(), PARAM_LIST< Type >::Load(), PARAM_LIST< wxString >::m_ptr, and PARAM_BASE::m_readOnly.

MatchesFile()

bool PARAM_PATH_LIST::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 594 of file parameters.h.

    {
        if( OPT<nlohmann::json> js = aSettings->GetJson( m_path ) )
        {
            if( js->is_array() )
            {
                std::vector<wxString> val;

                for( const auto& el : js->items() )
                    val.emplace_back( fromFileFormat( el.value().get<wxString>() ) );

                return val == *m_ptr;
            }
        }

        return false;
    }

References fromFileFormat(), JSON_SETTINGS::GetJson(), PARAM_BASE::m_path, and PARAM_LIST< wxString >::m_ptr.

SetDefault()

void PARAM_LIST< wxString >::SetDefault ( )

inlineoverridevirtualinherited

Implements PARAM_BASE.

Definition at line 522 of file parameters.h.

    {
        *m_ptr = m_default;
    }

Store()

void PARAM_PATH_LIST::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 584 of file parameters.h.

    {
        nlohmann::json js = nlohmann::json::array();

        for( const auto& el : *m_ptr )
            js.push_back( toFileFormat( el ) );

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

References PARAM_BASE::m_path, PARAM_LIST< wxString >::m_ptr, JSON_SETTINGS::Set(), and toFileFormat().

toFileFormat()

wxString PARAM_PATH_LIST::toFileFormat ( const wxString &  aString ) const

inlineprivate

Definition at line 613 of file parameters.h.

    {
        wxString ret = aString;
        ret.Replace( wxT( "\\" ), wxT( "/" ) );
        return ret;
    }

Referenced by Store().

Member Data Documentation

m_default

std::vector<wxString > PARAM_LIST< wxString >::m_default

protectedinherited

Definition at line 553 of file parameters.h.

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(), PARAM_WXSTRING_MAP::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(), MatchesFile(), PARAM_MAP< Value >::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_LIST< wxString >::Store(), Store(), PARAM_MAP< Value >::Store(), and PARAM_WXSTRING_MAP::Store().

m_ptr

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

protectedinherited

Definition at line 551 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(), Load(), PARAM_MAP< Value >::Load(), and PARAM_WXSTRING_MAP::Load().

---

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

• parameters.h