KiCad PCB EDA Suite
Loading...
Searching...
No Matches
PANEL_REGULATOR Class Reference

#include <panel_regulator.h>

Inheritance diagram for PANEL_REGULATOR:
PANEL_REGULATOR_BASE CALCULATOR_PANEL

Public Member Functions

 PANEL_REGULATOR (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL, const wxString &name=wxEmptyString)
 
 ~PANEL_REGULATOR ()
 
void OnRegulatorCalcButtonClick (wxCommandEvent &event) override
 
void OnRegulatorResetButtonClick (wxCommandEvent &event) override
 
void OnRegulTypeSelection (wxCommandEvent &event) override
 
void OnRegulatorSelection (wxCommandEvent &event) override
 
void OnDataFileSelection (wxCommandEvent &event) override
 
void OnAddRegulator (wxCommandEvent &event) override
 
void OnEditRegulator (wxCommandEvent &event) override
 
void OnRemoveRegulator (wxCommandEvent &event) override
 
void OnCopyCB (wxCommandEvent &event) override
 
void LoadSettings (PCB_CALCULATOR_SETTINGS *aCfg) override
 Load the settings into the panel.
 
void SaveSettings (PCB_CALCULATOR_SETTINGS *aCfg) override
 Save the settings from the panel.
 
void ThemeChanged () override
 Update UI elements of the panel when the theme changes to ensure the images and fonts/colors are appropriate for the new theme.
 
void RegulatorPageUpdate ()
 Update the regulator page dialog display.
 
void SelectLastSelectedRegulator ()
 If m_lastSelectedRegulatorName is empty, just calls RegulatorPageUpdate()
 
void RegulatorsSolve ()
 
const wxString GetDataFilename ()
 
void SetDataFilename (const wxString &aFilename)
 Initialize the full filename of the selected pcb_calculator data file force the standard extension of the file (.pcbcalc).
 
bool ReadDataFile ()
 
bool WriteDataFile ()
 

Static Public Member Functions

static double round_to (double value, double precision=0.001)
 

Public Attributes

REGULATOR_LIST m_RegulatorList
 
wxString m_lastSelectedRegulatorName
 
bool m_RegulatorListChanged
 

Protected Attributes

wxStaticText * m_staticTextRegType
 
wxChoice * m_choiceRegType
 
wxStaticBitmap * m_bitmapRegul4pins
 
wxStaticBitmap * m_bitmapRegul3pins
 
wxStaticText * m_RegulFormula
 
wxChoice * m_choiceRegulatorSelector
 
wxStaticText * m_staticTextRegFile
 
wxTextCtrl * m_regulators_fileNameCtrl
 
wxButton * m_buttonDataFile
 
wxButton * m_buttonEditItem
 
wxButton * m_buttonAddItem
 
wxButton * m_buttonRemoveItem
 
wxStaticText * m_labelValMin
 
wxStaticText * m_labelValTyp
 
wxStaticText * m_labelValMax
 
wxRadioButton * m_rbRegulR1
 
wxStaticText * m_labelRegultR1
 
wxTextCtrl * m_r1MinVal
 
wxTextCtrl * m_r1TypVal
 
wxTextCtrl * m_r1MaxVal
 
wxStaticText * m_labelUnitsR1
 
wxRadioButton * m_rbRegulR2
 
wxStaticText * m_labelRegultR2
 
wxTextCtrl * m_r2MinVal
 
wxTextCtrl * m_r2TypVal
 
wxTextCtrl * m_r2MaxVal
 
wxStaticText * m_labelUnitsR2
 
wxRadioButton * m_rbRegulVout
 
wxStaticText * m_labelVout
 
wxTextCtrl * m_voutMinVal
 
wxTextCtrl * m_voutTypVal
 
wxTextCtrl * m_voutMaxVal
 
wxStaticText * m_labelUnitsVout
 
wxStaticText * m_labelVRef
 
wxTextCtrl * m_vrefMinVal
 
wxTextCtrl * m_vrefTypVal
 
wxTextCtrl * m_vrefMaxVal
 
wxStaticText * m_labelUnitsVref
 
wxStaticText * m_RegulIadjTitle
 
wxTextCtrl * m_iadjTypVal
 
wxTextCtrl * m_iadjMaxVal
 
