KiCad PCB EDA Suite
PARAM_LIST< Type > Class Template Reference

#include <parameters.h>

Inheritance diagram for PARAM_LIST< Type >:
PARAM_BASE

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

418  :
419  PARAM_BASE( aJsonPath, aReadOnly ),
420  m_ptr( aPtr ),
421  m_default( aDefault )
422  { }
std::vector< Type > * m_ptr
Definition: parameters.h:443
PARAM_BASE(std::string aJsonPath, bool aReadOnly)
Definition: parameters.h:35
std::vector< Type > m_default
Definition: parameters.h:445

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

425  :
426  PARAM_BASE( aJsonPath, aReadOnly ),
427  m_ptr( aPtr ),
428  m_default( aDefault )
429  { }
std::vector< Type > * m_ptr
Definition: parameters.h:443
PARAM_BASE(std::string aJsonPath, bool aReadOnly)
Definition: parameters.h:35
std::vector< Type > m_default
Definition: parameters.h:445

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

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

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

81 {
82  if( m_readOnly )
83  return;
84 
85  if( OPT<nlohmann::json> js = aSettings->GetJson( m_path ) )
86  {
87  std::vector<ValueType> val;
88 
89  if( js->is_array() )
90  {
91  for( const auto& el : js->items() )
92  val.push_back( el.value().get<ValueType>() );
93  }
94 
95  *m_ptr = val;
96  }
97  else if( aResetIfMissing )
98  *m_ptr = m_default;
99 }
std::string m_path
the string used to store the param in json files
Definition: parameters.h:74
OPT< nlohmann::json > GetJson(const std::string &aPath) const
Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1....
std::vector< Type > * m_ptr
Definition: parameters.h:443
bool m_readOnly
! True if the parameter pointer should never be overwritten
Definition: parameters.h:77
boost::optional< T > OPT
Definition: optional.h:7
std::vector< Type > m_default
Definition: parameters.h:445

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

116 {
117  if( OPT<nlohmann::json> js = aSettings->GetJson( m_path ) )
118  {
119  if( js->is_array() )
120  {
121  std::vector<ValueType> val;
122 
123  for( const auto& el : js->items() )
124  val.emplace_back( el.value().get<ValueType>() );
125 
126  return val == *m_ptr;
127  }
128  }
129 
130  return false;
131 }
std::string m_path
the string used to store the param in json files
Definition: parameters.h:74
OPT< nlohmann::json > GetJson(const std::string &aPath) const
Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1....
std::vector< Type > * m_ptr
Definition: parameters.h:443
boost::optional< T > OPT
Definition: optional.h:7

◆ SetDefault()

template<typename Type>
void PARAM_LIST< Type >::SetDefault ( )
inlineoverridevirtual

Implements PARAM_BASE.

Definition at line 435 of file parameters.h.

436  {
437  *m_ptr = m_default;
438  }
std::vector< Type > * m_ptr
Definition: parameters.h:443
std::vector< Type > m_default
Definition: parameters.h:445

◆ 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
aSettingsis the JSON_SETTINGS object to store into.

Implements PARAM_BASE.

Definition at line 103 of file parameters.cpp.

104 {
105  nlohmann::json js = nlohmann::json::array();
106 
107  for( const auto& el : *m_ptr )
108  js.push_back( el );
109 
110  aSettings->Set<nlohmann::json>( m_path, js );
111 }
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...
std::string m_path
the string used to store the param in json files
Definition: parameters.h:74
nlohmann::json json
Definition: gerbview.cpp:41
std::vector< Type > * m_ptr
Definition: parameters.h:443

Member Data Documentation

◆ m_default

template<typename Type>
std::vector<Type> PARAM_LIST< Type >::m_default
protected

Definition at line 445 of file parameters.h.

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

◆ m_path

◆ m_ptr

template<typename Type>
std::vector<Type>* PARAM_LIST< Type >::m_ptr
protected

Definition at line 443 of file parameters.h.

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

◆ m_readOnly

bool PARAM_BASE::m_readOnly
protectedinherited

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