KiCad PCB EDA Suite
PARAM_CFG_WXSTRING_SET Class Reference

Configuration parameter - std::set<wxString> More...

#include <config_params.h>

Inheritance diagram for PARAM_CFG_WXSTRING_SET:
PARAM_CFG

Public Member Functions

 PARAM_CFG_WXSTRING_SET (const wxString &ident, std::set< wxString > *ptparam, const wxChar *group=NULL)
 
 PARAM_CFG_WXSTRING_SET (bool Insetup, const wxString &ident, std::set< wxString > *ptparam, const wxChar *group=NULL)
 
virtual void ReadParam (wxConfigBase *aConfig) const override
 Function ReadParam reads the value of the parameter stored in aConfig. More...
 
virtual void SaveParam (wxConfigBase *aConfig) const override
 Function SaveParam saves the value of the parameter stored in aConfig. More...
 

Public Attributes

std::set< wxString > * m_Pt_param
 Pointer to the parameter value. More...
 
wxString m_Ident
 Keyword in config data. More...
 
paramcfg_id m_Type
 Type of parameter. More...
 
wxString m_Group
 Group name (this is like a path in the config data) More...
 
bool m_Setup
 Install or Project based parameter, true == install. More...
 
wxString m_Ident_legacy
 

Detailed Description

Configuration parameter - std::set<wxString>

Definition at line 285 of file config_params.h.

Constructor & Destructor Documentation

◆ PARAM_CFG_WXSTRING_SET() [1/2]

PARAM_CFG_WXSTRING_SET::PARAM_CFG_WXSTRING_SET ( const wxString &  ident,
std::set< wxString > *  ptparam,
const wxChar *  group = NULL 
)

Definition at line 448 of file config_params.cpp.

449  :
450  PARAM_CFG( ident, PARAM_WXSTRING_SET, group )
451 {
452  m_Pt_param = ptparam;
453 }
std::set< wxString > * m_Pt_param
Pointer to the parameter value.
PARAM_CFG(const wxString &ident, const paramcfg_id type, const wxChar *group=NULL, const wxString &legacy_ident=wxEmptyString)

References m_Pt_param.

◆ PARAM_CFG_WXSTRING_SET() [2/2]

PARAM_CFG_WXSTRING_SET::PARAM_CFG_WXSTRING_SET ( bool  Insetup,
const wxString &  ident,
std::set< wxString > *  ptparam,
const wxChar *  group = NULL 
)

Definition at line 456 of file config_params.cpp.

457  :
458  PARAM_CFG( ident, PARAM_WXSTRING, group )
459 {
460  m_Pt_param = ptparam;
461  m_Setup = Insetup;
462 }
bool m_Setup
Install or Project based parameter, true == install.
std::set< wxString > * m_Pt_param
Pointer to the parameter value.
PARAM_CFG(const wxString &ident, const paramcfg_id type, const wxChar *group=NULL, const wxString &legacy_ident=wxEmptyString)

References m_Pt_param, and PARAM_CFG::m_Setup.

Member Function Documentation

◆ ReadParam()

void PARAM_CFG_WXSTRING_SET::ReadParam ( wxConfigBase *  aConfig) const
overridevirtual

Function ReadParam reads the value of the parameter stored in aConfig.

Parameters
aConfig= the wxConfigBase that holds the parameter

Reimplemented from PARAM_CFG.

Definition at line 465 of file config_params.cpp.

466 {
467  if( !m_Pt_param || !aConfig )
468  return;
469 
470  for( int i = 1; true; ++i )
471  {
472  wxString key, data;
473 
474  key = m_Ident;
475  key << i;
476  data = aConfig->Read( key, wxT( "" ) );
477 
478  if( data.IsEmpty() )
479  break;
480 
481  m_Pt_param->insert( data );
482  }
483 }
wxString m_Ident
Keyword in config data.
std::set< wxString > * m_Pt_param
Pointer to the parameter value.

References PARAM_CFG::m_Ident, and m_Pt_param.

◆ SaveParam()

void PARAM_CFG_WXSTRING_SET::SaveParam ( wxConfigBase *  aConfig) const
overridevirtual

Function SaveParam saves the value of the parameter stored in aConfig.

Parameters
aConfig= the wxConfigBase that can store the parameter

Reimplemented from PARAM_CFG.

Definition at line 486 of file config_params.cpp.

487 {
488  if( !m_Pt_param || !aConfig )
489  return;
490 
491  int i = 1;
492 
493  for( const wxString& str : *m_Pt_param )
494  {
495  wxString key, data;
496 
497  key = m_Ident;
498  key << i++;
499 
500  aConfig->Write( key, str );
501  }
502 }
wxString m_Ident
Keyword in config data.
std::set< wxString > * m_Pt_param
Pointer to the parameter value.

References PARAM_CFG::m_Ident, and m_Pt_param.

Member Data Documentation

◆ m_Group

wxString PARAM_CFG::m_Group
inherited

Group name (this is like a path in the config data)

Definition at line 104 of file config_params.h.

Referenced by PARAM_CFG::PARAM_CFG().

◆ m_Ident

◆ m_Ident_legacy

wxString PARAM_CFG::m_Ident_legacy
inherited

◆ m_Pt_param

std::set<wxString>* PARAM_CFG_WXSTRING_SET::m_Pt_param

Pointer to the parameter value.

Definition at line 288 of file config_params.h.

Referenced by PARAM_CFG_WXSTRING_SET(), ReadParam(), and SaveParam().

◆ m_Setup

◆ m_Type

paramcfg_id PARAM_CFG::m_Type
inherited

Type of parameter.

Definition at line 103 of file config_params.h.

Referenced by dumpParamCfg(), PARAM_CFG::PARAM_CFG(), and PARAM_CFG_INT_WITH_SCALE::PARAM_CFG_INT_WITH_SCALE().


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