wxStaticText * m_labelUnitsIadj
 
wxStaticText * m_labelTolSumary
 
wxTextCtrl * m_tolTotalMin
 
wxTextCtrl * m_TolTotalMax
 
wxStaticText * m_labelTotalPercent
 
wxStaticText * m_labelResTol
 
wxTextCtrl * m_resTolVal
 
wxStaticText * m_labelResTolUnit
 
wxStaticText * m_labelKicadComment
 
wxTextCtrl * m_textPowerComment
 
wxButton * m_btCopyCB
 
wxStaticText * m_RegulMessage
 
wxButton * m_buttonCalculate
 
wxButton * m_buttonRegulReset
 

Detailed Description

Definition at line 27 of file panel_regulator.h.

Constructor & Destructor Documentation

◆ PANEL_REGULATOR()

PANEL_REGULATOR::PANEL_REGULATOR ( wxWindow *  parent,
wxWindowID  id = wxID_ANY,
const wxPoint &  pos = wxDefaultPosition,
const wxSize &  size = wxDefaultSize,
long  style = wxTAB_TRAVERSAL,
const wxString &  name = wxEmptyString 
)

◆ ~PANEL_REGULATOR()

PANEL_REGULATOR::~PANEL_REGULATOR ( )

Definition at line 53 of file panel_regulator.cpp.

Member Function Documentation

◆ GetDataFilename()

const wxString PANEL_REGULATOR::GetDataFilename ( )
Returns
the full filename of the selected pcb_calculator data file

Definition at line 606 of file panel_regulator.cpp.

References DataFileNameExt, and PANEL_REGULATOR_BASE::m_regulators_fileNameCtrl.

Referenced by PCB_CALCULATOR_FRAME::OnClosePcbCalc(), OnDataFileSelection(), ReadDataFile(), SaveSettings(), and WriteDataFile().

◆ LoadSettings()

◆ OnAddRegulator()

◆ OnCopyCB()

void PANEL_REGULATOR::OnCopyCB ( wxCommandEvent &  event)
overridevirtual

Reimplemented from PANEL_REGULATOR_BASE.

Definition at line 329 of file panel_regulator.cpp.

References PANEL_REGULATOR_BASE::m_textPowerComment.

◆ OnDataFileSelection()

◆ OnEditRegulator()

◆ OnRegulatorCalcButtonClick()

void PANEL_REGULATOR::OnRegulatorCalcButtonClick ( wxCommandEvent &  event)
overridevirtual

Reimplemented from PANEL_REGULATOR_BASE.

Definition at line 66 of file panel_regulator.cpp.

References RegulatorsSolve().

◆ OnRegulatorResetButtonClick()

◆ OnRegulatorSelection()

◆ OnRegulTypeSelection()

void PANEL_REGULATOR::OnRegulTypeSelection ( wxCommandEvent &  event)
overridevirtual

Reimplemented from PANEL_REGULATOR_BASE.

Definition at line 148 of file panel_regulator.cpp.

References RegulatorPageUpdate().

◆ OnRemoveRegulator()

void PANEL_REGULATOR::OnRemoveRegulator ( wxCommandEvent &  event)
overridevirtual

◆ ReadDataFile()

◆ RegulatorPageUpdate()

◆ RegulatorsSolve()

◆ round_to()

double PANEL_REGULATOR::round_to ( double  value,
double  precision = 0.001 
)
static

Definition at line 631 of file panel_regulator.cpp.

Referenced by RegulatorsSolve().

◆ SaveSettings()

◆ SelectLastSelectedRegulator()

◆ SetDataFilename()

void PANEL_REGULATOR::SetDataFilename ( const wxString &  aFilename)

Initialize the full filename of the selected pcb_calculator data file force the standard extension of the file (.pcbcalc).

Parameters
aFilenameis the full filename, with or without extension.

Definition at line 617 of file panel_regulator.cpp.

References DataFileNameExt, and PANEL_REGULATOR_BASE::m_regulators_fileNameCtrl.

Referenced by LoadSettings(), and OnDataFileSelection().

◆ ThemeChanged()

void PANEL_REGULATOR::ThemeChanged ( )
overridevirtual

Update UI elements of the panel when the theme changes to ensure the images and fonts/colors are appropriate for the new theme.

