sim_plot_frame.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) 2017-2022 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Tomasz Wlostowski <[email protected]>
 * @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 __SIM_PLOT_FRAME__
#define __SIM_PLOT_FRAME__
 
 
#include "sim_plot_frame_base.h"
#include "sim_types.h"
 
#include <kiway_player.h>
#include <dialogs/dialog_sim_command.h>
 
#include <wx/event.h>
 
#include <list>
#include <memory>
#include <map>
 
class SCH_EDIT_FRAME;
class SCH_SYMBOL;
 
class SPICE_SIMULATOR;
class SPICE_SIMULATOR_SETTINGS;
class NGSPICE_CIRCUIT_MODEL;
 
#include "sim_plot_panel.h"
#include "sim_panel_base.h"
#include "sim_workbook.h"
 
class SIM_THREAD_REPORTER;
class TUNER_SLIDER;
 
class SIM_PLOT_FRAME : public SIM_PLOT_FRAME_BASE
{
public:
 SIM_PLOT_FRAME( KIWAY* aKiway, wxWindow* aParent );
 ~SIM_PLOT_FRAME();
 
 void StartSimulation( const wxString& aSimCommand = wxEmptyString );
 
 SIM_PANEL_BASE* NewPlotPanel( wxString aSimCommand, int aSimOptions );
 
 void AddVoltagePlot( const wxString& aNetName );
 
 void AddCurrentPlot( const wxString& aDeviceName );
 
 void AddTuner( const SCH_SHEET_PATH& aSheetPath, SCH_SYMBOL* aSymbol );
 
 void RemoveTuner( TUNER_SLIDER* aTuner, bool aErase = true );
 
 void UpdateTunerValue( const SCH_SHEET_PATH& aSheetPath, const KIID& aSymbol,
 const wxString& aRef, const wxString& aValue );
 
 SIM_PLOT_PANEL* GetCurrentPlot() const;
 
 const NGSPICE_CIRCUIT_MODEL* GetExporter() const;
 
 bool GetPlotBgOpt() const { return m_plotUseWhiteBg; }
 
 void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
 
 void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
 
 WINDOW_SETTINGS* GetWindowSettings( APP_SETTINGS_BASE* aCfg ) override;
 
 // Simulator doesn't host a tool framework
 wxWindow* GetToolCanvas() const override { return nullptr; }
 
private:
 void initWorkbook();
 
 void updateTitle();
 
 void setIconsForMenuItems();
 
 void addPlot( const wxString& aName, SIM_PLOT_TYPE aType );
 
 void removePlot( const wxString& aPlotName );
 
 bool updatePlot( const wxString& aName, SIM_PLOT_TYPE aType, SIM_PLOT_PANEL* aPlotPanel );
 
 void updateSignalList();
 
 void applyTuners();
 
 bool loadWorkbook( const wxString& aPath );
 
 bool saveWorkbook( const wxString& aPath );
 
 wxString getDefaultFilename();
 
 wxString getDefaultPath();
 
 SIM_PANEL_BASE* getCurrentPlotWindow() const
 {
 return dynamic_cast<SIM_PANEL_BASE*>( m_workbook->GetCurrentPage() );
 }
 
 wxString getCurrentSimCommand() const
 {
 if( getCurrentPlotWindow() == nullptr )
 return m_circuitModel->GetSheetSimCommand();
 else
 return m_workbook->GetSimCommand( getCurrentPlotWindow() );
 }
 
 int getCurrentOptions() const
 {
 if( getCurrentPlotWindow() == nullptr )
 return m_circuitModel->GetSimOptions();
 else
 return m_workbook->GetSimOptions( getCurrentPlotWindow() );
 }
 
 SIM_PLOT_TYPE getXAxisType( SIM_TYPE aType ) const;
 
 // Menu handlers
 void menuNewPlot( wxCommandEvent& aEvent ) override;
 void menuOpenWorkbook( wxCommandEvent& event ) override;
 void menuSaveWorkbook( wxCommandEvent& event ) override;
 void menuSaveWorkbookAs( wxCommandEvent& event ) override;
 void menuExit( wxCommandEvent& event ) override;
 void menuSaveImage( wxCommandEvent& event ) override;
 void menuSaveCsv( wxCommandEvent& event ) override;
 void menuZoomIn( wxCommandEvent& event ) override;
 void menuZoomOut( wxCommandEvent& event ) override;
 void menuZoomFit( wxCommandEvent& event ) override;
 void menuShowGrid( wxCommandEvent& event ) override;
 void menuShowGridUpdate( wxUpdateUIEvent& event ) override;
 void menuShowLegend( wxCommandEvent& event ) override;
 void menuShowLegendUpdate( wxUpdateUIEvent& event ) override;
 void menuShowDotted( wxCommandEvent& event ) override;
 void menuShowDottedUpdate( wxUpdateUIEvent& event ) override;
 void menuWhiteBackground( wxCommandEvent& event ) override;
 void menuShowWhiteBackgroundUpdate( wxUpdateUIEvent& event ) override
 {
 event.Check( m_plotUseWhiteBg );
 }
 
