395 lines
12 KiB
C++
395 lines
12 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2016-2023 CERN
|
|
* Copyright (C) 2017-2023 KiCad Developers, see AUTHORS.txt for contributors.
|
|
*
|
|
* @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
|
|
* @author Maciej Suminski <maciej.suminski@cern.ch>
|
|
*
|
|
* 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/sim_plot_frame_base.h>
|
|
#include <sim/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/sim_plot_panel.h>
|
|
#include <sim/sim_panel_base.h>
|
|
#include <sim/sim_notebook.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();
|
|
|
|
/**
|
|
* Check and load the current netlist into the simulator.
|
|
* @return true if document is fully annotated and netlist was loaded successfully.
|
|
*/
|
|
bool LoadSimulator();
|
|
|
|
void StartSimulation();
|
|
|
|
/**
|
|
* Create a new plot panel for a given simulation type and adds it to the main notebook.
|
|
*
|
|
* @param aSimCommand is requested simulation command.
|
|
* @param aSimOptions netlisting options
|
|
* @return The new plot panel.
|
|
*/
|
|
SIM_PANEL_BASE* NewPlotPanel( const wxString& aSimCommand, int aSimOptions );
|
|
|
|
/**
|
|
* Shows a dialog for editing the current tab's simulation command, or creating a new tab
|
|
* with a different simulation command type.
|
|
*/
|
|
bool EditSimCommand();
|
|
|
|
/**
|
|
* Add a voltage plot for a given net name.
|
|
*
|
|
* @param aNetName is the net name for which a voltage plot should be created.
|
|
*/
|
|
void AddVoltagePlot( const wxString& aNetName );
|
|
|
|
/**
|
|
* Add a current plot for a particular device.
|
|
*
|
|
* @param aDeviceName is the device name (e.g. R1, C1).
|
|
* @param aParam is the current type (e.g. I, Ic, Id).
|
|
*/
|
|
void AddCurrentPlot( const wxString& aDeviceName );
|
|
|
|
/**
|
|
* Get/Set the number of significant digits and the range for formatting a cursor value.
|
|
* @param aValueCol 0 indicates the X value column; 1 the Y value.
|
|
*/
|
|
SPICE_VALUE_FORMAT GetCursorFormat( int aCursorId, int aValueCol ) const
|
|
{
|
|
return m_cursorFormats[ aCursorId ][ aValueCol ];
|
|
}
|
|
|
|
void SetCursorFormat( int aCursorId, int aValueCol, const SPICE_VALUE_FORMAT& aFormat )
|
|
{
|
|
m_cursorFormats[ aCursorId ][ aValueCol ] = aFormat;
|
|
|
|
wxCommandEvent dummy;
|
|
onCursorUpdate( dummy );
|
|
}
|
|
|
|
SPICE_VALUE_FORMAT GetMeasureFormat( int aRow ) const
|
|
{
|
|
return m_measurementFormats[ aRow ];
|
|
}
|
|
|
|
void SetMeasureFormat( int aRow, const SPICE_VALUE_FORMAT& aFormat )
|
|
{
|
|
m_measurementFormats[ aRow ] = aFormat;
|
|
updateMeasurement( aRow );
|
|
}
|
|
|
|
/**
|
|
* Add a tuner for a symbol.
|
|
*/
|
|
void AddTuner( const SCH_SHEET_PATH& aSheetPath, SCH_SYMBOL* aSymbol );
|
|
|
|
/**
|
|
* Remove an existing tuner.
|
|
*
|
|
* @param aTuner is the tuner to be removed.
|
|
* @param aErase decides whether the tuner should be also removed from the tuners list.
|
|
* Otherwise it is removed only from the SIM_PLOT_FRAME pane.
|
|
*/
|
|
void RemoveTuner( TUNER_SLIDER* aTuner, bool aErase = true );
|
|
|
|
/**
|
|
* Safely update a field of the associated symbol without dereferencing
|
|
* the symbol.
|
|
*
|
|
* @param aSymbol id of the symbol needing updating
|
|
* @param aId id of the symbol field
|
|
* @param aValue new value of the symbol field
|
|
*/
|
|
void UpdateTunerValue( const SCH_SHEET_PATH& aSheetPath, const KIID& aSymbol,
|
|
const wxString& aRef, const wxString& aValue );
|
|
|
|
/**
|
|
* Add a measurement to the measurements grid.
|
|
* @param aCmd AVG, MIN, MAX, PP, RMS, MIN_AT, or MAX_AT
|
|
* @param aSignal
|
|
*/
|
|
void AddMeasurement( const wxString& aCmd, const wxString& aSignal );
|
|
|
|
/**
|
|
* Delete a row from the measurements grid.
|
|
*/
|
|
void DeleteMeasurement( int aRow );
|
|
|
|
/**
|
|
* Return the currently opened plot panel (or NULL if there is none).
|
|
*/
|
|
SIM_PLOT_PANEL* GetCurrentPlot() const;
|
|
|
|
/**
|
|
* Return the netlist exporter object used for simulations.
|
|
*/
|
|
const NGSPICE_CIRCUIT_MODEL* GetExporter() const;
|
|
|
|
/**
|
|
* Toggle dark-mode of the plot.
|
|
*/
|
|
void ToggleDarkModePlots();
|
|
|
|
void ShowChangedLanguage() override;
|
|
|
|
void ReCreateHToolbar();
|
|
|
|
/**
|
|
* Load plot settings from a file.
|
|
*
|
|
* @param aPath is the file name.
|
|
* @return True if successful.
|
|
*/
|
|
bool LoadWorkbook( const wxString& aPath );
|
|
|
|
/**
|
|
* Save plot settings to a file.
|
|
*
|
|
* @param aPath is the file name.
|
|
* @return True if successful.
|
|
*/
|
|
bool SaveWorkbook( const wxString& aPath );
|
|
|
|
void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
|
|
|
|
void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
|
|
|
|
WINDOW_SETTINGS* GetWindowSettings( APP_SETTINGS_BASE* aCfg ) override;
|
|
|
|
SCH_EDIT_FRAME* GetSchematicFrame() const { return m_schematicFrame; }
|
|
|
|
std::shared_ptr<NGSPICE_CIRCUIT_MODEL> GetCircuitModel() const { return m_circuitModel; }
|
|
|
|
std::shared_ptr<SPICE_SIMULATOR> GetSimulator() const { return m_simulator; }
|
|
|
|
wxString GetCurrentSimCommand() const
|
|
{
|
|
if( getCurrentPlotWindow() )
|
|
return getCurrentPlotWindow()->GetSimCommand();
|
|
else
|
|
return m_circuitModel->GetSchTextSimCommand();
|
|
}
|
|
|
|
int GetCurrentOptions() const
|
|
{
|
|
if( getCurrentPlotWindow() )
|
|
return getCurrentPlotWindow()->GetSimOptions();
|
|
else
|
|
return m_circuitModel->GetSimOptions();
|
|
}
|
|
|
|
// Simulator doesn't host a tool framework
|
|
wxWindow* GetToolCanvas() const override { return nullptr; }
|
|
|
|
private:
|
|
void setupTools();
|
|
void doReCreateMenuBar() override;
|
|
|
|
void setupUIConditions() override;
|
|
|
|
/**
|
|
* Load the currently active workbook stored in the project settings. If there is none,
|
|
* generate a filename for the currently active workbook and store it in the project settings.
|
|
*/
|
|
void initWorkbook();
|
|
|
|
/**
|
|
* Set the main window title bar text.
|
|
*/
|
|
void updateTitle();
|
|
|
|
/**
|
|
* Add a new plot to the current panel.
|
|
*
|
|
* @param aName is the device/net name.
|
|
* @param aType describes the type of plot.
|
|
* @param aParam is the parameter for the device/net (e.g. I, Id, V).
|
|
*/
|
|
void addTrace( const wxString& aName, SIM_TRACE_TYPE aType );
|
|
|
|
/**
|
|
* Remove a plot with a specific title.
|
|
*
|
|
* @param aSignalName is the full plot title (e.g. I(Net-C1-Pad1)).
|
|
*/
|
|
void removeTrace( const wxString& aSignalName );
|
|
|
|
/**
|
|
* Update a trace in a particular SIM_PLOT_PANEL. If the panel does not contain the given
|
|
* trace, then add it.
|
|
*
|
|
* @param aName is the device/net name.
|
|
* @param aTraceType describes the type of plot.
|
|
* @param aParam is the parameter for the device/net (e.g. I, Id, V).
|
|
* @param aPlotPanel is the panel that should receive the update.
|
|
*/
|
|
void updateTrace( const wxString& aName, SIM_TRACE_TYPE aTraceType, SIM_PLOT_PANEL* aPlotPanel );
|
|
|
|
/**
|
|
* Rebuild the list of signals available from the netlist.
|
|
*
|
|
* Note: this is not the filtered list. See rebuildSignalsGrid() for that.
|
|
*/
|
|
void rebuildSignalsList();
|
|
|
|
/**
|
|
* Rebuild the filtered list of signals in the signals grid.
|
|
*/
|
|
void rebuildSignalsGrid( wxString aFilter );
|
|
|
|
/**
|
|
* Update the values in the signals grid.
|
|
*/
|
|
void updateSignalsGrid();
|
|
|
|
/**
|
|
* Update the cursor values (in the grid) and graphics (in the plot window).
|
|
*/
|
|
void updateCursors();
|
|
|
|
/**
|
|
* Update a measurement in the measurements grid.
|
|
*/
|
|
void updateMeasurement( int aRow );
|
|
|
|
/**
|
|
* Apply component values specified using tuner sliders to the current netlist.
|
|
*/
|
|
void applyTuners();
|
|
|
|
/**
|
|
* Return the currently opened plot panel (or NULL if there is none).
|
|
*/
|
|
SIM_PANEL_BASE* getCurrentPlotWindow() const
|
|
{
|
|
return dynamic_cast<SIM_PANEL_BASE*>( m_plotNotebook->GetCurrentPage() );
|
|
}
|
|
|
|
/**
|
|
*
|
|
*/
|
|
/**
|
|
* Return X axis for a given simulation type.
|
|
*/
|
|
SIM_TRACE_TYPE getXAxisType( SIM_TYPE aType ) const;
|
|
|
|
// Event handlers
|
|
void onPlotClose( wxAuiNotebookEvent& event ) override;
|
|
void onPlotClosed( wxAuiNotebookEvent& event ) override;
|
|
void onPlotChanged( wxAuiNotebookEvent& event ) override;
|
|
void onPlotDragged( wxAuiNotebookEvent& event ) override;
|
|
|
|
void OnFilterText( wxCommandEvent& aEvent ) override;
|
|
void OnFilterMouseMoved( wxMouseEvent& aEvent ) override;
|
|
|
|
void onSignalsGridCellChanged( wxGridEvent& aEvent ) override;
|
|
void onCursorsGridCellChanged( wxGridEvent& aEvent ) override;
|
|
void onMeasurementsGridCellChanged( wxGridEvent& aEvent ) override;
|
|
|
|
void onNotebookModified( 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 );
|
|
|
|
void onExit( wxCommandEvent& event );
|
|
|
|
// 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();
|
|
|
|
private:
|
|
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::vector<wxString> m_signals;
|
|
std::list<TUNER_SLIDER*> m_tuners;
|
|
|
|
///< Panel that was used as the most recent one for simulations
|
|
SIM_PANEL_BASE* m_lastSimPlot;
|
|
|
|
SPICE_VALUE_FORMAT m_cursorFormats[3][2];
|
|
std::vector<SPICE_VALUE_FORMAT> m_measurementFormats;
|
|
|
|
// Variables for temporary storage:
|
|
int m_splitterLeftRightSashPosition;
|
|
int m_splitterPlotAndConsoleSashPosition;
|
|
int m_splitterSignalsSashPosition;
|
|
int m_splitterCursorsSashPosition;
|
|
int m_splitterTuneValuesSashPosition;
|
|
bool m_darkMode;
|
|
unsigned int m_plotNumber;
|
|
bool m_simFinished;
|
|
unsigned int m_outputCounter;
|
|
bool m_workbookModified;
|
|
};
|
|
|
|
// 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__
|