#include <panel_regulator.h>

Inheritance diagram for PANEL_REGULATOR:

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	LoadSettings (PCB_CALCULATOR_SETTINGS *aCfg) override
	Load the settings into the panel. More...

void	SaveSettings (PCB_CALCULATOR_SETTINGS *aCfg) override
	Save the settings from the panel. More...

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

void	RegulatorPageUpdate ()
	Update the regulator page dialog display. More...

void	SelectLastSelectedRegulator ()
	If m_lastSelectedRegulatorName is empty, just calls RegulatorPageUpdate() More...

void	RegulatorsSolve ()

void	Regulators_WriteConfig (PCB_CALCULATOR_SETTINGS *aCfg)
	Write regulators parameters in configuration. More...

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). More...

bool	ReadDataFile ()

bool	WriteDataFile ()

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

wxRadioButton *	m_rbRegulR1

wxStaticText *	m_labelRegultR1

wxTextCtrl *	m_RegulR1Value

wxStaticText *	m_r1Units

wxRadioButton *	m_rbRegulR2

wxStaticText *	m_labelRegultR2

wxTextCtrl *	m_RegulR2Value

wxStaticText *	m_r2Units

wxRadioButton *	m_rbRegulVout

wxStaticText *	m_labelVout

wxTextCtrl *	m_RegulVoutValue

wxStaticText *	m_unitsVout

wxStaticText *	m_labelVRef

wxTextCtrl *	m_RegulVrefValue

wxStaticText *	m_unitsVref

wxStaticText *	m_RegulIadjTitle

wxTextCtrl *	m_RegulIadjValue

wxStaticText *	m_IadjUnitLabel

wxButton *	m_buttonCalculate