Implements CALCULATOR_PANEL.

Definition at line 58 of file panel_regulator.cpp.

References KiBitmapBundle(), PANEL_REGULATOR_BASE::m_bitmapRegul3pins, and PANEL_REGULATOR_BASE::m_bitmapRegul4pins.

◆ WriteDataFile()

bool PANEL_REGULATOR::WriteDataFile ( )

Member Data Documentation

◆ m_bitmapRegul3pins

wxStaticBitmap* PANEL_REGULATOR_BASE::m_bitmapRegul3pins
protectedinherited

◆ m_bitmapRegul4pins

wxStaticBitmap* PANEL_REGULATOR_BASE::m_bitmapRegul4pins
protectedinherited

◆ m_btCopyCB

wxButton* PANEL_REGULATOR_BASE::m_btCopyCB
protectedinherited

◆ m_buttonAddItem

wxButton* PANEL_REGULATOR_BASE::m_buttonAddItem
protectedinherited

◆ m_buttonCalculate

wxButton* PANEL_REGULATOR_BASE::m_buttonCalculate
protectedinherited

◆ m_buttonDataFile

wxButton* PANEL_REGULATOR_BASE::m_buttonDataFile
protectedinherited

◆ m_buttonEditItem

wxButton* PANEL_REGULATOR_BASE::m_buttonEditItem
protectedinherited

◆ m_buttonRegulReset

wxButton* PANEL_REGULATOR_BASE::m_buttonRegulReset
protectedinherited

◆ m_buttonRemoveItem

wxButton* PANEL_REGULATOR_BASE::m_buttonRemoveItem
protectedinherited

◆ m_choiceRegType

◆ m_choiceRegulatorSelector

◆ m_iadjMaxVal

wxTextCtrl* PANEL_REGULATOR_BASE::m_iadjMaxVal
protectedinherited

◆ m_iadjTypVal

wxTextCtrl* PANEL_REGULATOR_BASE::m_iadjTypVal
protectedinherited

◆ m_labelKicadComment

wxStaticText* PANEL_REGULATOR_BASE::m_labelKicadComment
protectedinherited

Definition at line 92 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE().

◆ m_labelRegultR1

wxStaticText* PANEL_REGULATOR_BASE::m_labelRegultR1
protectedinherited

Definition at line 59 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE().

◆ m_labelRegultR2

wxStaticText* PANEL_REGULATOR_BASE::m_labelRegultR2
protectedinherited

Definition at line 65 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE().

◆ m_labelResTol

wxStaticText* PANEL_REGULATOR_BASE::m_labelResTol
protectedinherited

Definition at line 89 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE().

◆ m_labelResTolUnit

wxStaticText* PANEL_REGULATOR_BASE::m_labelResTolUnit
protectedinherited

Definition at line 91 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE().

◆ m_labelTolSumary

wxStaticText* PANEL_REGULATOR_BASE::m_labelTolSumary
protectedinherited

Definition at line 85 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE().

◆ m_labelTotalPercent

wxStaticText* PANEL_REGULATOR_BASE::m_labelTotalPercent
protectedinherited

Definition at line 88 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE().

◆ m_labelUnitsIadj

wxStaticText* PANEL_REGULATOR_BASE::m_labelUnitsIadj
protectedinherited

◆ m_labelUnitsR1

wxStaticText* PANEL_REGULATOR_BASE::m_labelUnitsR1
protectedinherited

Definition at line 63 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE().

◆ m_labelUnitsR2

wxStaticText* PANEL_REGULATOR_BASE::m_labelUnitsR2
protectedinherited

Definition at line 69 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE().

◆ m_labelUnitsVout

wxStaticText* PANEL_REGULATOR_BASE::m_labelUnitsVout
protectedinherited

Definition at line 75 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE().

◆ m_labelUnitsVref

wxStaticText* PANEL_REGULATOR_BASE::m_labelUnitsVref
protectedinherited

Definition at line 80 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE().

◆ m_labelValMax

wxStaticText* PANEL_REGULATOR_BASE::m_labelValMax
protectedinherited

Definition at line 57 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE().

◆ m_labelValMin

wxStaticText* PANEL_REGULATOR_BASE::m_labelValMin
protectedinherited

