dialog_sim_command.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2016-2022 CERN
 * Copyright (C) 2021-2022 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Maciej Suminski <[email protected]>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * https://www.gnu.org/licenses/gpl-3.0.html
 * or you may search the http://www.gnu.org website for the version 3 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
#ifndef DIALOG_SIM_COMMAND_H
#define DIALOG_SIM_COMMAND_H
 
#include "dialog_sim_command_base.h"
#include <netlist_exporter_spice.h>
#include <sim/spice_value.h>
 
#include <wx/valnum.h>
 
class NGSPICE_CIRCUIT_MODEL;
class SPICE_SIMULATOR_SETTINGS;
 
 
class DIALOG_SIM_COMMAND : public DIALOG_SIM_COMMAND_BASE
{
public:
 DIALOG_SIM_COMMAND( wxWindow* aParent, std::shared_ptr<NGSPICE_CIRCUIT_MODEL> aCircuitModel,
 std::shared_ptr<SPICE_SIMULATOR_SETTINGS>& aSettings );
 
 const wxString& GetSimCommand() const
 {
 return m_simCommand;
 }
 
 bool SetSimCommand( const wxString& aCommand )
 {
 bool res = parseCommand( aCommand );
 
 if( res )
 m_simCommand = aCommand;
 
 return res;
 }
 
 int GetSimOptions() const
 {
 int options = NETLIST_EXPORTER_SPICE::OPTION_DEFAULT_FLAGS;
 
 if( !m_fixIncludePaths->GetValue() )
 options &= ~NETLIST_EXPORTER_SPICE::OPTION_ADJUST_INCLUDE_PATHS;
 
 if( !m_saveAllVoltages->GetValue() )
 options &= ~NETLIST_EXPORTER_SPICE::OPTION_SAVE_ALL_VOLTAGES;
 
 if( !m_saveAllCurrents->GetValue() )
 options &= ~NETLIST_EXPORTER_SPICE::OPTION_SAVE_ALL_CURRENTS;
 
 if( !m_saveAllDissipations->GetValue() )
 options &= ~NETLIST_EXPORTER_SPICE::OPTION_SAVE_ALL_DISSIPATIONS;
 
 return options;
 }
 
 void SetSimOptions( int aOptions )
 {
 m_fixIncludePaths->SetValue( aOptions & NETLIST_EXPORTER_SPICE::OPTION_ADJUST_INCLUDE_PATHS );
 m_saveAllVoltages->SetValue( aOptions & NETLIST_EXPORTER_SPICE::OPTION_SAVE_ALL_VOLTAGES );
 m_saveAllCurrents->SetValue( aOptions & NETLIST_EXPORTER_SPICE::OPTION_SAVE_ALL_CURRENTS );
 m_saveAllDissipations->SetValue( aOptions & NETLIST_EXPORTER_SPICE::OPTION_SAVE_ALL_DISSIPATIONS );
 }
 
 bool TransferDataFromWindow() override;
 bool TransferDataToWindow() override;
 
 // The default dialog Validate() calls the validators of all widgets.
 // This is not what we want; We want only validators of the selected page
 // of the notebooks. So disable the wxDialog::Validate(), and let our
 // TransferDataFromWindow doing the job.
 virtual bool Validate() override
 {
 return true;
 }
 
 int ShowModal() override;
 
private:
 enum SCALE_TYPE
 {
 DECADE,
 OCTAVE,
 LINEAR
 };
 
 void refreshUIControls()
 {
 wxQueueEvent( m_dcEnable2, new wxCommandEvent( wxEVT_CHECKBOX ) );
 wxQueueEvent( m_dcSourceType1, new wxCommandEvent( wxEVT_RADIOBOX ) );
 wxQueueEvent( m_dcSourceType2, new wxCommandEvent( wxEVT_RADIOBOX ) );
 }
 
 wxString evaluateDCControls( wxChoice* aDcSource, wxTextCtrl* aDcStart, wxTextCtrl* aDcStop,
 wxTextCtrl* aDcIncr );
 
 void updateDCSources( wxChar aType, wxChoice* aSource );
 
 void updateDCUnits( wxChar aType, wxChoice* aSource, wxStaticText* aStartValUnit,
 wxStaticText* aEndValUnit, wxStaticText* aStepUnit );
 
 virtual void onInitDlg( wxInitDialogEvent& event ) override
 {
 // Call the default wxDialog handler of a wxInitDialogEvent
 TransferDataToWindow();
 
 // Now all widgets have the size fixed, call FinishDialogSettings
 finishDialogSettings();
 }
 
 bool parseCommand( const wxString& aCommand );
 
 void onLoadDirectives( wxCommandEvent& event ) override
 {
 loadDirectives();
 }
 
 void onDCEnableSecondSource( wxCommandEvent& event ) override;
 void onSwapDCSources( wxCommandEvent& event ) override;
 void onDCSource1Selected( wxCommandEvent& event ) override
 {
 wxChar type =
  m_dcSourceType1->GetString( m_dcSourceType1->GetSelection() ).Upper().GetChar( 0 );
 updateDCSources( type, m_dcSource1 );
 updateDCUnits( type, m_dcSource1, m_src1DCStartValUnit, m_src1DCEndValUnit,
 m_src1DCStepUnit );
 }
 
 void onDCSource2Selected( wxCommandEvent& event ) override
 {
 wxChar type =
 m_dcSourceType2->GetString( m_dcSourceType2->GetSelection() ).Upper().GetChar( 0 );
 updateDCSources( type, m_dcSource2 );
 updateDCUnits( type, m_dcSource2, m_src2DCStartValUnit, m_src2DCEndValUnit,
 m_src2DCStepUnit );
 }
 
 static wxString scaleToString( int aOption )
 {
 switch( aOption )
 {
 case DECADE: return wxString( "dec" );
 case OCTAVE: return wxString( "oct" );
 case LINEAR: return wxString( "lin" );
 default: wxFAIL_MSG( "Unhandled scale type" ); return wxEmptyString;
 }
 }
 
 void loadDirectives();
 
private:
 wxString m_simCommand;
 std::shared_ptr<NGSPICE_CIRCUIT_MODEL> m_circuitModel;
 std::shared_ptr<SPICE_SIMULATOR_SETTINGS> m_settings;
 SPICE_VALIDATOR m_spiceValidator;
 SPICE_VALIDATOR m_spiceEmptyValidator;
 wxIntegerValidator<int> m_posIntValidator;
};
 
#endif /* DIALOG_SIM_COMMAND_H */