wxStaticText *	m_RegulMessage

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`
	)

Definition at line 37 of file panel_regulator.cpp.

 :
 PANEL_REGULATOR_BASE( parent, id, pos, size, style, name ),
 m_RegulatorListChanged( false )
{
 m_IadjUnitLabel->SetLabel( wxT( "µA" ) );
 m_r1Units->SetLabel( wxT( "kΩ" ) );
 m_r2Units->SetLabel( wxT( "kΩ" ) );
 
 m_bitmapRegul3pins->SetBitmap( KiBitmap( BITMAPS::regul_3pins ) );
 m_bitmapRegul4pins->SetBitmap( KiBitmap( BITMAPS::regul ) );
 
 m_choiceRegulatorSelector->Append( m_RegulatorList.GetRegList() );
 SelectLastSelectedRegulator();
 
 // Needed on wxWidgets 3.0 to ensure sizers are correctly set
 GetSizer()->SetSizeHints( this );
}

References REGULATOR_LIST::GetRegList(), KiBitmap(), PANEL_REGULATOR_BASE::m_bitmapRegul3pins, PANEL_REGULATOR_BASE::m_bitmapRegul4pins, PANEL_REGULATOR_BASE::m_choiceRegulatorSelector, PANEL_REGULATOR_BASE::m_IadjUnitLabel, PANEL_REGULATOR_BASE::m_r1Units, PANEL_REGULATOR_BASE::m_r2Units, m_RegulatorList, regul, regul_3pins, and SelectLastSelectedRegulator().

◆ ~PANEL_REGULATOR()

PANEL_REGULATOR::~PANEL_REGULATOR ( )

Definition at line 56 of file panel_regulator.cpp.

57{

58}

Member Function Documentation

◆ GetDataFilename()

const wxString PANEL_REGULATOR::GetDataFilename ( )

Returns: the full filename of the selected pcb_calculator data file

Definition at line 450 of file panel_regulator.cpp.

{
 if( m_regulators_fileNameCtrl->GetValue().IsEmpty() )
 return wxEmptyString;
 
 wxFileName fn( m_regulators_fileNameCtrl->GetValue() );
 fn.SetExt( DataFileNameExt );
 return fn.GetFullPath();
}

References DataFileNameExt(), and PANEL_REGULATOR_BASE::m_regulators_fileNameCtrl.

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

◆ LoadSettings()

void PANEL_REGULATOR::LoadSettings ( PCB_CALCULATOR_SETTINGS * aCfg )

overridevirtual

Load the settings into the panel.

Parameters

aCfg	is the settings structure to load from

Implements CALCULATOR_PANEL.

Definition at line 423 of file panel_regulator.cpp.

{
 m_RegulR1Value->SetValue( aCfg->m_Regulators.r1 );
 m_RegulR2Value->SetValue( aCfg->m_Regulators.r2 );
 m_RegulVrefValue->SetValue( aCfg->m_Regulators.vref );
 m_RegulVoutValue->SetValue( aCfg->m_Regulators.vout );
 SetDataFilename( aCfg->m_Regulators.data_file );
 m_lastSelectedRegulatorName = aCfg->m_Regulators.selected_regulator;
 m_choiceRegType->SetSelection( aCfg->m_Regulators.type );
 
 wxRadioButton* regprms[3] = { m_rbRegulR1, m_rbRegulR2, m_rbRegulVout };
 
 if( aCfg->m_Regulators.last_param >= 3 )
 aCfg->m_Regulators.last_param = 0;
 
 for( int ii = 0; ii < 3; ii++ )
 regprms[ii]->SetValue( aCfg->m_Regulators.last_param == ii );
 
}

◆ OnAddRegulator()

void PANEL_REGULATOR::OnAddRegulator ( wxCommandEvent & event )

overridevirtual

Reimplemented from PANEL_REGULATOR_BASE.

Definition at line 195 of file panel_regulator.cpp.

{
 DIALOG_REGULATOR_FORM dlg( this, wxEmptyString );
 
 if( dlg.ShowModal() != wxID_OK )
 return;
 
 REGULATOR_DATA* new_item = dlg.BuildRegulatorFromData();
 
 // Add new item, if not existing
 if( m_RegulatorList.GetReg( new_item->m_Name ) == nullptr )
 {
 // Add item in list
 m_RegulatorList.Add( new_item );
 m_RegulatorListChanged = true;
 m_choiceRegulatorSelector->Clear();
 m_choiceRegulatorSelector->Append( m_RegulatorList.GetRegList() );
 m_lastSelectedRegulatorName = new_item->m_Name;
 SelectLastSelectedRegulator();
 }
 else
 {
 wxMessageBox( _( "This regulator is already in list. Aborted" ) );
 delete new_item;
 }
}

References _, REGULATOR_LIST::Add(), DIALOG_REGULATOR_FORM::BuildRegulatorFromData(), REGULATOR_LIST::GetReg(), REGULATOR_LIST::GetRegList(), PANEL_REGULATOR_BASE::m_choiceRegulatorSelector, m_lastSelectedRegulatorName, REGULATOR_DATA::m_Name, m_RegulatorList, m_RegulatorListChanged, and SelectLastSelectedRegulator().

◆ OnDataFileSelection()

void PANEL_REGULATOR::OnDataFileSelection ( wxCommandEvent & event )

overridevirtual

Reimplemented from PANEL_REGULATOR_BASE.

Definition at line 149 of file panel_regulator.cpp.

{
 wxString fullfilename = GetDataFilename();
 
 wxString wildcard;
 wildcard.Printf( _( "PCB Calculator data file" ) + wxT( " (*.%s)|*.%s" ),
 DataFileNameExt, DataFileNameExt );
 
 wxFileDialog dlg( this, _( "Select PCB Calculator Data File" ), wxEmptyString, fullfilename,
 wildcard, wxFD_OPEN );
 
 if( dlg.ShowModal() == wxID_CANCEL )
 return;
 
 fullfilename = dlg.GetPath();
 
 if( fullfilename == GetDataFilename() )
 return;
 
 SetDataFilename( fullfilename );
 
 if( wxFileExists( fullfilename ) && m_RegulatorList.GetCount() > 0 ) // Read file
 {
 if( wxMessageBox( _( "Do you want to load this file and replace current regulator list?" ) )
 != wxID_OK )
 {
 return;
 }
 }
 
 if( ReadDataFile() )
 {
 m_RegulatorListChanged = false;
 m_choiceRegulatorSelector->Clear();
 m_choiceRegulatorSelector->Append( m_RegulatorList.GetRegList() );
 SelectLastSelectedRegulator();
 }
 else
 {
 wxString msg;
 msg.Printf( _( "Unable to read data file '%s'." ), fullfilename );
 wxMessageBox( msg );
 }
}

References _, DataFileNameExt(), REGULATOR_LIST::GetCount(), GetDataFilename(), REGULATOR_LIST::GetRegList(), PANEL_REGULATOR_BASE::m_choiceRegulatorSelector, m_RegulatorList, m_RegulatorListChanged, ReadDataFile(), SelectLastSelectedRegulator(), and SetDataFilename().

◆ OnEditRegulator()

void PANEL_REGULATOR::OnEditRegulator ( wxCommandEvent & event )

overridevirtual

Reimplemented from PANEL_REGULATOR_BASE.

Definition at line 223 of file panel_regulator.cpp.

{
 wxString name = m_choiceRegulatorSelector->GetStringSelection();
 REGULATOR_DATA* item = m_RegulatorList.GetReg( name );
 
 if( item == nullptr )
 return;
 
 DIALOG_REGULATOR_FORM dlg( this, name );
 
 dlg.CopyRegulatorDataToDialog( item );
 
 if( dlg.ShowModal() != wxID_OK )
 return;
 
 REGULATOR_DATA* new_item = dlg.BuildRegulatorFromData();
 m_RegulatorList.Replace( new_item );
 
 m_RegulatorListChanged = true;
 
 SelectLastSelectedRegulator();
}

References DIALOG_REGULATOR_FORM::BuildRegulatorFromData(), DIALOG_REGULATOR_FORM::CopyRegulatorDataToDialog(), REGULATOR_LIST::GetReg(), PANEL_REGULATOR_BASE::m_choiceRegulatorSelector, m_RegulatorList, m_RegulatorListChanged, name, REGULATOR_LIST::Replace(), and SelectLastSelectedRegulator().

◆ OnRegulatorCalcButtonClick()

void PANEL_REGULATOR::OnRegulatorCalcButtonClick ( wxCommandEvent & event )

overridevirtual

Reimplemented from PANEL_REGULATOR_BASE.

Definition at line 69 of file panel_regulator.cpp.

{
 RegulatorsSolve();
}

References RegulatorsSolve().

◆ OnRegulatorResetButtonClick()

void PANEL_REGULATOR::OnRegulatorResetButtonClick ( wxCommandEvent & event )

overridevirtual

Reimplemented from PANEL_REGULATOR_BASE.

Definition at line 75 of file panel_regulator.cpp.

{
 m_RegulR1Value->SetValue( wxT( "10" ) );
 m_RegulR2Value->SetValue( wxT( "10" ) );
 m_RegulVrefValue->SetValue( wxT( "3" ) );
 m_RegulVoutValue->SetValue( wxT( "12" ) );
 m_choiceRegType->SetSelection( 0 );
 m_rbRegulR1->SetValue( true );
 m_rbRegulR2->SetValue( false );
 m_rbRegulVout->SetValue( false );
 RegulatorPageUpdate();
}

References PANEL_REGULATOR_BASE::m_choiceRegType, PANEL_REGULATOR_BASE::m_rbRegulR1, PANEL_REGULATOR_BASE::m_rbRegulR2, PANEL_REGULATOR_BASE::m_rbRegulVout, PANEL_REGULATOR_BASE::m_RegulR1Value, PANEL_REGULATOR_BASE::m_RegulR2Value, PANEL_REGULATOR_BASE::m_RegulVoutValue, PANEL_REGULATOR_BASE::m_RegulVrefValue, and RegulatorPageUpdate().

◆ OnRegulatorSelection()

void PANEL_REGULATOR::OnRegulatorSelection ( wxCommandEvent & event )

overridevirtual

Reimplemented from PANEL_REGULATOR_BASE.

Definition at line 127 of file panel_regulator.cpp.

{
 wxString name = m_choiceRegulatorSelector->GetStringSelection();
 REGULATOR_DATA* item = m_RegulatorList.GetReg( name );
 
 if( item )
 {
 m_lastSelectedRegulatorName = item->m_Name;
 m_choiceRegType->SetSelection( item->m_Type );
 wxString value;
 value.Printf( wxT( "%g" ), item->m_Vref );
 m_RegulVrefValue->SetValue( value );
 value.Printf( wxT( "%g" ), item->m_Iadj );
 m_RegulIadjValue->SetValue( value );
 }
 
 // Call RegulatorPageUpdate to enable/disable tools,
 // even if no item selected
 RegulatorPageUpdate();
}

References REGULATOR_LIST::GetReg(), PANEL_REGULATOR_BASE::m_choiceRegType, PANEL_REGULATOR_BASE::m_choiceRegulatorSelector, REGULATOR_DATA::m_Iadj, m_lastSelectedRegulatorName, REGULATOR_DATA::m_Name, m_RegulatorList, PANEL_REGULATOR_BASE::m_RegulIadjValue, PANEL_REGULATOR_BASE::m_RegulVrefValue, REGULATOR_DATA::m_Type, REGULATOR_DATA::m_Vref, name, and RegulatorPageUpdate().

Referenced by SelectLastSelectedRegulator().

◆ OnRegulTypeSelection()

void PANEL_REGULATOR::OnRegulTypeSelection ( wxCommandEvent & event )

overridevirtual

Reimplemented from PANEL_REGULATOR_BASE.

Definition at line 121 of file panel_regulator.cpp.

{
 RegulatorPageUpdate();
}

References RegulatorPageUpdate().

◆ OnRemoveRegulator()

void PANEL_REGULATOR::OnRemoveRegulator ( wxCommandEvent & event )

overridevirtual

Reimplemented from PANEL_REGULATOR_BASE.

Definition at line 247 of file panel_regulator.cpp.

{
 wxString name = wxGetSingleChoice( _( "Remove Regulator" ), wxEmptyString,
 m_RegulatorList.GetRegList() );
 if( name.IsEmpty() )
 return;
 
 m_RegulatorList.Remove( name );
 m_RegulatorListChanged = true;
 m_choiceRegulatorSelector->Clear();
 m_choiceRegulatorSelector->Append( m_RegulatorList.GetRegList() );
 
 if( m_lastSelectedRegulatorName == name )
 m_lastSelectedRegulatorName.Empty();
 
 SelectLastSelectedRegulator();
}

References _, REGULATOR_LIST::GetRegList(), PANEL_REGULATOR_BASE::m_choiceRegulatorSelector, m_lastSelectedRegulatorName, m_RegulatorList, m_RegulatorListChanged, name, REGULATOR_LIST::Remove(), and SelectLastSelectedRegulator().

◆ ReadDataFile()

bool PANEL_REGULATOR::ReadDataFile ( )

Definition at line 49 of file datafile_read_write.cpp.

{
 FILE* file = wxFopen( GetDataFilename(), wxT( "rt" ) );
 
 if( file == nullptr )
 return false;
 
 // Switch the locale to standard C (needed to read/write floating point numbers)
 LOCALE_IO toggle;
 
 PCB_CALCULATOR_DATAFILE* datafile = new PCB_CALCULATOR_DATAFILE( &m_RegulatorList );
 
 // dataReader dtor will close file
 FILE_LINE_READER dataReader( file, GetDataFilename() );
 PCB_CALCULATOR_DATAFILE_PARSER datafile_parser( &dataReader );
 
 try
 {
 datafile_parser.Parse( datafile );
 }
 catch( const IO_ERROR& ioe )
 {
 delete datafile;
 
 wxString msg = ioe.What();
 
 msg += wxChar('\n');
 msg += _("Data file error.");
 
 wxMessageBox( msg );
 return false;
 }
 
 m_choiceRegulatorSelector->Clear();
 m_choiceRegulatorSelector->Append( m_RegulatorList.GetRegList() );
 SelectLastSelectedRegulator();
 
 delete datafile;
 
 return true;
}

References _, GetDataFilename(), REGULATOR_LIST::GetRegList(), PANEL_REGULATOR_BASE::m_choiceRegulatorSelector, m_RegulatorList, PCB_CALCULATOR_DATAFILE_PARSER::Parse(), SelectLastSelectedRegulator(), and IO_ERROR::What().

Referenced by OnDataFileSelection().

◆ RegulatorPageUpdate()

void PANEL_REGULATOR::RegulatorPageUpdate ( )

Update the regulator page dialog display.

Enable the current regulator drawings and the formula used for calculations.

Definition at line 89 of file panel_regulator.cpp.

{
 switch( m_choiceRegType->GetSelection() )
 {
 default:
 case 0:
 m_bitmapRegul4pins->Show( true );
 m_bitmapRegul3pins->Show( false );
 m_RegulIadjValue->Enable( false );
 m_RegulFormula->SetLabel( wxT( "Vout = Vref * (R1 + R2) / R2" ) );
 break;
 
 case 1:
 m_bitmapRegul4pins->Show( false );
 m_bitmapRegul3pins->Show( true );
 m_RegulIadjValue->Enable( true );
 m_RegulFormula->SetLabel( wxT( "Vout = Vref * (R1 + R2) / R1 + Iadj * R2" ) );
 break;
 }
 
 // The new icon size must be taken in account
 GetSizer()->Layout();
 
 // Enable/disable buttons:
 bool enbl = m_choiceRegulatorSelector->GetCount() > 0;
 m_buttonEditItem->Enable( enbl );
 m_buttonRemoveItem->Enable( enbl );
 
 Refresh();
}

References PANEL_REGULATOR_BASE::m_bitmapRegul3pins, PANEL_REGULATOR_BASE::m_bitmapRegul4pins, PANEL_REGULATOR_BASE::m_buttonEditItem, PANEL_REGULATOR_BASE::m_buttonRemoveItem, PANEL_REGULATOR_BASE::m_choiceRegType, PANEL_REGULATOR_BASE::m_choiceRegulatorSelector, PANEL_REGULATOR_BASE::m_RegulFormula, PANEL_REGULATOR_BASE::m_RegulIadjValue, and Refresh().

Referenced by OnRegulatorResetButtonClick(), OnRegulatorSelection(), and OnRegulTypeSelection().

◆ Regulators_WriteConfig()

void PANEL_REGULATOR::Regulators_WriteConfig ( PCB_CALCULATOR_SETTINGS * aCfg )

Write regulators parameters in configuration.

Parameters

aCfg	is the configuration settings.

Definition at line 398 of file panel_regulator.cpp.

{
 // Save current parameter values in config.
 aCfg->m_Regulators.r1 = m_RegulR1Value->GetValue();
 aCfg->m_Regulators.r2 = m_RegulR2Value->GetValue();
 aCfg->m_Regulators.vref = m_RegulVrefValue->GetValue();
 aCfg->m_Regulators.vout = m_RegulVoutValue->GetValue();
 aCfg->m_Regulators.data_file = GetDataFilename();
 aCfg->m_Regulators.selected_regulator = m_lastSelectedRegulatorName;
 aCfg->m_Regulators.type = m_choiceRegType->GetSelection();
 
 // Store the parameter selection that was recently calculated (R1, R2 or Vout)
 wxRadioButton* regprms[3] = { m_rbRegulR1, m_rbRegulR2, m_rbRegulVout };
 
 for( int ii = 0; ii < 3; ii++ )
 {
 if( regprms[ii]->GetValue() )
 {
 aCfg->m_Regulators.last_param = ii;
 break;
 }
 }
}

◆ RegulatorsSolve()

void PANEL_REGULATOR::RegulatorsSolve ( )

Definition at line 289 of file panel_regulator.cpp.

{
 int id;
 
 if( m_rbRegulR1->GetValue() )
 {
 id = 0; // for R1 calculation
 }
 else if( m_rbRegulR2->GetValue() )
 {
 id = 1; // for R2 calculation
 }
 else if( m_rbRegulVout->GetValue() )
 {
 id = 2; // for Vout calculation
 }
 else
 {
 wxMessageBox( wxT("Selection error" ) );
 return;
 }
 
 double r1, r2, vref, vout;
 
 wxString txt;
 
 m_RegulMessage->SetLabel( wxEmptyString);
 
 // Convert r1 and r2 in ohms
 int r1scale = 1000;
 int r2scale = 1000;
 
 // Read values from panel:
 txt = m_RegulR1Value->GetValue();
 r1 = DoubleFromString( txt ) * r1scale;
 txt = m_RegulR2Value->GetValue();
 r2 = DoubleFromString( txt ) * r2scale;
 txt = m_RegulVrefValue->GetValue();
 vref = DoubleFromString( txt );
 txt = m_RegulVoutValue->GetValue();
 vout = DoubleFromString( txt );
 
 // Some tests:
 if( vout < vref && id != 2 )
 {
 m_RegulMessage->SetLabel( _( "Vout must be greater than vref" ) );
 return;
 }
 
 if( vref == 0.0 )
 {
 m_RegulMessage->SetLabel( _( "Vref set to 0 !" ) );
 return;
 }
 
 if( ( r1 < 0 && id != 0 ) || ( r2 <= 0 && id != 1 ) )
 {
 m_RegulMessage->SetLabel( _( "Incorrect value for R1 R2" ) );
 return;
 }
 
 // Calculate
 if( m_choiceRegType->GetSelection() == 1)
 {
  // 3 terminal regulator
 txt = m_RegulIadjValue->GetValue();
 double iadj = DoubleFromString( txt );
 
 // iadj is given in micro amp, so convert it in amp.
 iadj /= 1000000;
 
 switch( id )
 {
 case 0:
 r1 = vref * r2 / ( vout - vref - ( r2 * iadj ) );
 break;
 
 case 1:
 r2 = ( vout - vref ) / ( iadj + ( vref / r1 ) );
 break;
 
 case 2:
 vout = vref * ( r1 + r2 ) / r1;
 vout += r2 * iadj;
 break;
 }
 }
 else
 { // Standard 4 terminal regulator
 switch( id )
 {
 case 0: r1 = ( vout / vref - 1 ) * r2; break;
 case 1: r2 = r1 / ( vout / vref - 1 ); break;
 case 2: vout = vref * ( r1 + r2 ) / r2; break;
 }
 }
 
 // write values to panel:
 txt.Printf( wxT( "%g" ), r1 / r1scale );
 m_RegulR1Value->SetValue( txt );
 txt.Printf( wxT( "%g" ), r2 / r2scale );
 m_RegulR2Value->SetValue( txt );
 txt.Printf( wxT( "%g" ), vref );
 m_RegulVrefValue->SetValue( txt );
 txt.Printf( wxT( "%g" ), vout );
 m_RegulVoutValue->SetValue( txt );
}

References _, DoubleFromString(), PANEL_REGULATOR_BASE::m_choiceRegType, PANEL_REGULATOR_BASE::m_rbRegulR1, PANEL_REGULATOR_BASE::m_rbRegulR2, PANEL_REGULATOR_BASE::m_rbRegulVout, PANEL_REGULATOR_BASE::m_RegulIadjValue, PANEL_REGULATOR_BASE::m_RegulMessage, PANEL_REGULATOR_BASE::m_RegulR1Value, PANEL_REGULATOR_BASE::m_RegulR2Value, PANEL_REGULATOR_BASE::m_RegulVoutValue, and PANEL_REGULATOR_BASE::m_RegulVrefValue.

Referenced by OnRegulatorCalcButtonClick().

◆ SaveSettings()

void PANEL_REGULATOR::SaveSettings ( PCB_CALCULATOR_SETTINGS * aCfg )

overridevirtual

Save the settings from the panel.

Parameters

aCfg	is the settings structure to save to

Implements CALCULATOR_PANEL.

Definition at line 444 of file panel_regulator.cpp.

{
 // TODO: This was empty for some reason, should we actually save settings here?
}

◆ SelectLastSelectedRegulator()

void PANEL_REGULATOR::SelectLastSelectedRegulator ( )

If m_lastSelectedRegulatorName is empty, just calls RegulatorPageUpdate()

Definition at line 266 of file panel_regulator.cpp.

{
 // Find last selected in regulator list:
 int idx = -1;
 
 if( !m_lastSelectedRegulatorName.IsEmpty() )
 {
 for( unsigned ii = 0; ii < m_RegulatorList.GetCount(); ii++ )
 {
 if( m_RegulatorList.m_List[ii]->m_Name == m_lastSelectedRegulatorName )
 {
 idx = ii;
 break;
 }
 }
 }
 
 m_choiceRegulatorSelector->SetSelection( idx );
 wxCommandEvent event;
 OnRegulatorSelection( event );
}

References REGULATOR_LIST::GetCount(), PANEL_REGULATOR_BASE::m_choiceRegulatorSelector, m_lastSelectedRegulatorName, REGULATOR_LIST::m_List, m_RegulatorList, and OnRegulatorSelection().

Referenced by OnAddRegulator(), OnDataFileSelection(), OnEditRegulator(), OnRemoveRegulator(), PANEL_REGULATOR(), and ReadDataFile().

◆ 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

aFilename is the full filename, with or without extension.

Definition at line 461 of file panel_regulator.cpp.

{
 if( aFilename.IsEmpty() )
 {
 m_regulators_fileNameCtrl->SetValue( wxEmptyString );
 }
 else
 {
 wxFileName fn( aFilename );
 fn.SetExt( DataFileNameExt );
 m_regulators_fileNameCtrl->SetValue( fn.GetFullPath() );
 }
}

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 61 of file panel_regulator.cpp.

{
 // Update the bitmaps
 m_bitmapRegul3pins->SetBitmap( KiBitmap( BITMAPS::regul_3pins ) );
 m_bitmapRegul4pins->SetBitmap( KiBitmap( BITMAPS::regul ) );
}

References KiBitmap(), PANEL_REGULATOR_BASE::m_bitmapRegul3pins, PANEL_REGULATOR_BASE::m_bitmapRegul4pins, regul, and regul_3pins.

◆ WriteDataFile()

bool PANEL_REGULATOR::WriteDataFile ( )

Definition at line 92 of file datafile_read_write.cpp.

{
 // Switch the locale to standard C (needed to read/write floating point numbers)
 LOCALE_IO toggle;
 
 auto datafile = std::make_unique<PCB_CALCULATOR_DATAFILE>( &m_RegulatorList );
 
 try
 {
 FILE_OUTPUTFORMATTER formatter( GetDataFilename() );
 
 int nestlevel = datafile->WriteHeader( &formatter );
 
 datafile->Format( &formatter, nestlevel );
 
 while( nestlevel-- )
 formatter.Print( nestlevel, ")\n" );
 }
 catch( const IO_ERROR& )
 {
 return false;
 }
 
 m_RegulatorListChanged = false;
 return true;
}

References GetDataFilename(), m_RegulatorList, m_RegulatorListChanged, and OUTPUTFORMATTER::Print().

Referenced by PCB_CALCULATOR_FRAME::OnClosePcbCalc().

Member Data Documentation

◆ m_bitmapRegul3pins

wxStaticBitmap* PANEL_REGULATOR_BASE::m_bitmapRegul3pins

protectedinherited

Definition at line 46 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR(), PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE(), RegulatorPageUpdate(), and ThemeChanged().

◆ m_bitmapRegul4pins

wxStaticBitmap* PANEL_REGULATOR_BASE::m_bitmapRegul4pins

protectedinherited

Definition at line 45 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR(), PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE(), RegulatorPageUpdate(), and ThemeChanged().

◆ m_buttonAddItem

wxButton* PANEL_REGULATOR_BASE::m_buttonAddItem

protectedinherited

Definition at line 53 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE(), and PANEL_REGULATOR_BASE::~PANEL_REGULATOR_BASE().

◆ m_buttonCalculate

wxButton* PANEL_REGULATOR_BASE::m_buttonCalculate

protectedinherited

Definition at line 73 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE(), and PANEL_REGULATOR_BASE::~PANEL_REGULATOR_BASE().

◆ m_buttonDataFile

wxButton* PANEL_REGULATOR_BASE::m_buttonDataFile

protectedinherited

Definition at line 51 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE(), and PANEL_REGULATOR_BASE::~PANEL_REGULATOR_BASE().

◆ m_buttonEditItem

wxButton* PANEL_REGULATOR_BASE::m_buttonEditItem

protectedinherited

Definition at line 52 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE(), RegulatorPageUpdate(), and PANEL_REGULATOR_BASE::~PANEL_REGULATOR_BASE().

◆ m_buttonRegulReset

wxButton* PANEL_REGULATOR_BASE::m_buttonRegulReset

protectedinherited

Definition at line 75 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE(), and PANEL_REGULATOR_BASE::~PANEL_REGULATOR_BASE().

◆ m_buttonRemoveItem

wxButton* PANEL_REGULATOR_BASE::m_buttonRemoveItem

protectedinherited

Definition at line 54 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE(), RegulatorPageUpdate(), and PANEL_REGULATOR_BASE::~PANEL_REGULATOR_BASE().

◆ m_choiceRegType

wxChoice* PANEL_REGULATOR_BASE::m_choiceRegType

protectedinherited

Definition at line 44 of file panel_regulator_base.h.

Referenced by LoadSettings(), OnRegulatorResetButtonClick(), OnRegulatorSelection(), PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE(), RegulatorPageUpdate(), Regulators_WriteConfig(), RegulatorsSolve(), and PANEL_REGULATOR_BASE::~PANEL_REGULATOR_BASE().

◆ m_choiceRegulatorSelector

wxChoice* PANEL_REGULATOR_BASE::m_choiceRegulatorSelector

protectedinherited

Definition at line 48 of file panel_regulator_base.h.

Referenced by OnAddRegulator(), OnDataFileSelection(), OnEditRegulator(), OnRegulatorSelection(), OnRemoveRegulator(), PANEL_REGULATOR(), PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE(), ReadDataFile(), RegulatorPageUpdate(), SelectLastSelectedRegulator(), and PANEL_REGULATOR_BASE::~PANEL_REGULATOR_BASE().

◆ m_IadjUnitLabel

wxStaticText* PANEL_REGULATOR_BASE::m_IadjUnitLabel

protectedinherited

Definition at line 72 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR(), and PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE().

◆ m_labelRegultR1

wxStaticText* PANEL_REGULATOR_BASE::m_labelRegultR1

protectedinherited

Definition at line 56 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 60 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 64 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 67 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE().

◆ m_lastSelectedRegulatorName

wxString PANEL_REGULATOR::m_lastSelectedRegulatorName

Definition at line 91 of file panel_regulator.h.

Referenced by LoadSettings(), OnAddRegulator(), OnRegulatorSelection(), OnRemoveRegulator(), Regulators_WriteConfig(), and SelectLastSelectedRegulator().

◆ m_r1Units

wxStaticText* PANEL_REGULATOR_BASE::m_r1Units

protectedinherited

Definition at line 58 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR(), and PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE().

◆ m_r2Units

wxStaticText* PANEL_REGULATOR_BASE::m_r2Units

protectedinherited

Definition at line 62 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR(), and PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE().

◆ m_rbRegulR1

wxRadioButton* PANEL_REGULATOR_BASE::m_rbRegulR1

protectedinherited

Definition at line 55 of file panel_regulator_base.h.

Referenced by LoadSettings(), OnRegulatorResetButtonClick(), PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE(), Regulators_WriteConfig(), and RegulatorsSolve().

◆ m_rbRegulR2

wxRadioButton* PANEL_REGULATOR_BASE::m_rbRegulR2

protectedinherited

Definition at line 59 of file panel_regulator_base.h.

Referenced by LoadSettings(), OnRegulatorResetButtonClick(), PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE(), Regulators_WriteConfig(), and RegulatorsSolve().

◆ m_rbRegulVout

wxRadioButton* PANEL_REGULATOR_BASE::m_rbRegulVout

protectedinherited

Definition at line 63 of file panel_regulator_base.h.

Referenced by LoadSettings(), OnRegulatorResetButtonClick(), PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE(), Regulators_WriteConfig(), and RegulatorsSolve().

◆ m_RegulatorList

REGULATOR_LIST PANEL_REGULATOR::m_RegulatorList

Definition at line 90 of file panel_regulator.h.

Referenced by OnAddRegulator(), OnDataFileSelection(), OnEditRegulator(), OnRegulatorSelection(), OnRemoveRegulator(), PANEL_REGULATOR(), ReadDataFile(), SelectLastSelectedRegulator(), and WriteDataFile().

◆ m_RegulatorListChanged

bool PANEL_REGULATOR::m_RegulatorListChanged

Definition at line 92 of file panel_regulator.h.

Referenced by OnAddRegulator(), PCB_CALCULATOR_FRAME::OnClosePcbCalc(), OnDataFileSelection(), OnEditRegulator(), OnRemoveRegulator(), and WriteDataFile().

◆ m_regulators_fileNameCtrl

wxTextCtrl* PANEL_REGULATOR_BASE::m_regulators_fileNameCtrl

protectedinherited

Definition at line 50 of file panel_regulator_base.h.

Referenced by GetDataFilename(), PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE(), and SetDataFilename().

◆ m_RegulFormula

wxStaticText* PANEL_REGULATOR_BASE::m_RegulFormula

protectedinherited

Definition at line 47 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE(), and RegulatorPageUpdate().

◆ m_RegulIadjTitle

wxStaticText* PANEL_REGULATOR_BASE::m_RegulIadjTitle

protectedinherited

Definition at line 70 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE().

◆ m_RegulIadjValue

wxTextCtrl* PANEL_REGULATOR_BASE::m_RegulIadjValue

protectedinherited

Definition at line 71 of file panel_regulator_base.h.

Referenced by OnRegulatorSelection(), PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE(), RegulatorPageUpdate(), and RegulatorsSolve().

◆ m_RegulMessage

wxStaticText* PANEL_REGULATOR_BASE::m_RegulMessage

protectedinherited

Definition at line 74 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE(), and RegulatorsSolve().

◆ m_RegulR1Value

wxTextCtrl* PANEL_REGULATOR_BASE::m_RegulR1Value

protectedinherited

Definition at line 57 of file panel_regulator_base.h.

Referenced by LoadSettings(), OnRegulatorResetButtonClick(), PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE(), Regulators_WriteConfig(), and RegulatorsSolve().

◆ m_RegulR2Value

wxTextCtrl* PANEL_REGULATOR_BASE::m_RegulR2Value

protectedinherited

Definition at line 61 of file panel_regulator_base.h.

Referenced by LoadSettings(), OnRegulatorResetButtonClick(), PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE(), Regulators_WriteConfig(), and RegulatorsSolve().

◆ m_RegulVoutValue

wxTextCtrl* PANEL_REGULATOR_BASE::m_RegulVoutValue

protectedinherited

Definition at line 65 of file panel_regulator_base.h.

Referenced by LoadSettings(), OnRegulatorResetButtonClick(), PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE(), Regulators_WriteConfig(), and RegulatorsSolve().

◆ m_RegulVrefValue

wxTextCtrl* PANEL_REGULATOR_BASE::m_RegulVrefValue

protectedinherited

Definition at line 68 of file panel_regulator_base.h.

Referenced by LoadSettings(), OnRegulatorResetButtonClick(), OnRegulatorSelection(), PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE(), Regulators_WriteConfig(), and RegulatorsSolve().

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

wxStaticText* PANEL_REGULATOR_BASE::m_unitsVout

protectedinherited

Definition at line 66 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE().

◆ m_unitsVref

wxStaticText* PANEL_REGULATOR_BASE::m_unitsVref

protectedinherited

Definition at line 69 of file panel_regulator_base.h.

Referenced by PANEL_REGULATOR_BASE::PANEL_REGULATOR_BASE().

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

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PANEL_REGULATOR()

◆ ~PANEL_REGULATOR()

Member Function Documentation

◆ GetDataFilename()

◆ LoadSettings()

◆ OnAddRegulator()

◆ OnDataFileSelection()

◆ OnEditRegulator()

◆ OnRegulatorCalcButtonClick()

◆ OnRegulatorResetButtonClick()

◆ OnRegulatorSelection()

◆ OnRegulTypeSelection()

◆ OnRemoveRegulator()

◆ ReadDataFile()

◆ RegulatorPageUpdate()

◆ Regulators_WriteConfig()

◆ RegulatorsSolve()

◆ SaveSettings()

◆ SelectLastSelectedRegulator()

◆ SetDataFilename()

◆ ThemeChanged()

◆ WriteDataFile()

Member Data Documentation

◆ m_bitmapRegul3pins

◆ m_bitmapRegul4pins

◆ m_buttonAddItem

◆ m_buttonCalculate

◆ m_buttonDataFile

◆ m_buttonEditItem

◆ m_buttonRegulReset

◆ m_buttonRemoveItem

◆ m_choiceRegType

◆ m_choiceRegulatorSelector

◆ m_IadjUnitLabel

◆ m_labelRegultR1

◆ m_labelRegultR2

◆ m_labelVout

◆ m_labelVRef

◆ m_lastSelectedRegulatorName

◆ m_r1Units

◆ m_r2Units

◆ m_rbRegulR1

◆ m_rbRegulR2

◆ m_rbRegulVout

◆ m_RegulatorList

◆ m_RegulatorListChanged

◆ m_regulators_fileNameCtrl

◆ m_RegulFormula

◆ m_RegulIadjTitle

◆ m_RegulIadjValue

◆ m_RegulMessage

◆ m_RegulR1Value

◆ m_RegulR2Value

◆ m_RegulVoutValue

◆ m_RegulVrefValue

◆ m_staticTextRegFile

◆ m_staticTextRegType

◆ m_unitsVout

◆ m_unitsVref