Definition at line 55 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE().

◆ m_labelValTyp

wxStaticText* PANEL_REGULATOR_BASE::m_labelValTyp
protectedinherited

Definition at line 56 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE().

◆ m_labelVout

wxStaticText* PANEL_REGULATOR_BASE::m_labelVout
protectedinherited

Definition at line 71 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE().

◆ m_labelVRef

wxStaticText* PANEL_REGULATOR_BASE::m_labelVRef
protectedinherited

Definition at line 76 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE().

◆ m_lastSelectedRegulatorName

wxString PANEL_REGULATOR::m_lastSelectedRegulatorName

◆ m_r1MaxVal

wxTextCtrl* PANEL_REGULATOR_BASE::m_r1MaxVal
protectedinherited

◆ m_r1MinVal

wxTextCtrl* PANEL_REGULATOR_BASE::m_r1MinVal
protectedinherited

◆ m_r1TypVal

wxTextCtrl* PANEL_REGULATOR_BASE::m_r1TypVal
protectedinherited

◆ m_r2MaxVal

wxTextCtrl* PANEL_REGULATOR_BASE::m_r2MaxVal
protectedinherited

◆ m_r2MinVal

wxTextCtrl* PANEL_REGULATOR_BASE::m_r2MinVal
protectedinherited

◆ m_r2TypVal

wxTextCtrl* PANEL_REGULATOR_BASE::m_r2TypVal
protectedinherited

◆ m_rbRegulR1

wxRadioButton* PANEL_REGULATOR_BASE::m_rbRegulR1
protectedinherited

◆ m_rbRegulR2

wxRadioButton* PANEL_REGULATOR_BASE::m_rbRegulR2
protectedinherited

◆ m_rbRegulVout

wxRadioButton* PANEL_REGULATOR_BASE::m_rbRegulVout
protectedinherited

◆ m_RegulatorList

◆ m_RegulatorListChanged

bool PANEL_REGULATOR::m_RegulatorListChanged

◆ m_regulators_fileNameCtrl

wxTextCtrl* PANEL_REGULATOR_BASE::m_regulators_fileNameCtrl
protectedinherited

◆ m_RegulFormula

wxStaticText* PANEL_REGULATOR_BASE::m_RegulFormula
protectedinherited

◆ m_RegulIadjTitle

wxStaticText* PANEL_REGULATOR_BASE::m_RegulIadjTitle
protectedinherited

◆ m_RegulMessage

wxStaticText* PANEL_REGULATOR_BASE::m_RegulMessage
protectedinherited

◆ m_resTolVal

wxTextCtrl* PANEL_REGULATOR_BASE::m_resTolVal
protectedinherited

◆ m_staticTextRegFile

wxStaticText* PANEL_REGULATOR_BASE::m_staticTextRegFile
protectedinherited

Definition at line 49 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE().

◆ m_staticTextRegType

wxStaticText* PANEL_REGULATOR_BASE::m_staticTextRegType
protectedinherited

Definition at line 43 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE().

◆ m_textPowerComment

wxTextCtrl* PANEL_REGULATOR_BASE::m_textPowerComment
protectedinherited

◆ m_TolTotalMax

wxTextCtrl* PANEL_REGULATOR_BASE::m_TolTotalMax
protectedinherited

◆ m_tolTotalMin

wxTextCtrl* PANEL_REGULATOR_BASE::m_tolTotalMin
protectedinherited

◆ m_voutMaxVal

wxTextCtrl* PANEL_REGULATOR_BASE::m_voutMaxVal
protectedinherited

◆ m_voutMinVal

wxTextCtrl* PANEL_REGULATOR_BASE::m_voutMinVal
protectedinherited

◆ m_voutTypVal

wxTextCtrl* PANEL_REGULATOR_BASE::m_voutTypVal
protectedinherited

◆ m_vrefMaxVal

wxTextCtrl* PANEL_REGULATOR_BASE::m_vrefMaxVal
protectedinherited

◆ m_vrefMinVal

wxTextCtrl* PANEL_REGULATOR_BASE::m_vrefMinVal
protectedinherited

◆ m_vrefTypVal

wxTextCtrl* PANEL_REGULATOR_BASE::m_vrefTypVal
protectedinherited

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