KiCad PCB EDA Suite
PARAM_CFG_DIFFPAIRDIMENSIONS Class Reference
Inheritance diagram for PARAM_CFG_DIFFPAIRDIMENSIONS:
PARAM_CFG

Public Member Functions

 PARAM_CFG_DIFFPAIRDIMENSIONS (std::vector< DIFF_PAIR_DIMENSION > *ptparam, const wxChar *group=nullptr)
 
void ReadParam (wxConfigBase *aConfig) const override
 Function ReadParam reads the value of the parameter stored in aConfig. More...
 
void SaveParam (wxConfigBase *aConfig) const override
 Function SaveParam saves the value of the parameter stored in aConfig. More...
 

Public Attributes

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
 

Protected Attributes

std::vector< DIFF_PAIR_DIMENSION > * m_Pt_param
 Pointer to the parameter value. More...
 

Detailed Description

Definition at line 355 of file board_design_settings.cpp.

Constructor & Destructor Documentation

◆ PARAM_CFG_DIFFPAIRDIMENSIONS()

PARAM_CFG_DIFFPAIRDIMENSIONS::PARAM_CFG_DIFFPAIRDIMENSIONS ( std::vector< DIFF_PAIR_DIMENSION > *  ptparam,
const wxChar *  group = nullptr 
)
inline

Definition at line 361 of file board_design_settings.cpp.

362  :
363  PARAM_CFG( wxEmptyString, PARAM_DIFFPAIRDIMENSIONS, group )
364  {
365  m_Pt_param = ptparam;
366  }
PARAM_CFG(const wxString &ident, const paramcfg_id type, const wxChar *group=NULL, const wxString &legacy_ident=wxEmptyString)
std::vector< DIFF_PAIR_DIMENSION > * m_Pt_param
Pointer to the parameter value.

References m_Pt_param.

Member Function Documentation

◆ ReadParam()

void PARAM_CFG_DIFFPAIRDIMENSIONS::ReadParam ( wxConfigBase *  aConfig) const
inlineoverridevirtual

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 368 of file board_design_settings.cpp.

369  {
370  if( !m_Pt_param || !aConfig )
371  return;
372 
373  m_Pt_param->clear();
374 
375  for( int index = 1; ; ++index )
376  {
377  double width, gap, viagap;
378 
379  wxString key = dPairWidthKey;
380 
381  if( !aConfig->Read( key << index, &width ) )
382  break;
383 
384  key = dPairGapKey;
385  gap = aConfig->ReadDouble( key << index, 0.0 );
386 
387  key = dPairViaGapKey;
388  viagap = aConfig->ReadDouble( key << index, 0.0 );
389 
390  m_Pt_param->emplace_back( DIFF_PAIR_DIMENSION( Millimeter2iu( width ),
391  Millimeter2iu( gap ),
392  Millimeter2iu( viagap ) ) );
393  }
394  }
Struct DIFF_PAIR_DIMENSION is a small helper container to handle a stock of specific differential pai...
#define dPairGapKey
#define dPairWidthKey
#define dPairViaGapKey
std::vector< DIFF_PAIR_DIMENSION > * m_Pt_param
Pointer to the parameter value.

References dPairGapKey, dPairViaGapKey, dPairWidthKey, and m_Pt_param.

◆ SaveParam()

void PARAM_CFG_DIFFPAIRDIMENSIONS::SaveParam ( wxConfigBase *  aConfig) const
inlineoverridevirtual

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 396 of file board_design_settings.cpp.

397  {
398  if( !m_Pt_param || !aConfig )
399  return;
400 
401  for( size_t index = 1; index <= m_Pt_param->size(); ++index )
402  {
403  wxString key = dPairWidthKey;
404  aConfig->Write( key << index, Iu2Millimeter( m_Pt_param->at( index - 1 ).m_Width ) );
405  key = dPairGapKey;
406  aConfig->Write( key << index, Iu2Millimeter( m_Pt_param->at( index - 1 ).m_Gap ) );
407  key = dPairViaGapKey;
408  aConfig->Write( key << index, Iu2Millimeter( m_Pt_param->at( index - 1 ).m_ViaGap ) );
409  }
410  }
#define dPairGapKey
#define dPairWidthKey
#define dPairViaGapKey
std::vector< DIFF_PAIR_DIMENSION > * m_Pt_param
Pointer to the parameter value.

References dPairGapKey, dPairViaGapKey, dPairWidthKey, 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::vector<DIFF_PAIR_DIMENSION>* PARAM_CFG_DIFFPAIRDIMENSIONS::m_Pt_param
protected

Pointer to the parameter value.

Definition at line 358 of file board_design_settings.cpp.

Referenced by PARAM_CFG_DIFFPAIRDIMENSIONS(), 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 file: