KiCad PCB EDA Suite
PARAM_PATH Class Reference

Stores a path as a string with directory separators normalized to unix-style. More...

#include <parameters.h>

Inheritance diagram for PARAM_PATH:
PARAM< wxString > PARAM_BASE

Public Member Functions

 PARAM_PATH (const std::string &aJsonPath, wxString *aPtr, const 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...
 
wxString GetDefault () const
 
void SetDefault () override
 
const std::string & GetJsonPath () const
 

Protected Attributes

wxString * m_ptr
 
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
 

Private Attributes

wxString m_min
 
wxString m_max
 
bool m_use_minmax
 

Detailed Description

Stores a path as a string with directory separators normalized to unix-style.

Definition at line 163 of file parameters.h.

Constructor & Destructor Documentation

◆ PARAM_PATH()

PARAM_PATH::PARAM_PATH ( const std::string &  aJsonPath,
wxString *  aPtr,
const wxString &  aDefault,
bool  aReadOnly = false 
)
inline

Definition at line 166 of file parameters.h.

167 :
168 PARAM( aJsonPath, aPtr, aDefault, aReadOnly )
169 { }
PARAM(const std::string &aJsonPath, wxString *aPtr, wxString aDefault, bool aReadOnly=false)
Definition: parameters.h:86

Member Function Documentation

◆ fromFileFormat()

wxString PARAM_PATH::fromFileFormat ( const wxString &  aString) const
inlineprivate

Definition at line 202 of file parameters.h.

203 {
204 wxString ret = aString;
205#ifdef __WINDOWS__
206 ret.Replace( wxT( "/" ), wxT( "\\" ) );
207#endif
208 return ret;
209 }

Referenced by Load(), and MatchesFile().

◆ GetDefault()

wxString PARAM< wxString >::GetDefault ( ) const
inlineinherited

Definition at line 132 of file parameters.h.

133 {
134 return m_default;
135 }
wxString m_default
Definition: parameters.h:157

◆ 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.

69{ return m_path; }
std::string m_path
the string used to store the param in json files
Definition: parameters.h:75

References PARAM_BASE::m_path.

◆ Load()

void PARAM_PATH::Load ( JSON_SETTINGS aSettings,
bool  aResetIfMissing = true 
) const
inlineoverridevirtual

Loads the value of this parameter from JSON to the underlying storage.

Parameters
aSettingsis the JSON_SETTINGS object to load from.
aResetIfMissingif true will set the parameter to its default value if load fails

Implements PARAM_BASE.

Definition at line 171 of file parameters.h.

172 {
173 if( m_readOnly )
174 return;
175
176 PARAM::Load( aSettings, aResetIfMissing );
177
179 }
bool m_readOnly
! True if the parameter pointer should never be overwritten
Definition: parameters.h:78
wxString fromFileFormat(const wxString &aString) const
Definition: parameters.h:202
void Load(JSON_SETTINGS *aSettings, bool aResetIfMissing=true) const override
Loads the value of this parameter from JSON to the underlying storage.
Definition: parameters.h:106
wxString * m_ptr
Definition: parameters.h:156

References fromFileFormat(), PARAM< ValueType >::Load(), PARAM< wxString >::m_ptr, and PARAM_BASE::m_readOnly.

◆ MatchesFile()

bool PARAM_PATH::MatchesFile ( JSON_SETTINGS aSettings) const
inlineoverridevirtual

Checks whether the parameter in memory matches the one in a given JSON file.

Parameters
aSettingsis 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 186 of file parameters.h.

187 {
188 if( std::optional<wxString> optval = aSettings->Get<wxString>( m_path ) )
189 return fromFileFormat( *optval ) == *m_ptr;
190
191 return false;
192 }
std::optional< ValueType > Get(const std::string &aPath) const
Fetches a value from within the JSON document.

References fromFileFormat(), JSON_SETTINGS::Get(), PARAM_BASE::m_path, and PARAM< wxString >::m_ptr.

◆ SetDefault()

void PARAM< wxString >::SetDefault ( )
inlineoverridevirtualinherited

Implements PARAM_BASE.

Definition at line 137 of file parameters.h.

138 {
139 *m_ptr = m_default;
140 }

◆ Store()

void PARAM_PATH::Store ( JSON_SETTINGS aSettings) const
inlineoverridevirtual

Stores the value of this parameter to the given JSON_SETTINGS object.

Parameters
aSettingsis the JSON_SETTINGS object to store into.

Implements PARAM_BASE.

Definition at line 181 of file parameters.h.

182 {
183 aSettings->Set<wxString>( m_path, toFileFormat( *m_ptr ) );
184 }
void Set(const std::string &aPath, ValueType aVal)
Stores a value into the JSON document Will throw an exception if ValueType isn't something that the l...
wxString toFileFormat(const wxString &aString) const
Definition: parameters.h:195

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

◆ toFileFormat()

wxString PARAM_PATH::toFileFormat ( const wxString &  aString) const
inlineprivate

Definition at line 195 of file parameters.h.

196 {
197 wxString ret = aString;
198 ret.Replace( wxT( "\\" ), wxT( "/" ) );
199 return ret;
200 }

Referenced by Store().

Member Data Documentation

◆ m_default

wxString PARAM< wxString >::m_default
protectedinherited

Definition at line 157 of file parameters.h.

◆ m_max

wxString PARAM< wxString >::m_max
privateinherited

Definition at line 152 of file parameters.h.

◆ m_min

wxString PARAM< wxString >::m_min
privateinherited

Definition at line 151 of file parameters.h.

◆ m_path

◆ m_ptr

wxString * PARAM< wxString >::m_ptr
protectedinherited

Definition at line 156 of file parameters.h.

◆ 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(), Load(), PARAM_ENUM< EnumType >::Load(), PARAM_SCALED< ValueType >::Load(), PARAM_PATH_LIST::Load(), and PARAM_WXSTRING_MAP::Load().

◆ m_use_minmax

bool PARAM< wxString >::m_use_minmax
privateinherited

Definition at line 153 of file parameters.h.


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