 void menuSimulateUpdate( wxUpdateUIEvent& event ) override;
 void menuAddSignalsUpdate( wxUpdateUIEvent& event ) override;
 void menuProbeUpdate( wxUpdateUIEvent& event ) override;
 void menuTuneUpdate( wxUpdateUIEvent& event ) override;
 
 // Event handlers
 void onPlotClose( wxAuiNotebookEvent& event ) override;
 void onPlotClosed( wxAuiNotebookEvent& event ) override;
 void onPlotChanged( wxAuiNotebookEvent& event ) override;
 void onPlotDragged( wxAuiNotebookEvent& event ) override;
 
 void onSignalDblClick( wxMouseEvent& event ) override;
 void onSignalRClick( wxListEvent& aEvent ) override;
 
 void onCursorRClick( wxListEvent& aEvent ) override;
 
 void onWorkbookModified( wxCommandEvent& event );
 void onWorkbookClrModified( wxCommandEvent& event );
 
 void onSimulate( wxCommandEvent& event );
 void onSettings( wxCommandEvent& event );
 void onAddSignal( wxCommandEvent& event );
 void onProbe( wxCommandEvent& event );
 void onTune( wxCommandEvent& event );
 void onShowNetlist( wxCommandEvent& event );
 
 bool canCloseWindow( wxCloseEvent& aEvent ) override;
 void doCloseWindow() override;
 
 void onCursorUpdate( wxCommandEvent& aEvent );
 void onSimUpdate( wxCommandEvent& aEvent );
 void onSimReport( wxCommandEvent& aEvent );
 void onSimStarted( wxCommandEvent& aEvent );
 void onSimFinished( wxCommandEvent& aEvent );
 
 // adjust the sash dimension of splitter windows after reading
 // the config settings
 // must be called after the config settings are read, and once the
 // frame is initialized (end of the Ctor)
 void setSubWindowsSashSize();
 
 // Toolbar buttons
 wxToolBarToolBase* m_toolSimulate;
 wxToolBarToolBase* m_toolAddSignals;
 wxToolBarToolBase* m_toolProbe;
 wxToolBarToolBase* m_toolTune;
 wxToolBarToolBase* m_toolSettings;
 
 SCH_EDIT_FRAME* m_schematicFrame;
 std::shared_ptr<NGSPICE_CIRCUIT_MODEL> m_circuitModel;
 std::shared_ptr<SPICE_SIMULATOR> m_simulator;
 SIM_THREAD_REPORTER* m_reporter;
 
 std::list<TUNER_SLIDER*> m_tuners;
 
 enum CONTEXT_MENU_EVENTS
 {
 REMOVE_SIGNAL = 944,
 SHOW_CURSOR,
 HIDE_CURSOR
 };
 
 // Right click context menu for signals in the listbox
 class SIGNAL_CONTEXT_MENU : public wxMenu
 {
 public:
 SIGNAL_CONTEXT_MENU( const wxString& aSignal, SIM_PLOT_FRAME* aPlotFrame );
 
 private:
 void onMenuEvent( wxMenuEvent& aEvent );
 
 const wxString& m_signal;
 SIM_PLOT_FRAME* m_plotFrame;
 };
 
 // Right click context menu for cursors in the listbox
 class CURSOR_CONTEXT_MENU : public wxMenu
 {
 public:
 CURSOR_CONTEXT_MENU( const wxString& aSignal, SIM_PLOT_FRAME* aPlotFrame );
 
 private:
 void onMenuEvent( wxMenuEvent& aEvent );
 
 const wxString& m_signal;
 SIM_PLOT_FRAME* m_plotFrame;
 };
 
 SIM_PANEL_BASE* m_lastSimPlot;
 
 wxImageList* m_signalsIconColorList;
 
 // Variables for temporary storage:
 int m_splitterLeftRightSashPosition;
 int m_splitterPlotAndConsoleSashPosition;
 int m_splitterSignalsSashPosition;
 int m_splitterTuneValuesSashPosition;
 bool m_plotUseWhiteBg;
 unsigned int m_plotNumber;
 bool m_simFinished;
};
 
// Commands
wxDECLARE_EVENT( EVT_SIM_UPDATE, wxCommandEvent );
wxDECLARE_EVENT( EVT_SIM_REPORT, wxCommandEvent );
 
// Notifications
wxDECLARE_EVENT( EVT_SIM_STARTED, wxCommandEvent );
wxDECLARE_EVENT( EVT_SIM_FINISHED, wxCommandEvent );
 
#endif // __sim_plot_frame__