/* * This program source code file is part of KiCad, a free EDA CAD application. * * Copyright (C) 2016-2023 CERN * Copyright (C) 2016-2023 KiCad Developers, see AUTHORS.txt for contributors. * @author Tomasz Wlostowski * @author Maciej Suminski * * 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 */ #include // For some obscure reason, needed on msys2 with some wxWidgets versions (3.0) to avoid // undefined symbol at link stage (due to use of #include ) // Should not create issues on other platforms #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "ngspice.h" #include "sim_plot_frame.h" #include "sim_plot_panel.h" #include "spice_simulator.h" #include "spice_reporter.h" #include "core/kicad_algo.h" #include "fmt/format.h" #include #include #include SIM_TRACE_TYPE operator|( SIM_TRACE_TYPE aFirst, SIM_TRACE_TYPE aSecond ) { int res = (int) aFirst | (int) aSecond; return (SIM_TRACE_TYPE) res; } class SIM_THREAD_REPORTER : public SPICE_REPORTER { public: SIM_THREAD_REPORTER( SIM_PLOT_FRAME* aParent ) : m_parent( aParent ) { } REPORTER& Report( const wxString& aText, SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED ) override { wxCommandEvent* event = new wxCommandEvent( EVT_SIM_REPORT ); event->SetString( aText ); wxQueueEvent( m_parent, event ); return *this; } bool HasMessage() const override { return false; // Technically "indeterminate" rather than false. } void OnSimStateChange( SPICE_SIMULATOR* aObject, SIM_STATE aNewState ) override { wxCommandEvent* event = nullptr; switch( aNewState ) { case SIM_IDLE: event = new wxCommandEvent( EVT_SIM_FINISHED ); break; case SIM_RUNNING: event = new wxCommandEvent( EVT_SIM_STARTED ); break; default: wxFAIL; return; } wxQueueEvent( m_parent, event ); } private: SIM_PLOT_FRAME* m_parent; }; enum SIGNALS_GRID_COLUMNS { COL_SIGNAL_NAME = 0, COL_SIGNAL_SHOW, COL_SIGNAL_COLOR, COL_CURSOR_1, COL_CURSOR_2 }; enum CURSORS_GRID_COLUMNS { COL_CURSOR_NAME = 0, COL_CURSOR_SIGNAL, COL_CURSOR_X, COL_CURSOR_Y }; enum MEASUREMENTS_GIRD_COLUMNS { COL_MEASUREMENT = 0, COL_MEASUREMENT_VALUE, COL_MEASUREMENT_FORMAT }; enum { MYID_MEASURE_MIN = GRIDTRICKS_FIRST_CLIENT_ID, MYID_MEASURE_MAX, MYID_MEASURE_AVG, MYID_MEASURE_RMS, MYID_MEASURE_PP, MYID_MEASURE_MIN_AT, MYID_MEASURE_MAX_AT, MYID_MEASURE_INTEGRAL, MYID_FORMAT_VALUE, MYID_DELETE_MEASUREMENT }; class SIGNALS_GRID_TRICKS : public GRID_TRICKS { public: SIGNALS_GRID_TRICKS( SIM_PLOT_FRAME* aParent, WX_GRID* aGrid ) : GRID_TRICKS( aGrid ), m_parent( aParent ), m_menuRow( 0 ), m_menuCol( 0 ) {} protected: void showPopupMenu( wxMenu& menu, wxGridEvent& aEvent ) override; void doPopupSelection( wxCommandEvent& event ) override; protected: SIM_PLOT_FRAME* m_parent; int m_menuRow; int m_menuCol; }; void SIGNALS_GRID_TRICKS::showPopupMenu( wxMenu& menu, wxGridEvent& aEvent ) { m_menuRow = aEvent.GetRow(); m_menuCol = aEvent.GetCol(); if( m_menuCol == COL_SIGNAL_NAME ) { if( !( m_grid->IsInSelection( m_menuRow, m_menuCol ) ) ) m_grid->ClearSelection(); m_grid->SetGridCursor( m_menuRow, m_menuCol ); wxString msg = m_grid->GetCellValue( m_menuRow, m_menuCol ); menu.Append( MYID_MEASURE_MIN, _( "Measure Min" ) ); menu.Append( MYID_MEASURE_MAX, _( "Measure Max" ) ); menu.Append( MYID_MEASURE_AVG, _( "Measure Average" ) ); menu.Append( MYID_MEASURE_RMS, _( "Measure RMS" ) ); menu.Append( MYID_MEASURE_PP, _( "Measure Peak-to-peak" ) ); menu.Append( MYID_MEASURE_MIN_AT, _( "Measure Time of Min" ) ); menu.Append( MYID_MEASURE_MAX_AT, _( "Measure Time of Max" ) ); menu.Append( MYID_MEASURE_INTEGRAL, _( "Measure Integral" ) ); menu.AppendSeparator(); } GRID_TRICKS::showPopupMenu( menu, aEvent ); } void SIGNALS_GRID_TRICKS::doPopupSelection( wxCommandEvent& event ) { std::vector signals; wxGridCellCoordsArray cells1 = m_grid->GetSelectionBlockTopLeft(); wxGridCellCoordsArray cells2 = m_grid->GetSelectionBlockBottomRight(); for( size_t i = 0; i < cells1.Count(); i++ ) { if( cells1[i].GetCol() == COL_SIGNAL_NAME ) { for( int j = cells1[i].GetRow(); j < cells2[i].GetRow() + 1; j++ ) { signals.push_back( m_grid->GetCellValue( j, cells1[i].GetCol() ) ); } } } wxGridCellCoordsArray cells3 = m_grid->GetSelectedCells(); for( size_t i = 0; i < cells3.Count(); i++ ) { if( cells3[i].GetCol() == COL_SIGNAL_NAME ) signals.push_back( m_grid->GetCellValue( cells3[i].GetRow(), cells3[i].GetCol() ) ); } if( signals.size() < 1 ) signals.push_back( m_grid->GetCellValue( m_menuRow, m_menuCol ) ); if( event.GetId() == MYID_MEASURE_MIN ) { for( wxString signal : signals ) m_parent->AddMeasurement( wxString::Format( wxS( "MIN %s" ), signal ) ); } else if( event.GetId() == MYID_MEASURE_MAX ) { for( wxString signal : signals ) m_parent->AddMeasurement( wxString::Format( wxS( "MAX %s" ), signal ) ); } else if( event.GetId() == MYID_MEASURE_AVG ) { for( wxString signal : signals ) m_parent->AddMeasurement( wxString::Format( wxS( "AVG %s" ), signal ) ); } else if( event.GetId() == MYID_MEASURE_RMS ) { for( wxString signal : signals ) m_parent->AddMeasurement( wxString::Format( wxS( "RMS %s" ), signal ) ); } else if( event.GetId() == MYID_MEASURE_PP ) { for( wxString signal : signals ) m_parent->AddMeasurement( wxString::Format( wxS( "PP %s" ), signal ) ); } else if( event.GetId() == MYID_MEASURE_MIN_AT ) { for( wxString signal : signals ) m_parent->AddMeasurement( wxString::Format( wxS( "MIN_AT %s" ), signal ) ); } else if( event.GetId() == MYID_MEASURE_MAX_AT ) { for( wxString signal : signals ) m_parent->AddMeasurement( wxString::Format( wxS( "MAX_AT %s" ), signal ) ); } else if( event.GetId() == MYID_MEASURE_INTEGRAL ) { for( wxString signal : signals ) m_parent->AddMeasurement( wxString::Format( wxS( "INTEG %s" ), signal ) ); } else GRID_TRICKS::doPopupSelection( event ); } class CURSORS_GRID_TRICKS : public GRID_TRICKS { public: CURSORS_GRID_TRICKS( SIM_PLOT_FRAME* aParent, WX_GRID* aGrid ) : GRID_TRICKS( aGrid ), m_parent( aParent ), m_menuRow( 0 ), m_menuCol( 0 ) {} protected: void showPopupMenu( wxMenu& menu, wxGridEvent& aEvent ) override; void doPopupSelection( wxCommandEvent& event ) override; protected: SIM_PLOT_FRAME* m_parent; int m_menuRow; int m_menuCol; }; void CURSORS_GRID_TRICKS::showPopupMenu( wxMenu& menu, wxGridEvent& aEvent ) { m_menuRow = aEvent.GetRow(); m_menuCol = aEvent.GetCol(); if( m_menuCol == COL_CURSOR_X || m_menuCol == COL_CURSOR_Y ) { wxString msg = m_grid->GetColLabelValue( m_menuCol ); menu.Append( MYID_FORMAT_VALUE, wxString::Format( _( "Format %s..." ), msg ) ); menu.AppendSeparator(); } GRID_TRICKS::showPopupMenu( menu, aEvent ); } void CURSORS_GRID_TRICKS::doPopupSelection( wxCommandEvent& event ) { if( event.GetId() == MYID_FORMAT_VALUE ) { int cursorId = m_menuRow; int cursorAxis = m_menuCol - COL_CURSOR_X; SPICE_VALUE_FORMAT format = m_parent->GetCursorFormat( cursorId, cursorAxis ); DIALOG_SIM_FORMAT_VALUE formatDialog( m_parent, &format ); if( formatDialog.ShowModal() == wxID_OK ) m_parent->SetCursorFormat( cursorId, cursorAxis, format ); } else { GRID_TRICKS::doPopupSelection( event ); } } class MEASUREMENTS_GRID_TRICKS : public GRID_TRICKS { public: MEASUREMENTS_GRID_TRICKS( SIM_PLOT_FRAME* aParent, WX_GRID* aGrid ) : GRID_TRICKS( aGrid ), m_parent( aParent ), m_menuRow( 0 ), m_menuCol( 0 ) {} protected: void showPopupMenu( wxMenu& menu, wxGridEvent& aEvent ) override; void doPopupSelection( wxCommandEvent& event ) override; protected: SIM_PLOT_FRAME* m_parent; int m_menuRow; int m_menuCol; }; void MEASUREMENTS_GRID_TRICKS::showPopupMenu( wxMenu& menu, wxGridEvent& aEvent ) { m_menuRow = aEvent.GetRow(); m_menuCol = aEvent.GetCol(); if( !( m_grid->IsInSelection( m_menuRow, m_menuCol ) ) ) m_grid->ClearSelection(); m_grid->SetGridCursor( m_menuRow, m_menuCol ); if( m_menuCol == COL_MEASUREMENT_VALUE ) menu.Append( MYID_FORMAT_VALUE, _( "Format Value..." ) ); if( m_menuRow < ( m_grid->GetNumberRows() - 1 ) ) menu.Append( MYID_DELETE_MEASUREMENT, _( "Delete Measurement" ) ); menu.AppendSeparator(); GRID_TRICKS::showPopupMenu( menu, aEvent ); } void MEASUREMENTS_GRID_TRICKS::doPopupSelection( wxCommandEvent& event ) { if( event.GetId() == MYID_FORMAT_VALUE ) { SPICE_VALUE_FORMAT format = m_parent->GetMeasureFormat( m_menuRow ); DIALOG_SIM_FORMAT_VALUE formatDialog( m_parent, &format ); if( formatDialog.ShowModal() == wxID_OK ) { m_parent->SetMeasureFormat( m_menuRow, format ); m_parent->UpdateMeasurement( m_menuRow ); } } else if( event.GetId() == MYID_DELETE_MEASUREMENT ) { std::vector measurements; wxGridCellCoordsArray cells1 = m_grid->GetSelectionBlockTopLeft(); wxGridCellCoordsArray cells2 = m_grid->GetSelectionBlockBottomRight(); for( size_t i = 0; i < cells1.Count(); i++ ) { if( cells1[i].GetCol() == COL_MEASUREMENT ) { for( int j = cells1[i].GetRow(); j < cells2[i].GetRow() + 1; j++ ) { measurements.push_back( j ); } } } wxGridCellCoordsArray cells3 = m_grid->GetSelectedCells(); for( size_t i = 0; i < cells3.Count(); i++ ) { if( cells3[i].GetCol() == COL_MEASUREMENT ) measurements.push_back( cells3[i].GetRow() ); } if( measurements.size() < 1 ) measurements.push_back( m_menuRow ); // When deleting a row, we'll change the indexes. // To avoid problems, we can start with the highest indexes. sort( measurements.begin(), measurements.end(), std::greater<>() ); for( int row : measurements ) m_parent->DeleteMeasurement( row ); m_grid->ClearSelection(); } else { GRID_TRICKS::doPopupSelection( event ); } } class SUPPRESS_GRID_CELL_EVENTS { public: SUPPRESS_GRID_CELL_EVENTS( SIM_PLOT_FRAME* aFrame ) : m_frame( aFrame ) { m_frame->m_SuppressGridEvents++; } ~SUPPRESS_GRID_CELL_EVENTS() { m_frame->m_SuppressGridEvents--; } private: SIM_PLOT_FRAME* m_frame; }; SIM_PLOT_FRAME::SIM_PLOT_FRAME( KIWAY* aKiway, wxWindow* aParent ) : SIM_PLOT_FRAME_BASE( aParent ), m_SuppressGridEvents( 0 ), m_lastSimPlot( nullptr ), m_darkMode( true ), m_plotNumber( 0 ), m_simFinished( false ), m_workbookModified( false ) { SetKiway( this, aKiway ); m_schematicFrame = (SCH_EDIT_FRAME*) Kiway().Player( FRAME_SCH, false ); wxASSERT( m_schematicFrame ); // Give an icon wxIcon icon; icon.CopyFromBitmap( KiBitmap( BITMAPS::simulator ) ); SetIcon( icon ); m_simulator = SIMULATOR::CreateInstance( "ngspice" ); wxASSERT( m_simulator ); // Get the previous size and position of windows: LoadSettings( config() ); m_filter->SetHint( _( "Filter" ) ); m_signalsGrid->wxGrid::SetLabelFont( KIUI::GetStatusFont( this ) ); m_cursorsGrid->wxGrid::SetLabelFont( KIUI::GetStatusFont( this ) ); m_measurementsGrid->wxGrid::SetLabelFont( KIUI::GetStatusFont( this ) ); m_signalsGrid->PushEventHandler( new SIGNALS_GRID_TRICKS( this, m_signalsGrid ) ); m_cursorsGrid->PushEventHandler( new CURSORS_GRID_TRICKS( this, m_cursorsGrid ) ); m_measurementsGrid->PushEventHandler( new MEASUREMENTS_GRID_TRICKS( this, m_measurementsGrid ) ); wxGridCellAttr* attr = new wxGridCellAttr; attr->SetReadOnly(); m_signalsGrid->SetColAttr( COL_SIGNAL_NAME, attr ); attr = new wxGridCellAttr; attr->SetReadOnly(); m_cursorsGrid->SetColAttr( COL_CURSOR_NAME, attr ); attr = new wxGridCellAttr; attr->SetReadOnly(); m_cursorsGrid->SetColAttr( COL_CURSOR_SIGNAL, attr ); attr = new wxGridCellAttr; attr->SetReadOnly(); m_cursorsGrid->SetColAttr( COL_CURSOR_Y, attr ); for( int cursorId = 0; cursorId < 3; ++cursorId ) { m_cursorFormats[ cursorId ][ 0 ] = { 3, wxS( "~s" ) }; m_cursorFormats[ cursorId ][ 1 ] = { 3, wxS( "~V" ) }; } attr = new wxGridCellAttr; attr->SetReadOnly(); m_measurementsGrid->SetColAttr( COL_MEASUREMENT_VALUE, attr ); // Prepare the color list to plot traces SIM_PLOT_COLORS::FillDefaultColorList( m_darkMode ); m_simulator->Init(); m_reporter = new SIM_THREAD_REPORTER( this ); m_simulator->SetReporter( m_reporter ); m_circuitModel = std::make_shared( &m_schematicFrame->Schematic(), this ); setupTools(); setupUIConditions(); ReCreateHToolbar(); ReCreateMenuBar(); Bind( wxEVT_COMMAND_MENU_SELECTED, wxCommandEventHandler( SIM_PLOT_FRAME::onExit ), this, wxID_EXIT ); Bind( EVT_SIM_UPDATE, &SIM_PLOT_FRAME::onSimUpdate, this ); Bind( EVT_SIM_REPORT, &SIM_PLOT_FRAME::onSimReport, this ); Bind( EVT_SIM_STARTED, &SIM_PLOT_FRAME::onSimStarted, this ); Bind( EVT_SIM_FINISHED, &SIM_PLOT_FRAME::onSimFinished, this ); Bind( EVT_SIM_CURSOR_UPDATE, &SIM_PLOT_FRAME::onCursorUpdate, this ); Bind( EVT_WORKBOOK_MODIFIED, &SIM_PLOT_FRAME::onNotebookModified, this ); #ifndef wxHAS_NATIVE_TABART // Default non-native tab art has ugly gradients we don't want m_plotNotebook->SetArtProvider( new wxAuiSimpleTabArt() ); #endif // Ensure new items are taken in account by sizers: Layout(); // resize the subwindows size. At least on Windows, calling wxSafeYield before // resizing the subwindows forces the wxSplitWindows size events automatically generated // by wxWidgets to be executed before our resize code. // Otherwise, the changes made by setSubWindowsSashSize are overwritten by one these // events wxSafeYield(); setSubWindowsSashSize(); // Ensure the window is on top Raise(); initWorkbook(); updateTitle(); } SIM_PLOT_FRAME::~SIM_PLOT_FRAME() { // Delete the GRID_TRICKS. m_signalsGrid->PopEventHandler( true ); m_cursorsGrid->PopEventHandler( true ); m_measurementsGrid->PopEventHandler( true ); NULL_REPORTER devnull; m_simulator->Attach( nullptr, devnull ); m_simulator->SetReporter( nullptr ); delete m_reporter; } void SIM_PLOT_FRAME::setupTools() { // Create the manager m_toolManager = new TOOL_MANAGER; m_toolManager->SetEnvironment( nullptr, nullptr, nullptr, config(), this ); m_toolDispatcher = new TOOL_DISPATCHER( m_toolManager ); // Attach the events to the tool dispatcher Bind( wxEVT_CHAR, &TOOL_DISPATCHER::DispatchWxEvent, m_toolDispatcher ); Bind( wxEVT_CHAR_HOOK, &TOOL_DISPATCHER::DispatchWxEvent, m_toolDispatcher ); // Register tools m_toolManager->RegisterTool( new COMMON_CONTROL ); m_toolManager->RegisterTool( new SIMULATOR_CONTROL ); m_toolManager->InitTools(); } void SIM_PLOT_FRAME::ShowChangedLanguage() { EDA_BASE_FRAME::ShowChangedLanguage(); updateTitle(); for( int ii = 0; ii < (int) m_plotNotebook->GetPageCount(); ++ii ) { SIM_PANEL_BASE* plot = dynamic_cast( m_plotNotebook->GetPage( ii ) ); plot->OnLanguageChanged(); wxString pageTitle( m_simulator->TypeToName( plot->GetType(), true ) ); pageTitle.Prepend( wxString::Format( _( "Plot%u - " ), ii+1 /* 1-based */ ) ); m_plotNotebook->SetPageText( ii, pageTitle ); } m_filter->SetHint( _( "Filter" ) ); m_signalsGrid->SetColLabelValue( COL_SIGNAL_NAME, _( "Signal" ) ); m_signalsGrid->SetColLabelValue( COL_SIGNAL_SHOW, _( "Plot" ) ); m_signalsGrid->SetColLabelValue( COL_SIGNAL_COLOR, _( "Color" ) ); m_signalsGrid->SetColLabelValue( COL_CURSOR_1, _( "Cursor 1" ) ); m_signalsGrid->SetColLabelValue( COL_CURSOR_2, _( "Cursor 2" ) ); m_cursorsGrid->SetColLabelValue( COL_CURSOR_NAME, _( "Cursor" ) ); m_cursorsGrid->SetColLabelValue( COL_CURSOR_SIGNAL, _( "Signal" ) ); m_cursorsGrid->SetColLabelValue( COL_CURSOR_X, _( "Time" ) ); m_cursorsGrid->SetColLabelValue( COL_CURSOR_Y, _( "Value" ) ); updateCursors(); for( TUNER_SLIDER* tuner : m_tuners ) tuner->ShowChangedLanguage(); } void SIM_PLOT_FRAME::LoadSettings( APP_SETTINGS_BASE* aCfg ) { EESCHEMA_SETTINGS* cfg = dynamic_cast( aCfg ); wxASSERT( cfg ); if( cfg ) { EDA_BASE_FRAME::LoadSettings( cfg ); // Read subwindows sizes (should be > 0 ) m_splitterLeftRightSashPosition = cfg->m_Simulator.plot_panel_width; m_splitterPlotAndConsoleSashPosition = cfg->m_Simulator.plot_panel_height; m_splitterSignalsSashPosition = cfg->m_Simulator.signal_panel_height; m_splitterCursorsSashPosition = cfg->m_Simulator.cursors_panel_height; m_splitterTuneValuesSashPosition = cfg->m_Simulator.measurements_panel_height; m_darkMode = !cfg->m_Simulator.white_background; } PROJECT_FILE& project = Prj().GetProjectFile(); NGSPICE* currentSim = dynamic_cast( m_simulator.get() ); if( currentSim ) m_simulator->Settings() = project.m_SchematicSettings->m_NgspiceSimulatorSettings; } void SIM_PLOT_FRAME::SaveSettings( APP_SETTINGS_BASE* aCfg ) { EESCHEMA_SETTINGS* cfg = dynamic_cast( aCfg ); wxASSERT( cfg ); if( cfg ) { EDA_BASE_FRAME::SaveSettings( cfg ); cfg->m_Simulator.plot_panel_width = m_splitterLeftRight->GetSashPosition(); cfg->m_Simulator.plot_panel_height = m_splitterPlotAndConsole->GetSashPosition(); cfg->m_Simulator.signal_panel_height = m_splitterSignals->GetSashPosition(); cfg->m_Simulator.cursors_panel_height = m_splitterCursors->GetSashPosition(); cfg->m_Simulator.measurements_panel_height = m_splitterMeasurements->GetSashPosition(); cfg->m_Simulator.white_background = !m_darkMode; } PROJECT_FILE& project = Prj().GetProjectFile(); if( project.m_SchematicSettings ) project.m_SchematicSettings->m_NgspiceSimulatorSettings->SaveToFile(); if( m_schematicFrame ) m_schematicFrame->SaveProjectSettings(); } WINDOW_SETTINGS* SIM_PLOT_FRAME::GetWindowSettings( APP_SETTINGS_BASE* aCfg ) { EESCHEMA_SETTINGS* cfg = dynamic_cast( aCfg ); wxASSERT( cfg ); return cfg ? &cfg->m_Simulator.window : nullptr; } void SIM_PLOT_FRAME::initWorkbook() { if( !m_simulator->Settings()->GetWorkbookFilename().IsEmpty() ) { wxFileName filename = m_simulator->Settings()->GetWorkbookFilename(); filename.SetPath( Prj().GetProjectPath() ); if( !LoadWorkbook( filename.GetFullPath() ) ) m_simulator->Settings()->SetWorkbookFilename( "" ); } else if( LoadSimulator() ) { if( !m_circuitModel->GetSchTextSimCommand().IsEmpty() ) NewPlotPanel( m_circuitModel->GetSchTextSimCommand(), m_circuitModel->GetSimOptions() ); rebuildSignalsList(); rebuildSignalsGrid( m_filter->GetValue() ); } } void SIM_PLOT_FRAME::updateTitle() { bool unsaved = true; bool readOnly = false; wxString title; if( m_simulator && m_simulator->Settings() ) { wxFileName filename = Prj().AbsolutePath( m_simulator->Settings()->GetWorkbookFilename() ); if( filename.IsOk() && filename.FileExists() ) { unsaved = false; readOnly = !filename.IsFileWritable(); } if( m_workbookModified ) title = wxT( "*" ) + filename.GetName(); else title = filename.GetName(); } if( readOnly ) title += wxS( " " ) + _( "[Read Only]" ); if( unsaved ) title += wxS( " " ) + _( "[Unsaved]" ); title += wxT( " \u2014 " ) + _( "Spice Simulator" ); SetTitle( title ); } void SIM_PLOT_FRAME::setSubWindowsSashSize() { if( m_splitterLeftRightSashPosition > 0 ) m_splitterLeftRight->SetSashPosition( m_splitterLeftRightSashPosition ); if( m_splitterPlotAndConsoleSashPosition > 0 ) m_splitterPlotAndConsole->SetSashPosition( m_splitterPlotAndConsoleSashPosition ); if( m_splitterSignalsSashPosition > 0 ) m_splitterSignals->SetSashPosition( m_splitterSignalsSashPosition ); if( m_splitterCursorsSashPosition > 0 ) m_splitterCursors->SetSashPosition( m_splitterCursorsSashPosition ); if( m_splitterTuneValuesSashPosition > 0 ) m_splitterMeasurements->SetSashPosition( m_splitterTuneValuesSashPosition ); } void SIM_PLOT_FRAME::rebuildSignalsGrid( wxString aFilter ) { SUPPRESS_GRID_CELL_EVENTS raii( this ); m_signalsGrid->ClearRows(); if( aFilter.IsEmpty() ) aFilter = wxS( "*" ); EDA_COMBINED_MATCHER matcher( aFilter, CTX_SIGNAL ); SIM_PLOT_PANEL* plotPanel = GetCurrentPlot(); int row = 0; for( const wxString& signal : m_signals ) { int matches; int offset; if( matcher.Find( signal, matches, offset ) && offset == 0 ) { TRACE* trace = plotPanel ? plotPanel->GetTrace( signal ) : nullptr; m_signalsGrid->AppendRows( 1 ); m_signalsGrid->SetCellValue( row, COL_SIGNAL_NAME, signal ); if( !plotPanel ) { wxGridCellAttr* attr = new wxGridCellAttr; attr->SetReadOnly(); m_signalsGrid->SetAttr( row, COL_SIGNAL_SHOW, attr ); } else { wxGridCellAttr* attr = new wxGridCellAttr; attr->SetRenderer( new wxGridCellBoolRenderer() ); attr->SetReadOnly(); // not really; we delegate interactivity to GRID_TRICKS attr->SetAlignment( wxALIGN_CENTER, wxALIGN_CENTER ); m_signalsGrid->SetAttr( row, COL_SIGNAL_SHOW, attr ); } if( trace ) m_signalsGrid->SetCellValue( row, COL_SIGNAL_SHOW, wxS( "1" ) ); if( !plotPanel || !trace ) { wxGridCellAttr* attr = new wxGridCellAttr; attr->SetReadOnly(); m_signalsGrid->SetAttr( row, COL_SIGNAL_COLOR, attr ); m_signalsGrid->SetCellValue( row, COL_SIGNAL_COLOR, wxEmptyString ); attr = new wxGridCellAttr; attr->SetReadOnly(); m_signalsGrid->SetAttr( row, COL_CURSOR_1, attr ); attr = new wxGridCellAttr; attr->SetReadOnly(); m_signalsGrid->SetAttr( row, COL_CURSOR_2, attr ); } else { wxGridCellAttr* attr = new wxGridCellAttr; attr = new wxGridCellAttr; attr->SetRenderer( new GRID_CELL_COLOR_RENDERER( this ) ); attr->SetEditor( new GRID_CELL_COLOR_SELECTOR( this, m_signalsGrid ) ); attr->SetAlignment( wxALIGN_CENTER, wxALIGN_CENTER ); m_signalsGrid->SetAttr( row, COL_SIGNAL_COLOR, attr ); KIGFX::COLOR4D color( trace->GetPen().GetColour() ); m_signalsGrid->SetCellValue( row, COL_SIGNAL_COLOR, color.ToCSSString() ); attr = new wxGridCellAttr; attr->SetRenderer( new wxGridCellBoolRenderer() ); attr->SetReadOnly(); // not really; we delegate interactivity to GRID_TRICKS attr->SetAlignment( wxALIGN_CENTER, wxALIGN_CENTER ); m_signalsGrid->SetAttr( row, COL_CURSOR_1, attr ); attr = new wxGridCellAttr; attr->SetRenderer( new wxGridCellBoolRenderer() ); attr->SetReadOnly(); // not really; we delegate interactivity to GRID_TRICKS attr->SetAlignment( wxALIGN_CENTER, wxALIGN_CENTER ); m_signalsGrid->SetAttr( row, COL_CURSOR_2, attr ); } row++; } } } void SIM_PLOT_FRAME::rebuildSignalsList() { m_signals.clear(); int options = GetCurrentOptions(); SIM_TYPE simType = NGSPICE_CIRCUIT_MODEL::CommandToSimType( GetCurrentSimCommand() ); wxString unconnected = wxString( wxS( "unconnected-(" ) ); if( simType == ST_UNKNOWN ) simType = ST_TRANSIENT; unconnected.Replace( '(', '_' ); // Convert to SPICE markup auto addSignal = [&]( const wxString& aSignal, const wxString& aSpiceVecName = wxEmptyString ) { if( simType == ST_AC ) { wxString gain = _( " (gain)" ); wxString phase = _( " (phase)" ); m_signals.push_back( aSignal + gain ); m_signals.push_back( aSignal + phase ); if( !aSpiceVecName.IsEmpty() ) { m_userDefinedSignalToSpiceVecName[ aSignal + gain ] = aSpiceVecName + gain; m_userDefinedSignalToSpiceVecName[ aSignal + phase ] = aSpiceVecName + phase; } } else { m_signals.push_back( aSignal ); if( !aSpiceVecName.IsEmpty() ) m_userDefinedSignalToSpiceVecName[ aSignal ] = aSpiceVecName; } }; if( options & NETLIST_EXPORTER_SPICE::OPTION_SAVE_ALL_VOLTAGES ) { for( const std::string& net : m_circuitModel->GetNets() ) { // netnames are escaped (can contain "{slash}" for '/') Unscape them: wxString netname = UnescapeString( net ); if( netname == "GND" || netname == "0" || netname.StartsWith( unconnected ) ) continue; m_quotedNetnames[ netname ] = wxString::Format( wxS( "\"%s\"" ), netname ); addSignal( wxString::Format( wxS( "V(%s)" ), netname ) ); } } if( ( options & NETLIST_EXPORTER_SPICE::OPTION_SAVE_ALL_CURRENTS ) && ( simType == ST_TRANSIENT || simType == ST_DC ) ) { for( const SPICE_ITEM& item : m_circuitModel->GetItems() ) { // Add all possible currents for the device. for( const std::string& name : item.model->SpiceGenerator().CurrentNames( item ) ) addSignal( name ); } } if( ( options & NETLIST_EXPORTER_SPICE::OPTION_SAVE_ALL_DISSIPATIONS ) && ( simType == ST_TRANSIENT || simType == ST_DC ) ) { for( const SPICE_ITEM& item : m_circuitModel->GetItems() ) { if( item.model->GetPinCount() >= 2 ) { wxString name = item.model->SpiceGenerator().ItemName( item ); addSignal( wxString::Format( wxS( "P(%s)" ), name ) ); } } } // Add .PROBE directives for( const wxString& directive : m_circuitModel->GetDirectives() ) { wxStringTokenizer tokenizer( directive, wxT( "\r\n" ), wxTOKEN_STRTOK ); while( tokenizer.HasMoreTokens() ) { wxString line = tokenizer.GetNextToken(); wxString directiveParams; if( line.Upper().StartsWith( wxS( ".PROBE" ), &directiveParams ) ) addSignal( directiveParams.Trim( true ).Trim( false ) ); } } // JEY TODO: find and add SPICE "LET" commands // Add user-defined signals for( int ii = 0; ii < (int) m_userDefinedSignals.size(); ++ii ) { static wxRegEx regEx( wxS( "(^|[^a-z0-9_])([VIP])\\(" ), wxRE_ICASE ); const wxString& signal = m_userDefinedSignals[ii]; if( regEx.Matches( signal ) ) { wxString vecType = regEx.GetMatch( signal, 2 ); wxString spiceVecName = wxString::Format( wxS( "%s(user%d)" ), vecType, ii ); addSignal( signal, spiceVecName ); } } std::sort( m_signals.begin(), m_signals.end(), []( const wxString& lhs, const wxString& rhs ) { // Sort voltages first if( lhs.Upper().StartsWith( 'V' ) && !rhs.Upper().StartsWith( 'V' ) ) return true; else if( !lhs.Upper().StartsWith( 'V' ) && rhs.Upper().StartsWith( 'V' ) ) return false; return StrNumCmp( lhs, rhs, true /* ignore case */ ) < 0; } ); } bool SIM_PLOT_FRAME::LoadSimulator() { wxString errors; WX_STRING_REPORTER reporter( &errors ); if( !m_schematicFrame->ReadyToNetlist( _( "Simulator requires a fully annotated schematic." ) ) ) return false; if( !m_simulator->Attach( m_circuitModel, reporter ) ) { DisplayErrorMessage( this, _( "Errors during netlist generation.\n\n" ) + errors ); return false; } return true; } void SIM_PLOT_FRAME::StartSimulation() { if( m_circuitModel->CommandToSimType( GetCurrentSimCommand() ) == ST_UNKNOWN ) { if( !EditSimCommand() ) return; if( m_circuitModel->CommandToSimType( GetCurrentSimCommand() ) == ST_UNKNOWN ) return; } wxString schTextSimCommand = m_circuitModel->GetSchTextSimCommand(); SIM_TYPE schTextSimType = NGSPICE_CIRCUIT_MODEL::CommandToSimType( schTextSimCommand ); SIM_PANEL_BASE* plotWindow = getCurrentPlotWindow(); if( !plotWindow ) { plotWindow = NewPlotPanel( schTextSimCommand, m_circuitModel->GetSimOptions() ); m_workbookModified = true; } else { m_circuitModel->SetSimCommandOverride( plotWindow->GetSimCommand() ); if( plotWindow->GetType() == schTextSimType && schTextSimCommand != m_circuitModel->GetLastSchTextSimCommand() ) { if( IsOK( this, _( "Schematic sheet simulation command directive has changed. " "Do you wish to update the Simulation Command?" ) ) ) { m_circuitModel->SetSimCommandOverride( wxEmptyString ); plotWindow->SetSimCommand( schTextSimCommand ); m_workbookModified = true; } } } m_circuitModel->SetSimOptions( GetCurrentOptions() ); if( !LoadSimulator() ) return; std::unique_lock simulatorLock( m_simulator->GetMutex(), std::try_to_lock ); if( simulatorLock.owns_lock() ) { wxBusyCursor toggle; m_simConsole->Clear(); applyTuners(); // Prevents memory leak on succeding simulations by deleting old vectors m_simulator->Clean(); m_simulator->Run(); } else { DisplayErrorMessage( this, _( "Another simulation is already running." ) ); } } SIM_PANEL_BASE* SIM_PLOT_FRAME::NewPlotPanel( const wxString& aSimCommand, int aOptions ) { SIM_PANEL_BASE* plotPanel = nullptr; SIM_TYPE simType = NGSPICE_CIRCUIT_MODEL::CommandToSimType( aSimCommand ); if( SIM_PANEL_BASE::IsPlottable( simType ) ) { SIM_PLOT_PANEL* panel = new SIM_PLOT_PANEL( aSimCommand, aOptions, m_plotNotebook, wxID_ANY ); plotPanel = dynamic_cast( panel ); COMMON_SETTINGS::INPUT cfg = Pgm().GetCommonSettings()->m_Input; panel->GetPlotWin()->EnableMouseWheelPan( cfg.scroll_modifier_zoom != 0 ); } else { SIM_NOPLOT_PANEL* panel = new SIM_NOPLOT_PANEL( aSimCommand, aOptions, m_plotNotebook, wxID_ANY ); plotPanel = dynamic_cast( panel ); } wxString pageTitle( m_simulator->TypeToName( simType, true ) ); pageTitle.Prepend( wxString::Format( _( "Plot%u - " ), (unsigned int) ++m_plotNumber ) ); m_plotNotebook->AddPage( dynamic_cast( plotPanel ), pageTitle, true ); return plotPanel; } void SIM_PLOT_FRAME::OnFilterText( wxCommandEvent& aEvent ) { rebuildSignalsGrid( m_filter->GetValue() ); } void SIM_PLOT_FRAME::OnFilterMouseMoved( wxMouseEvent& aEvent ) { wxPoint pos = aEvent.GetPosition(); wxRect ctrlRect = m_filter->GetScreenRect(); int buttonWidth = ctrlRect.GetHeight(); // Presume buttons are square if( m_filter->IsSearchButtonVisible() && pos.x < buttonWidth ) SetCursor( wxCURSOR_ARROW ); else if( m_filter->IsCancelButtonVisible() && pos.x > ctrlRect.GetWidth() - buttonWidth ) SetCursor( wxCURSOR_ARROW ); else SetCursor( wxCURSOR_IBEAM ); } /** * For user-defined signals we display the expression such as "V(out)-V(in)", but the SPICE * signal we actually have to plot will be "user0" or some-such. */ wxString SIM_PLOT_FRAME::getTraceName( const wxString& aSignalName ) { if( alg::contains( m_userDefinedSignals, aSignalName ) ) return m_userDefinedSignalToSpiceVecName[ aSignalName ]; return aSignalName; } wxString SIM_PLOT_FRAME::getTraceName( int aRow ) { return getTraceName( m_signalsGrid->GetCellValue( aRow, COL_SIGNAL_NAME ) ); } /** * AC-small-signal analyses have two traces per signal, so we suffix the names. */ wxString SIM_PLOT_FRAME::getTraceTitle( const wxString& aName, SIM_TRACE_TYPE aTraceType ) { if( aTraceType & SPT_AC_MAG ) return aName + _( " (gain)" ); else if( aTraceType & SPT_AC_PHASE ) return aName + _( " (phase)" ); else return aName; } void SIM_PLOT_FRAME::onSignalsGridCellChanged( wxGridEvent& aEvent ) { if( m_SuppressGridEvents > 0 ) return; int row = aEvent.GetRow(); int col = aEvent.GetCol(); wxString text = m_signalsGrid->GetCellValue( row, col ); SIM_PLOT_PANEL* plot = GetCurrentPlot(); if( col == COL_SIGNAL_SHOW ) { if( text == wxS( "1" ) ) addTrace( getTraceName( row ) ); else removeTrace( getTraceName( row ) ); // Update enabled/visible states of other controls updateSignalsGrid(); m_workbookModified = true; } else if( col == COL_SIGNAL_COLOR ) { KIGFX::COLOR4D color( m_signalsGrid->GetCellValue( row, COL_SIGNAL_COLOR ) ); TRACE* trace = plot->GetTrace( getTraceName( row ) ); if( trace ) { trace->SetTraceColour( color.ToColour() ); plot->UpdateTraceStyle( trace ); plot->UpdatePlotColors(); m_workbookModified = true; } } else if( col == COL_CURSOR_1 || col == COL_CURSOR_2 ) { for( int ii = 0; ii < m_signalsGrid->GetNumberRows(); ++ii ) { bool enable = ii == row && text == wxS( "1" ); plot->EnableCursor( getTraceName( ii ), col == COL_CURSOR_1 ? 1 : 2, enable ); m_workbookModified = true; } // Update cursor checkboxes (which are really radio buttons) updateSignalsGrid(); } } void SIM_PLOT_FRAME::onCursorsGridCellChanged( wxGridEvent& aEvent ) { if( m_SuppressGridEvents > 0 ) return; SIM_PLOT_PANEL* plotPanel = GetCurrentPlot(); if( !plotPanel ) return; int row = aEvent.GetRow(); int col = aEvent.GetCol(); wxString text = m_cursorsGrid->GetCellValue( row, col ); wxString cursorName = m_cursorsGrid->GetCellValue( row, COL_CURSOR_NAME ); if( col == COL_CURSOR_X ) { CURSOR* cursor1 = nullptr; CURSOR* cursor2 = nullptr; for( const auto& [name, trace] : plotPanel->GetTraces() ) { if( CURSOR* cursor = trace->GetCursor( 1 ) ) cursor1 = cursor; if( CURSOR* cursor = trace->GetCursor( 2 ) ) cursor2 = cursor; } double value = SPICE_VALUE( text ).ToDouble(); if( cursorName == wxS( "1" ) && cursor1 ) cursor1->SetCoordX( value ); else if( cursorName == wxS( "2" ) && cursor2 ) cursor2->SetCoordX( value ); else if( cursorName == _( "Diff" ) && cursor1 && cursor2 ) cursor2->SetCoordX( cursor1->GetCoords().x + value ); updateCursors(); m_workbookModified = true; } else { wxFAIL_MSG( wxT( "All other columns are supposed to be read-only!" ) ); } } SPICE_VALUE_FORMAT SIM_PLOT_FRAME::GetMeasureFormat( int aRow ) const { SPICE_VALUE_FORMAT result; result.FromString( m_measurementsGrid->GetCellValue( aRow, COL_MEASUREMENT_FORMAT ) ); return result; } void SIM_PLOT_FRAME::SetMeasureFormat( int aRow, const SPICE_VALUE_FORMAT& aFormat ) { m_measurementsGrid->SetCellValue( aRow, COL_MEASUREMENT_FORMAT, aFormat.ToString() ); m_workbookModified = true; } void SIM_PLOT_FRAME::DeleteMeasurement( int aRow ) { if( aRow < ( m_measurementsGrid->GetNumberRows() - 1 ) ) { m_measurementsGrid->DeleteRows( aRow, 1 ); m_workbookModified = true; } } void SIM_PLOT_FRAME::onMeasurementsGridCellChanged( wxGridEvent& aEvent ) { SIM_PLOT_PANEL* plotPanel = GetCurrentPlot(); if( !plotPanel ) return; int row = aEvent.GetRow(); int col = aEvent.GetCol(); wxString text = m_measurementsGrid->GetCellValue( row, col ); if( col == COL_MEASUREMENT ) { UpdateMeasurement( row ); m_workbookModified = true; } else { wxFAIL_MSG( wxT( "All other columns are supposed to be read-only!" ) ); } // Always leave a single empty row for type-in int rowCount = (int) m_measurementsGrid->GetNumberRows(); int emptyRows = 0; for( row = rowCount - 1; row >= 0; row-- ) { if( m_measurementsGrid->GetCellValue( row, COL_MEASUREMENT ).IsEmpty() ) emptyRows++; else break; } if( emptyRows > 1 ) { int killRows = emptyRows - 1; m_measurementsGrid->DeleteRows( rowCount - killRows, killRows ); } else if( emptyRows == 0 ) { m_measurementsGrid->AppendRows( 1 ); } } /** * The user measurement looks something like: * MAX V(out) * * We need to send ngspice a "MEAS" command with the analysis type, an output variable name, * and the signal name. For our example above, this looks something like: * MEAS TRAN meas_result_0 MAX V(out) * * This is also a good time to harvest the signal name prefix so we know what units to show on * the result. For instance, for: * MAX P(out) * we want to show: * 15W */ void SIM_PLOT_FRAME::UpdateMeasurement( int aRow ) { static wxRegEx measureParamsRegEx( wxT( "^" " *" "([a-zA-Z_]+)" " +" "([a-zA-Z])\\(([^\\)]+)\\)" ) ); SIM_PLOT_PANEL* plotPanel = GetCurrentPlot(); if( !plotPanel ) return; wxString text = m_measurementsGrid->GetCellValue( aRow, COL_MEASUREMENT ); if( text.IsEmpty() ) { m_measurementsGrid->SetCellValue( aRow, COL_MEASUREMENT_VALUE, wxEmptyString ); return; } wxString simType = m_simulator->TypeToName( plotPanel->GetType(), true ); wxString resultName = wxString::Format( wxS( "meas_result_%u" ), aRow ); wxString result = wxS( "?" ); if( measureParamsRegEx.Matches( text ) ) { wxString func = measureParamsRegEx.GetMatch( text, 1 ).Upper(); wxUniChar signalType = measureParamsRegEx.GetMatch( text, 2 ).Upper()[0]; wxString deviceName = measureParamsRegEx.GetMatch( text, 3 ); wxString units; SPICE_VALUE_FORMAT fmt = GetMeasureFormat( aRow ); if( signalType == 'I' ) units = wxS( "A" ); else if( signalType == 'P' ) { units = wxS( "W" ); // Our syntax is different from ngspice for power signals text = func + " " + deviceName + ":power"; } else units = wxS( "V" ); if( func.EndsWith( wxS( "_AT" ) ) ) units = wxS( "s" ); else if( func.StartsWith( wxS( "INTEG" ) ) ) { switch( plotPanel->GetType() ) { case SIM_TYPE::ST_TRANSIENT: if ( signalType == 'P' ) units = wxS( "J" ); else units += wxS( ".s" ); break; case SIM_TYPE::ST_AC: case SIM_TYPE::ST_DISTORTION: case SIM_TYPE::ST_NOISE: case SIM_TYPE::ST_SENSITIVITY: // If there is a vector, it is frequency units += wxS( "·Hz" ); break; case SIM_TYPE::ST_DC: // Could be a lot of things : V, A, deg C, ohm, ... case SIM_TYPE::ST_OP: // There is no vector for integration case SIM_TYPE::ST_POLE_ZERO: // There is no vector for integration case SIM_TYPE::ST_TRANS_FUNC: // There is no vector for integration default: units += wxS( "·?" ); break; } } fmt.UpdateUnits( units ); SetMeasureFormat( aRow, fmt ); } if( m_simFinished ) { wxString cmd = wxString::Format( wxS( "meas %s %s %s" ), simType, resultName, text ); m_simulator->Command( "echo " + cmd.ToStdString() ); m_simulator->Command( cmd.ToStdString() ); std::vector resultVec = m_simulator->GetMagPlot( resultName.ToStdString() ); if( resultVec.size() > 0 ) result = SPICE_VALUE( resultVec[0] ).ToString( GetMeasureFormat( aRow ) ); } m_measurementsGrid->SetCellValue( aRow, COL_MEASUREMENT_VALUE, result ); } void SIM_PLOT_FRAME::AddVoltagePlot( const wxString& aNetName ) { doAddPlot( aNetName, SPT_VOLTAGE ); } void SIM_PLOT_FRAME::AddCurrentPlot( const wxString& aDeviceName ) { doAddPlot( aDeviceName, SPT_CURRENT ); } void SIM_PLOT_FRAME::AddTuner( const SCH_SHEET_PATH& aSheetPath, SCH_SYMBOL* aSymbol ) { SIM_PANEL_BASE* plotPanel = getCurrentPlotWindow(); if( !plotPanel ) return; wxString ref = aSymbol->GetRef( &aSheetPath ); // Do not add multiple instances for the same component. for( TUNER_SLIDER* tuner : m_tuners ) { if( tuner->GetSymbolRef() == ref ) return; } const SPICE_ITEM* item = GetExporter()->FindItem( std::string( ref.ToUTF8() ) ); // Do nothing if the symbol is not tunable. if( !item || !item->model->GetTunerParam() ) return; try { TUNER_SLIDER* tuner = new TUNER_SLIDER( this, m_panelTuners, aSheetPath, aSymbol ); m_sizerTuners->Add( tuner ); m_tuners.push_back( tuner ); m_panelTuners->Layout(); m_workbookModified = true; } catch( const KI_PARAM_ERROR& e ) { DisplayErrorMessage( nullptr, e.What() ); } } void SIM_PLOT_FRAME::UpdateTunerValue( const SCH_SHEET_PATH& aSheetPath, const KIID& aSymbol, const wxString& aRef, const wxString& aValue ) { SCH_ITEM* item = aSheetPath.GetItem( aSymbol ); SCH_SYMBOL* symbol = dynamic_cast( item ); if( !symbol ) { DisplayErrorMessage( this, _( "Could not apply tuned value(s):" ) + wxS( " " ) + wxString::Format( _( "%s not found" ), aRef ) ); return; } SIM_LIB_MGR mgr( &Prj() ); SIM_MODEL& model = mgr.CreateModel( &aSheetPath, *symbol ).model; const SIM_MODEL::PARAM* tunerParam = model.GetTunerParam(); if( !tunerParam ) { DisplayErrorMessage( this, _( "Could not apply tuned value(s):" ) + wxS( " " ) + wxString::Format( _( "%s is not tunable" ), aRef ) ); return; } model.SetParamValue( tunerParam->info.name, std::string( aValue.ToUTF8() ) ); model.WriteFields( symbol->GetFields() ); m_schematicFrame->UpdateItem( symbol, false, true ); m_schematicFrame->OnModify(); } void SIM_PLOT_FRAME::RemoveTuner( TUNER_SLIDER* aTuner, bool aErase ) { if( aErase ) m_tuners.remove( aTuner ); aTuner->Destroy(); m_panelTuners->Layout(); m_workbookModified = true; } void SIM_PLOT_FRAME::AddMeasurement( const wxString& aCmd ) { // -1 because the last one is for user inpu for ( int i = 0; i < m_measurementsGrid->GetNumberRows(); i++ ) { if ( m_measurementsGrid->GetCellValue( i, COL_MEASUREMENT ) == aCmd ) return; // Don't create duplicates } SIM_PLOT_PANEL* plotPanel = GetCurrentPlot(); if( !plotPanel ) return; wxString simType = m_simulator->TypeToName( plotPanel->GetType(), true ); int row; for( row = 0; row < m_measurementsGrid->GetNumberRows(); ++row ) { if( m_measurementsGrid->GetCellValue( row, COL_MEASUREMENT ).IsEmpty() ) break; } if( !m_measurementsGrid->GetCellValue( row, COL_MEASUREMENT ).IsEmpty() ) { m_measurementsGrid->AppendRows( 1 ); row = m_measurementsGrid->GetNumberRows() - 1; } m_measurementsGrid->SetCellValue( row, COL_MEASUREMENT, aCmd ); SetMeasureFormat( row, { 3, wxS( "~V" ) } ); UpdateMeasurement( row ); m_workbookModified = true; // Always leave at least one empty row for type-in: row = m_measurementsGrid->GetNumberRows() - 1; if( !m_measurementsGrid->GetCellValue( row, COL_MEASUREMENT ).IsEmpty() ) m_measurementsGrid->AppendRows( 1 ); } SIM_PLOT_PANEL* SIM_PLOT_FRAME::GetCurrentPlot() const { SIM_PANEL_BASE* curPage = getCurrentPlotWindow(); return !curPage || curPage->GetType() == ST_UNKNOWN ? nullptr : dynamic_cast( curPage ); } const NGSPICE_CIRCUIT_MODEL* SIM_PLOT_FRAME::GetExporter() const { return m_circuitModel.get(); } void SIM_PLOT_FRAME::doAddPlot( const wxString& aName, SIM_TRACE_TYPE aType ) { SIM_PLOT_PANEL* plotPanel = GetCurrentPlot(); if( !plotPanel ) { m_simConsole->AppendText( _( "Error: no current simulation.\n" ) ); m_simConsole->SetInsertionPointEnd(); return; } SIM_TYPE simType = NGSPICE_CIRCUIT_MODEL::CommandToSimType( plotPanel->GetSimCommand() ); if( simType == ST_UNKNOWN ) { m_simConsole->AppendText( _( "Error: simulation type not defined.\n" ) ); m_simConsole->SetInsertionPointEnd(); return; } else if( !SIM_PANEL_BASE::IsPlottable( simType ) ) { m_simConsole->AppendText( _( "Error: simulation type doesn't support plotting.\n" ) ); m_simConsole->SetInsertionPointEnd(); return; } SIM_TRACE_TYPE xAxisType = getXAxisType( simType ); if( ( xAxisType == SPT_LIN_FREQUENCY || xAxisType == SPT_LOG_FREQUENCY ) && ( aType & ( SPT_AC_MAG | SPT_AC_PHASE ) ) == 0 ) { // If magnitude or phase wasn't specified, then add both updateTrace( aName, (SIM_TRACE_TYPE) ( aType | SPT_AC_MAG ), plotPanel ); updateTrace( aName, (SIM_TRACE_TYPE) ( aType | SPT_AC_PHASE ), plotPanel ); } else { updateTrace( aName, aType, plotPanel ); } updateSignalsGrid(); m_workbookModified = true; } void SIM_PLOT_FRAME::SetUserDefinedSignals( const std::vector& aNewSignals ) { for( const wxString& signal : m_userDefinedSignals ) { if( !alg::contains( aNewSignals, signal ) ) removeTrace( m_userDefinedSignalToSpiceVecName[ signal ] ); } m_userDefinedSignals = aNewSignals; if( m_simFinished ) applyUserDefinedSignals(); rebuildSignalsList(); rebuildSignalsGrid( m_filter->GetValue() ); updateSignalsGrid(); m_workbookModified = true; } void SIM_PLOT_FRAME::addTrace( const wxString& aSignalName ) { if( aSignalName.IsEmpty() ) return; wxString baseSignal = aSignalName; wxString gainSuffix = _( " (gain)" ); wxString phaseSuffix = _( " (phase)" ); wxUniChar firstChar = aSignalName.Upper()[0]; int traceType = SPT_UNKNOWN; if( firstChar == 'V' ) traceType = SPT_VOLTAGE; else if( firstChar == 'I' ) traceType = SPT_CURRENT; else if( firstChar == 'P' ) traceType = SPT_POWER; if( aSignalName.EndsWith( gainSuffix ) ) { traceType |= SPT_AC_MAG; baseSignal = aSignalName.Left( aSignalName.Length() - gainSuffix.Length() ); } else if( aSignalName.EndsWith( phaseSuffix ) ) { traceType |= SPT_AC_PHASE; baseSignal = aSignalName.Left( aSignalName.Length() - phaseSuffix.Length() ); } if( traceType != SPT_UNKNOWN ) { if( SIM_PLOT_PANEL* plotPanel = GetCurrentPlot() ) updateTrace( baseSignal, (SIM_TRACE_TYPE) traceType, plotPanel ); } } void SIM_PLOT_FRAME::removeTrace( const wxString& aSignalName ) { SIM_PLOT_PANEL* plotPanel = GetCurrentPlot(); if( !plotPanel ) return; wxASSERT( plotPanel->TraceShown( aSignalName ) ); if( plotPanel->DeleteTrace( aSignalName ) ) m_workbookModified = true; plotPanel->GetPlotWin()->Fit(); updateSignalsGrid(); updateCursors(); } void SIM_PLOT_FRAME::updateTrace( const wxString& aName, SIM_TRACE_TYPE aTraceType, SIM_PLOT_PANEL* aPlotPanel ) { SIM_TYPE simType = NGSPICE_CIRCUIT_MODEL::CommandToSimType( aPlotPanel->GetSimCommand() ); aTraceType = (SIM_TRACE_TYPE) ( aTraceType & SPT_Y_AXIS_MASK ); aTraceType = (SIM_TRACE_TYPE) ( aTraceType | getXAxisType( simType ) ); wxString traceTitle = getTraceTitle( aName, aTraceType ); wxString vectorName = aName; if( aTraceType & SPT_POWER ) vectorName = vectorName.AfterFirst( '(' ).BeforeLast( ')' ) + wxS( ":power" ); if( !SIM_PANEL_BASE::IsPlottable( simType ) ) { // There is no plot to be shown m_simulator->Command( wxString::Format( wxT( "print %s" ), aName ).ToStdString() ); return; } // First, handle the x axis wxString xAxisName( m_simulator->GetXAxis( simType ) ); if( xAxisName.IsEmpty() ) return; std::vector data_x; std::vector data_y; if( m_simFinished ) { data_x = m_simulator->GetMagPlot( (const char*) xAxisName.c_str() ); switch( simType ) { case ST_AC: if( aTraceType & SPT_AC_MAG ) data_y = m_simulator->GetMagPlot( (const char*) vectorName.c_str() ); else if( aTraceType & SPT_AC_PHASE ) data_y = m_simulator->GetPhasePlot( (const char*) vectorName.c_str() ); else wxFAIL_MSG( wxT( "Plot type missing AC_PHASE or AC_MAG bit" ) ); break; case ST_NOISE: case ST_DC: case ST_TRANSIENT: data_y = m_simulator->GetMagPlot( (const char*) vectorName.c_str() ); break; default: wxFAIL_MSG( wxT( "Unhandled plot type" ) ); } } unsigned int size = data_x.size(); // If we did a two-source DC analysis, we need to split the resulting vector and add traces // for each input step SPICE_DC_PARAMS source1, source2; if( simType == ST_DC && m_circuitModel->ParseDCCommand( m_circuitModel->GetSimCommand(), &source1, &source2 ) && !source2.m_source.IsEmpty() ) { // Source 1 is the inner loop, so lets add traces for each Source 2 (outer loop) step SPICE_VALUE v = source2.m_vstart; wxString name; size_t offset = 0; size_t outer = ( size_t )( ( source2.m_vend - v ) / source2.m_vincrement ).ToDouble(); size_t inner = data_x.size() / ( outer + 1 ); wxASSERT( data_x.size() % ( outer + 1 ) == 0 ); for( size_t idx = 0; idx <= outer; idx++ ) { name = wxString::Format( wxT( "%s (%s = %s V)" ), traceTitle, source2.m_source, v.ToString() ); if( TRACE* trace = aPlotPanel->AddTrace( name, aName, aTraceType ) ) { if( data_y.size() >= size ) { std::vector sub_x( data_x.begin() + offset, data_x.begin() + offset + inner ); std::vector sub_y( data_y.begin() + offset, data_y.begin() + offset + inner ); aPlotPanel->SetTraceData( trace, inner, sub_x.data(), sub_y.data() ); } } v = v + source2.m_vincrement; offset += inner; } } else if( TRACE* trace = aPlotPanel->AddTrace( traceTitle, aName, aTraceType ) ) { if( data_y.size() >= size ) aPlotPanel->SetTraceData( trace, size, data_x.data(), data_y.data() ); } } void SIM_PLOT_FRAME::updateSignalsGrid() { SIM_PLOT_PANEL* plot = GetCurrentPlot(); for( int row = 0; row < m_signalsGrid->GetNumberRows(); ++row ) { if( TRACE* trace = plot ? plot->GetTrace( getTraceName( row ) ) : nullptr ) { m_signalsGrid->SetCellValue( row, COL_SIGNAL_SHOW, wxS( "1" ) ); wxGridCellAttr* attr = new wxGridCellAttr; attr->SetRenderer( new GRID_CELL_COLOR_RENDERER( this ) ); attr->SetEditor( new GRID_CELL_COLOR_SELECTOR( this, m_signalsGrid ) ); attr->SetAlignment( wxALIGN_CENTER, wxALIGN_CENTER ); m_signalsGrid->SetAttr( row, COL_SIGNAL_COLOR, attr ); KIGFX::COLOR4D color( trace->GetPen().GetColour() ); m_signalsGrid->SetCellValue( row, COL_SIGNAL_COLOR, color.ToCSSString() ); attr = new wxGridCellAttr; attr->SetRenderer( new wxGridCellBoolRenderer() ); attr->SetReadOnly(); // not really; we delegate interactivity to GRID_TRICKS attr->SetAlignment( wxALIGN_CENTER, wxALIGN_CENTER ); m_signalsGrid->SetAttr( row, COL_CURSOR_1, attr ); attr = new wxGridCellAttr; attr->SetRenderer( new wxGridCellBoolRenderer() ); attr->SetReadOnly(); // not really; we delegate interactivity to GRID_TRICKS attr->SetAlignment( wxALIGN_CENTER, wxALIGN_CENTER ); m_signalsGrid->SetAttr( row, COL_CURSOR_2, attr ); if( trace->HasCursor( 1 ) ) m_signalsGrid->SetCellValue( row, COL_CURSOR_1, wxS( "1" ) ); else m_signalsGrid->SetCellValue( row, COL_CURSOR_1, wxEmptyString ); if( trace->HasCursor( 2 ) ) m_signalsGrid->SetCellValue( row, COL_CURSOR_2, wxS( "1" ) ); else m_signalsGrid->SetCellValue( row, COL_CURSOR_2, wxEmptyString ); } else { m_signalsGrid->SetCellValue( row, COL_SIGNAL_SHOW, wxEmptyString ); wxGridCellAttr* attr = new wxGridCellAttr; attr->SetReadOnly(); m_signalsGrid->SetAttr( row, COL_SIGNAL_COLOR, attr ); m_signalsGrid->SetCellValue( row, COL_SIGNAL_COLOR, wxEmptyString ); attr = new wxGridCellAttr; attr->SetReadOnly(); m_signalsGrid->SetAttr( row, COL_CURSOR_1, attr ); m_signalsGrid->SetCellValue( row, COL_CURSOR_1, wxEmptyString ); attr = new wxGridCellAttr; attr->SetReadOnly(); m_signalsGrid->SetAttr( row, COL_CURSOR_2, attr ); m_signalsGrid->SetCellValue( row, COL_CURSOR_2, wxEmptyString ); } } } void SIM_PLOT_FRAME::applyUserDefinedSignals() { auto quoteNetNames = [&]( wxString aExpression ) -> wxString { for( const auto& [netname, quotedNetname] : m_quotedNetnames ) aExpression.Replace( netname, quotedNetname ); return aExpression; }; for( int ii = 0; ii < (int) m_userDefinedSignals.size(); ++ii ) { wxString signal = m_userDefinedSignals[ii]; std::string cmd = "let user{} = {}"; m_simulator->Command( "echo " + fmt::format(cmd, ii, signal.ToStdString() ) ); m_simulator->Command( fmt::format( cmd, ii, quoteNetNames( signal ).ToStdString() ) ); } } void SIM_PLOT_FRAME::applyTuners() { wxString errors; WX_STRING_REPORTER reporter( &errors ); for( const TUNER_SLIDER* tuner : m_tuners ) { SCH_SHEET_PATH sheetPath; wxString ref = tuner->GetSymbolRef(); KIID symbolId = tuner->GetSymbol( &sheetPath ); SCH_ITEM* schItem = sheetPath.GetItem( symbolId ); SCH_SYMBOL* symbol = dynamic_cast( schItem ); if( !symbol ) { reporter.Report( wxString::Format( _( "%s not found" ), ref ) ); continue; } const SPICE_ITEM* item = GetExporter()->FindItem( tuner->GetSymbolRef().ToStdString() ); if( !item || !item->model->GetTunerParam() ) { reporter.Report( wxString::Format( _( "%s is not tunable" ), ref ) ); continue; } double floatVal = tuner->GetValue().ToDouble(); m_simulator->Command( item->model->SpiceGenerator().TunerCommand( *item, floatVal ) ); } if( reporter.HasMessage() ) DisplayErrorMessage( this, _( "Could not apply tuned value(s):" ) + wxS( "\n" ) + errors ); } bool SIM_PLOT_FRAME::LoadWorkbook( const wxString& aPath ) { m_plotNotebook->DeleteAllPages(); wxTextFile file( aPath ); #define DISPLAY_LOAD_ERROR( fmt ) DisplayErrorMessage( this, wxString::Format( _( fmt ), \ file.GetCurrentLine()+1 ) ) if( !file.Open() ) return false; long version = 1; wxString firstLine = file.GetFirstLine(); wxString plotCountLine; if( firstLine.StartsWith( wxT( "version " ) ) ) { if( !firstLine.substr( 8 ).ToLong( &version ) ) { DISPLAY_LOAD_ERROR( "Error loading workbook: Line %d is not an integer." ); file.Close(); return false; } plotCountLine = file.GetNextLine(); } else { plotCountLine = firstLine; } long plotsCount; if( !plotCountLine.ToLong( &plotsCount ) ) { DISPLAY_LOAD_ERROR( "Error loading workbook: Line %d is not an integer." ); file.Close(); return false; } for( long i = 0; i < plotsCount; ++i ) { long plotType, tracesCount; if( !file.GetNextLine().ToLong( &plotType ) ) { DISPLAY_LOAD_ERROR( "Error loading workbook: Line %d is not an integer." ); file.Close(); return false; } wxString command = UnescapeString( file.GetNextLine() ); wxString simCommand; int simOptions = NETLIST_EXPORTER_SPICE::OPTION_DEFAULT_FLAGS; wxStringTokenizer tokenizer( command, wxT( "\r\n" ), wxTOKEN_STRTOK ); if( version >= 2 ) { simOptions &= ~NETLIST_EXPORTER_SPICE::OPTION_ADJUST_INCLUDE_PATHS; simOptions &= ~NETLIST_EXPORTER_SPICE::OPTION_SAVE_ALL_VOLTAGES; simOptions &= ~NETLIST_EXPORTER_SPICE::OPTION_SAVE_ALL_CURRENTS; } else if( version >= 3 ) { simOptions &= ~NETLIST_EXPORTER_SPICE::OPTION_SAVE_ALL_DISSIPATIONS; } while( tokenizer.HasMoreTokens() ) { wxString line = tokenizer.GetNextToken(); if( line.StartsWith( wxT( ".kicad adjustpaths" ) ) ) simOptions |= NETLIST_EXPORTER_SPICE::OPTION_ADJUST_INCLUDE_PATHS; else if( line.StartsWith( wxT( ".save all" ) ) ) simOptions |= NETLIST_EXPORTER_SPICE::OPTION_SAVE_ALL_VOLTAGES; else if( line.StartsWith( wxT( ".probe alli" ) ) ) simOptions |= NETLIST_EXPORTER_SPICE::OPTION_SAVE_ALL_CURRENTS; else if( line.StartsWith( wxT( ".probe allp" ) ) ) simOptions |= NETLIST_EXPORTER_SPICE::OPTION_SAVE_ALL_DISSIPATIONS; else simCommand += line + wxT( "\n" ); } NewPlotPanel( simCommand, simOptions ); if( !file.GetNextLine().ToLong( &tracesCount ) ) { DISPLAY_LOAD_ERROR( "Error loading workbook: Line %d is not an integer." ); file.Close(); return false; } for( long j = 0; j < tracesCount; ++j ) { long traceType; wxString name, param; if( !file.GetNextLine().ToLong( &traceType ) ) { DISPLAY_LOAD_ERROR( "Error loading workbook: Line %d is not an integer." ); file.Close(); return false; } name = file.GetNextLine(); if( name.IsEmpty() ) { DISPLAY_LOAD_ERROR( "Error loading workbook: Line %d is empty." ); file.Close(); return false; } param = file.GetNextLine(); addTrace( name ); SIM_PLOT_PANEL* plotPanel = GetCurrentPlot(); TRACE* trace = plotPanel ? plotPanel->GetTrace( name ) : nullptr; if( version >= 4 && trace ) { auto addCursor = []( int aCursorId, SIM_PLOT_PANEL* aPlotPanel, TRACE* aTrace, double x ) { CURSOR* cursor = new CURSOR( aTrace, aPlotPanel ); mpWindow* win = aPlotPanel->GetPlotWin(); cursor->SetName( aTrace->GetName() ); cursor->SetPen( wxPen( aTrace->GetTraceColour() ) ); cursor->SetCoordX( x ); aTrace->SetCursor( aCursorId, cursor ); win->AddLayer( cursor ); }; wxArrayString items = wxSplit( param, '|' ); for( const wxString& item : items ) { if( item.StartsWith( wxS( "rgb" ) ) ) { wxColour color; color.Set( item ); trace->SetTraceColour( color ); plotPanel->UpdateTraceStyle( trace ); } else if( item.StartsWith( wxS( "cursor1" ) ) ) { wxArrayString parts = wxSplit( item, ':' ); double val; if( parts.size() == 3 ) { parts[0].AfterFirst( '=' ).ToDouble( &val ); m_cursorFormats[0][0].FromString( parts[1] ); m_cursorFormats[0][1].FromString( parts[2] ); addCursor( 1, plotPanel, trace, val ); } } else if( item.StartsWith( wxS( "cursor2" ) ) ) { wxArrayString parts = wxSplit( item, ':' ); double val; if( parts.size() == 3 ) { parts[0].AfterFirst( '=' ).ToDouble( &val ); m_cursorFormats[1][0].FromString( parts[1] ); m_cursorFormats[1][1].FromString( parts[2] ); addCursor( 2, plotPanel, trace, val ); } } else if( item.StartsWith( wxS( "cursorD" ) ) ) { wxArrayString parts = wxSplit( item, ':' ); if( parts.size() == 3 ) { m_cursorFormats[2][0].FromString( parts[1] ); m_cursorFormats[2][1].FromString( parts[2] ); } } } plotPanel->UpdatePlotColors(); } } } long userDefinedSignalCount; long measurementCount; if( file.GetNextLine().ToLong( &userDefinedSignalCount ) ) { for( long i = 0; i < userDefinedSignalCount; ++i ) m_userDefinedSignals.push_back( file.GetNextLine() ); file.GetNextLine().ToLong( &measurementCount ); m_measurementsGrid->ClearRows(); m_measurementsGrid->AppendRows( (int) measurementCount + 1 /* empty row at end */ ); for( int row = 0; row < (int) measurementCount; ++row ) { m_measurementsGrid->SetCellValue( row, COL_MEASUREMENT, file.GetNextLine() ); m_measurementsGrid->SetCellValue( row, COL_MEASUREMENT_FORMAT, file.GetNextLine() ); } } LoadSimulator(); rebuildSignalsList(); rebuildSignalsGrid( m_filter->GetValue() ); updateSignalsGrid(); updateCursors(); file.Close(); wxFileName filename( aPath ); filename.MakeRelativeTo( Prj().GetProjectPath() ); // Remember the loaded workbook filename. m_simulator->Settings()->SetWorkbookFilename( filename.GetFullPath() ); updateTitle(); // Successfully loading a workbook does not count as modifying it. Clear the modified // flag after all the EVT_WORKBOOK_MODIFIED events have been processed. CallAfter( [=]() { m_workbookModified = false; } ); return true; } bool SIM_PLOT_FRAME::SaveWorkbook( const wxString& aPath ) { wxFileName filename = aPath; filename.SetExt( WorkbookFileExtension ); wxTextFile file( filename.GetFullPath() ); if( file.Exists() ) { if( !file.Open() ) return false; file.Clear(); } else { file.Create(); } file.AddLine( wxT( "version 4" ) ); file.AddLine( wxString::Format( wxT( "%llu" ), m_plotNotebook->GetPageCount() ) ); for( size_t i = 0; i < m_plotNotebook->GetPageCount(); i++ ) { const SIM_PANEL_BASE* basePanel = dynamic_cast( m_plotNotebook->GetPage( i ) ); if( !basePanel ) { file.AddLine( wxString::Format( wxT( "%llu" ), 0ull ) ); continue; } file.AddLine( wxString::Format( wxT( "%d" ), basePanel->GetType() ) ); wxString command = basePanel->GetSimCommand(); int options = basePanel->GetSimOptions(); if( options & NETLIST_EXPORTER_SPICE::OPTION_ADJUST_INCLUDE_PATHS ) command += wxT( "\n.kicad adjustpaths" ); if( options & NETLIST_EXPORTER_SPICE::OPTION_SAVE_ALL_VOLTAGES ) command += wxT( "\n.save all" ); if( options & NETLIST_EXPORTER_SPICE::OPTION_SAVE_ALL_CURRENTS ) command += wxT( "\n.probe alli" ); if( options & NETLIST_EXPORTER_SPICE::OPTION_SAVE_ALL_DISSIPATIONS ) command += wxT( "\n.probe allp" ); file.AddLine( EscapeString( command, CTX_LINE ) ); const SIM_PLOT_PANEL* plotPanel = dynamic_cast( basePanel ); if( !plotPanel ) { file.AddLine( wxString::Format( wxT( "%llu" ), 0ull ) ); continue; } file.AddLine( wxString::Format( wxT( "%llu" ), plotPanel->GetTraces().size() ) ); for( const auto& [name, trace] : plotPanel->GetTraces() ) { file.AddLine( wxString::Format( wxT( "%d" ), trace->GetType() ) ); file.AddLine( getTraceTitle( trace->GetName(), trace->GetType() ) ); wxString msg = COLOR4D( trace->GetTraceColour() ).ToCSSString(); if( CURSOR* cursor = trace->GetCursor( 1 ) ) { msg += wxString::Format( wxS( "|cursor1=%E:%s:%s" ), cursor->GetCoords().x, m_cursorFormats[0][0].ToString(), m_cursorFormats[0][1].ToString() ); } if( CURSOR* cursor = trace->GetCursor( 2 ) ) { msg += wxString::Format( wxS( "|cursor2=%E:%s:%s" ), cursor->GetCoords().x, m_cursorFormats[1][0].ToString(), m_cursorFormats[1][1].ToString() ); } if( trace->GetCursor( 1 ) || trace->GetCursor( 2 ) ) { msg += wxString::Format( wxS( "|cursorD:%s:%s" ), m_cursorFormats[2][0].ToString(), m_cursorFormats[2][1].ToString() ); } file.AddLine( msg ); } } file.AddLine( wxString::Format( wxT( "%llu" ), m_userDefinedSignals.size() ) ); for( const wxString& signal : m_userDefinedSignals ) file.AddLine( signal ); std::vector measurements; std::vector formats; for( int i = 0; i < m_measurementsGrid->GetNumberRows(); ++i ) { if( !m_measurementsGrid->GetCellValue( i, COL_MEASUREMENT ).IsEmpty() ) { measurements.push_back( m_measurementsGrid->GetCellValue( i, COL_MEASUREMENT ) ); formats.push_back( m_measurementsGrid->GetCellValue( i, COL_MEASUREMENT_FORMAT ) ); } } file.AddLine( wxString::Format( wxT( "%llu" ), measurements.size() ) ); for( size_t i = 0; i < measurements.size(); i++ ) { file.AddLine( measurements[i] ); file.AddLine( formats[i] ); } bool res = file.Write(); file.Close(); // Store the filename of the last saved workbook. if( res ) { filename.MakeRelativeTo( Prj().GetProjectPath() ); m_simulator->Settings()->SetWorkbookFilename( filename.GetFullPath() ); } m_workbookModified = false; updateTitle(); return res; } SIM_TRACE_TYPE SIM_PLOT_FRAME::getXAxisType( SIM_TYPE aType ) const { switch( aType ) { /// @todo SPT_LOG_FREQUENCY case ST_AC: return SPT_LIN_FREQUENCY; case ST_DC: return SPT_SWEEP; case ST_TRANSIENT: return SPT_TIME; default: wxFAIL_MSG( wxS( "Unhandled simulation type" ) ); return SPT_UNKNOWN; } } void SIM_PLOT_FRAME::ToggleDarkModePlots() { m_darkMode = !m_darkMode; // Rebuild the color list to plot traces SIM_PLOT_COLORS::FillDefaultColorList( m_darkMode ); // Now send changes to all SIM_PLOT_PANEL for( size_t page = 0; page < m_plotNotebook->GetPageCount(); page++ ) { wxWindow* curPage = m_plotNotebook->GetPage( page ); // ensure it is truly a plot panel and not the (zero plots) placeholder // which is only SIM_PLOT_PANEL_BASE SIM_PLOT_PANEL* panel = dynamic_cast( curPage ); if( panel ) panel->UpdatePlotColors(); } } void SIM_PLOT_FRAME::onPlotClose( wxAuiNotebookEvent& event ) { } void SIM_PLOT_FRAME::onPlotClosed( wxAuiNotebookEvent& event ) { CallAfter( [this]() { rebuildSignalsList(); rebuildSignalsGrid( m_filter->GetValue() ); updateCursors(); SIM_PANEL_BASE* panel = getCurrentPlotWindow(); if( !panel || panel->GetType() != ST_OP ) { SCHEMATIC& schematic = m_schematicFrame->Schematic(); schematic.ClearOperatingPoints(); m_schematicFrame->RefreshOperatingPointDisplay(); } } ); } void SIM_PLOT_FRAME::onPlotChanged( wxAuiNotebookEvent& event ) { rebuildSignalsList(); rebuildSignalsGrid( m_filter->GetValue() ); updateCursors(); } void SIM_PLOT_FRAME::onPlotDragged( wxAuiNotebookEvent& event ) { } void SIM_PLOT_FRAME::onNotebookModified( wxCommandEvent& event ) { m_workbookModified = true; updateTitle(); } bool SIM_PLOT_FRAME::EditSimCommand() { SIM_PANEL_BASE* plotPanelWindow = getCurrentPlotWindow(); DIALOG_SIM_COMMAND dlg( this, m_circuitModel, m_simulator->Settings() ); wxString errors; WX_STRING_REPORTER reporter( &errors ); if( !m_circuitModel->ReadSchematicAndLibraries( NETLIST_EXPORTER_SPICE::OPTION_DEFAULT_FLAGS, reporter ) ) { DisplayErrorMessage( this, _( "Errors during netlist generation; simulation aborted.\n\n" ) + errors ); return false; } if( m_plotNotebook->GetPageIndex( plotPanelWindow ) != wxNOT_FOUND ) { dlg.SetSimCommand( plotPanelWindow->GetSimCommand() ); dlg.SetSimOptions( plotPanelWindow->GetSimOptions() ); } else { dlg.SetSimOptions( NETLIST_EXPORTER_SPICE::OPTION_DEFAULT_FLAGS ); } if( dlg.ShowModal() == wxID_OK ) { wxString oldCommand; if( m_plotNotebook->GetPageIndex( plotPanelWindow ) != wxNOT_FOUND ) oldCommand = plotPanelWindow->GetSimCommand(); else oldCommand = wxString(); const wxString& newCommand = dlg.GetSimCommand(); int newOptions = dlg.GetSimOptions(); SIM_TYPE newSimType = NGSPICE_CIRCUIT_MODEL::CommandToSimType( newCommand ); if( !plotPanelWindow ) { m_circuitModel->SetSimCommandOverride( newCommand ); m_circuitModel->SetSimOptions( newOptions ); plotPanelWindow = NewPlotPanel( newCommand, newOptions ); } // If it is a new simulation type, open a new plot. For the DC sim, check if sweep // source type has changed (char 4 will contain 'v', 'i', 'r' or 't'. else if( plotPanelWindow->GetType() != newSimType || ( newSimType == ST_DC && oldCommand.Lower().GetChar( 4 ) != newCommand.Lower().GetChar( 4 ) ) ) { plotPanelWindow = NewPlotPanel( newCommand, newOptions ); } else { if( m_plotNotebook->GetPageIndex( plotPanelWindow ) == 0 ) m_circuitModel->SetSimCommandOverride( newCommand ); // Update simulation command in the current plot plotPanelWindow->SetSimCommand( newCommand ); plotPanelWindow->SetSimOptions( newOptions ); } m_workbookModified = true; m_simulator->Init(); return true; } return false; } bool SIM_PLOT_FRAME::canCloseWindow( wxCloseEvent& aEvent ) { if( m_workbookModified ) { wxFileName filename = m_simulator->Settings()->GetWorkbookFilename(); if( filename.GetName().IsEmpty() ) { if( Prj().GetProjectName().IsEmpty() ) filename.SetFullName( wxT( "noname.wbk" ) ); else filename.SetFullName( Prj().GetProjectName() + wxT( ".wbk" ) ); } return HandleUnsavedChanges( this, _( "Save changes to workbook?" ), [&]() -> bool { return SaveWorkbook( Prj().AbsolutePath( filename.GetFullName() ) ); } ); } return true; } void SIM_PLOT_FRAME::doCloseWindow() { if( m_simulator->IsRunning() ) m_simulator->Stop(); // Prevent memory leak on exit by deleting all simulation vectors m_simulator->Clean(); // Cancel a running simProbe or simTune tool m_schematicFrame->GetToolManager()->RunAction( ACTIONS::cancelInteractive ); SaveSettings( config() ); m_simulator->Settings() = nullptr; Destroy(); } void SIM_PLOT_FRAME::updateCursors() { SUPPRESS_GRID_CELL_EVENTS raii( this ); m_cursorsGrid->ClearRows(); SIM_PLOT_PANEL* plotPanel = GetCurrentPlot(); if( !plotPanel ) return; // Update cursor values CURSOR* cursor1 = nullptr; wxString cursor1Name; wxString cursor1Units; CURSOR* cursor2 = nullptr; wxString cursor2Name; wxString cursor2Units; auto getUnitsY = [&]( TRACE* aTrace ) -> wxString { if( ( aTrace->GetType() & SPT_AC_PHASE ) || ( aTrace->GetType() & SPT_CURRENT ) ) return plotPanel->GetUnitsY2(); else if( aTrace->GetType() & SPT_POWER ) return plotPanel->GetUnitsY3(); else return plotPanel->GetUnitsY1(); }; auto getNameY = [&]( TRACE* aTrace ) -> wxString { if( ( aTrace->GetType() & SPT_AC_PHASE ) || ( aTrace->GetType() & SPT_CURRENT ) ) return plotPanel->GetLabelY2(); else if( aTrace->GetType() & SPT_POWER ) return plotPanel->GetLabelY3(); else return plotPanel->GetLabelY1(); }; auto formatValue = [this]( double aValue, int aCursorId, int aCol ) -> wxString { return SPICE_VALUE( aValue ).ToString( m_cursorFormats[ aCursorId ][ aCol ] ); }; for( const auto& [name, trace] : plotPanel->GetTraces() ) { if( CURSOR* cursor = trace->GetCursor( 1 ) ) { cursor1 = cursor; cursor1Name = getNameY( trace ); cursor1Units = getUnitsY( trace ); wxRealPoint coords = cursor->GetCoords(); int row = m_cursorsGrid->GetNumberRows(); m_cursorFormats[0][0].UpdateUnits( plotPanel->GetUnitsX() ); m_cursorFormats[0][1].UpdateUnits( cursor1Units ); m_cursorsGrid->AppendRows( 1 ); m_cursorsGrid->SetCellValue( row, COL_CURSOR_NAME, wxS( "1" ) ); m_cursorsGrid->SetCellValue( row, COL_CURSOR_SIGNAL, cursor->GetName() ); m_cursorsGrid->SetCellValue( row, COL_CURSOR_X, formatValue( coords.x, 0, 0 ) ); m_cursorsGrid->SetCellValue( row, COL_CURSOR_Y, formatValue( coords.y, 0, 1 ) ); break; } } for( const auto& [name, trace] : plotPanel->GetTraces() ) { if( CURSOR* cursor = trace->GetCursor( 2 ) ) { cursor2 = cursor; cursor2Name = getNameY( trace ); cursor2Units = getUnitsY( trace ); wxRealPoint coords = cursor->GetCoords(); int row = m_cursorsGrid->GetNumberRows(); m_cursorFormats[1][0].UpdateUnits( plotPanel->GetUnitsX() ); m_cursorFormats[1][1].UpdateUnits( cursor2Units ); m_cursorsGrid->AppendRows( 1 ); m_cursorsGrid->SetCellValue( row, COL_CURSOR_NAME, wxS( "2" ) ); m_cursorsGrid->SetCellValue( row, COL_CURSOR_SIGNAL, cursor->GetName() ); m_cursorsGrid->SetCellValue( row, COL_CURSOR_X, formatValue( coords.x, 1, 0 ) ); m_cursorsGrid->SetCellValue( row, COL_CURSOR_Y, formatValue( coords.y, 1, 1 ) ); break; } } if( cursor1 && cursor2 && cursor1Units == cursor2Units ) { wxRealPoint coords = cursor2->GetCoords() - cursor1->GetCoords(); wxString signal; m_cursorFormats[2][0].UpdateUnits( plotPanel->GetUnitsX() ); m_cursorFormats[2][1].UpdateUnits( cursor1Units ); if( cursor1->GetName() == cursor2->GetName() ) signal = wxString::Format( wxS( "%s[2 - 1]" ), cursor2->GetName() ); else signal = wxString::Format( wxS( "%s - %s" ), cursor2->GetName(), cursor1->GetName() ); m_cursorsGrid->AppendRows( 1 ); m_cursorsGrid->SetCellValue( 2, COL_CURSOR_NAME, _( "Diff" ) ); m_cursorsGrid->SetCellValue( 2, COL_CURSOR_SIGNAL, signal ); m_cursorsGrid->SetCellValue( 2, COL_CURSOR_X, formatValue( coords.x, 2, 0 ) ); m_cursorsGrid->SetCellValue( 2, COL_CURSOR_Y, formatValue( coords.y, 2, 1 ) ); } // Set up the labels m_cursorsGrid->SetColLabelValue( COL_CURSOR_X, plotPanel->GetLabelX() ); wxString valColName = _( "Value" ); if( !cursor1Name.IsEmpty() ) { if( cursor2Name.IsEmpty() || cursor1Name == cursor2Name ) valColName = cursor1Name; } else if( !cursor2Name.IsEmpty() ) { valColName = cursor2Name; } m_cursorsGrid->SetColLabelValue( COL_CURSOR_Y, valColName ); } void SIM_PLOT_FRAME::onCursorUpdate( wxCommandEvent& aEvent ) { updateCursors(); m_workbookModified = true; } void SIM_PLOT_FRAME::setupUIConditions() { EDA_BASE_FRAME::setupUIConditions(); ACTION_MANAGER* mgr = m_toolManager->GetActionManager(); wxASSERT( mgr ); auto showGridCondition = [this]( const SELECTION& aSel ) { SIM_PLOT_PANEL* plot = GetCurrentPlot(); return plot && plot->IsGridShown(); }; auto showLegendCondition = [this]( const SELECTION& aSel ) { SIM_PLOT_PANEL* plot = GetCurrentPlot(); return plot && plot->IsLegendShown(); }; auto showDottedCondition = [this]( const SELECTION& aSel ) { SIM_PLOT_PANEL* plot = GetCurrentPlot(); return plot && plot->GetDottedSecondary(); }; auto darkModePlotCondition = [this]( const SELECTION& aSel ) { return m_darkMode; }; auto simRunning = [this]( const SELECTION& aSel ) { return m_simulator && m_simulator->IsRunning(); }; auto simFinished = [this]( const SELECTION& aSel ) { return m_simFinished; }; auto havePlot = [this]( const SELECTION& aSel ) { return GetCurrentPlot() != nullptr; }; #define ENABLE( x ) ACTION_CONDITIONS().Enable( x ) #define CHECK( x ) ACTION_CONDITIONS().Check( x ) mgr->SetConditions( EE_ACTIONS::openWorkbook, ENABLE( SELECTION_CONDITIONS::ShowAlways ) ); mgr->SetConditions( EE_ACTIONS::saveWorkbook, ENABLE( SELECTION_CONDITIONS::ShowAlways ) ); mgr->SetConditions( EE_ACTIONS::saveWorkbookAs, ENABLE( SELECTION_CONDITIONS::ShowAlways ) ); mgr->SetConditions( EE_ACTIONS::exportPlotAsPNG, ENABLE( havePlot ) ); mgr->SetConditions( EE_ACTIONS::exportPlotAsCSV, ENABLE( havePlot ) ); mgr->SetConditions( EE_ACTIONS::toggleGrid, CHECK( showGridCondition ) ); mgr->SetConditions( EE_ACTIONS::toggleLegend, CHECK( showLegendCondition ) ); mgr->SetConditions( EE_ACTIONS::toggleDottedSecondary, CHECK( showDottedCondition ) ); mgr->SetConditions( EE_ACTIONS::toggleDarkModePlots, CHECK( darkModePlotCondition ) ); mgr->SetConditions( EE_ACTIONS::simCommand, ENABLE( SELECTION_CONDITIONS::ShowAlways ) ); mgr->SetConditions( EE_ACTIONS::runSimulation, ENABLE( !simRunning ) ); mgr->SetConditions( EE_ACTIONS::stopSimulation, ENABLE( simRunning ) ); mgr->SetConditions( EE_ACTIONS::simProbe, ENABLE( simFinished ) ); mgr->SetConditions( EE_ACTIONS::simTune, ENABLE( simFinished ) ); mgr->SetConditions( EE_ACTIONS::showNetlist, ENABLE( SELECTION_CONDITIONS::ShowAlways ) ); #undef CHECK #undef ENABLE } void SIM_PLOT_FRAME::onSimStarted( wxCommandEvent& aEvent ) { SetCursor( wxCURSOR_ARROWWAIT ); } void SIM_PLOT_FRAME::onSimFinished( wxCommandEvent& aEvent ) { SetCursor( wxCURSOR_ARROW ); SIM_TYPE simType = m_circuitModel->GetSimType(); if( simType == ST_UNKNOWN ) return; SIM_PANEL_BASE* plotPanelWindow = getCurrentPlotWindow(); if( !plotPanelWindow || plotPanelWindow->GetType() != simType ) { plotPanelWindow = NewPlotPanel( m_circuitModel->GetSimCommand(), m_circuitModel->GetSimOptions() ); } // Sometimes (for instance with a directive like wrdata my_file.csv "my_signal") // the simulator is in idle state (simulation is finished), but still running, during // the time the file is written. So gives a slice of time to fully finish the work: if( m_simulator->IsRunning() ) { int max_time = 40; // For a max timeout = 2s do { wxMilliSleep( 50 ); wxYield(); if( max_time ) max_time--; } while( max_time && m_simulator->IsRunning() ); } // Is a warning message useful if the simulatior is still running? m_simFinished = true; applyUserDefinedSignals(); rebuildSignalsList(); SCHEMATIC& schematic = m_schematicFrame->Schematic(); schematic.ClearOperatingPoints(); // If there are any signals plotted, update them if( SIM_PANEL_BASE::IsPlottable( simType ) ) { SIM_PLOT_PANEL* plotPanel = dynamic_cast( plotPanelWindow ); wxCHECK_RET( plotPanel, wxT( "not a SIM_PLOT_PANEL" ) ); struct TRACE_DESC { wxString m_name; ///< Name of the measured SPICE vector wxString m_title; ///< User-friendly signal name SIM_TRACE_TYPE m_type; ///< Type of the signal bool m_current; }; std::vector placeholders; // Get information about all the traces on the plot; update those that are still in // the signals list and remove any that aren't for( const auto& [name, trace] : plotPanel->GetTraces() ) { struct TRACE_DESC placeholder; placeholder.m_name = trace->GetName(); placeholder.m_title = getTraceTitle( trace->GetName(), trace->GetType() ); placeholder.m_type = trace->GetType(); placeholder.m_current = false; for( const wxString& signal : m_signals ) { if( getTraceName( signal ) == placeholder.m_title ) { placeholder.m_current = true; break; } } placeholders.push_back( placeholder ); } for( const struct TRACE_DESC& placeholder : placeholders ) { if( placeholder.m_current ) updateTrace( placeholder.m_name, placeholder.m_type, plotPanel ); else removeTrace( placeholder.m_name ); } rebuildSignalsGrid( m_filter->GetValue() ); updateSignalsGrid(); plotPanel->GetPlotWin()->UpdateAll(); plotPanel->ResetScales(); } else if( simType == ST_OP ) { m_simConsole->AppendText( _( "\n\nSimulation results:\n\n" ) ); m_simConsole->SetInsertionPointEnd(); for( const std::string& vec : m_simulator->AllPlots() ) { std::vector val_list = m_simulator->GetRealPlot( vec, 1 ); if( val_list.size() == 0 ) // The list of values can be empty! continue; wxString value = SPICE_VALUE( val_list.at( 0 ) ).ToSpiceString(); wxString msg; wxString signal; SIM_TRACE_TYPE type = m_circuitModel->VectorToSignal( vec, signal ); const size_t tab = 25; //characters size_t padding = ( signal.length() < tab ) ? ( tab - signal.length() ) : 1; value.Append( type == SPT_CURRENT ? wxS( "A" ) : wxS( "V" ) ); msg.Printf( wxT( "%s%s\n" ), ( signal + wxT( ":" ) ).Pad( padding, wxUniChar( ' ' ) ), value ); m_simConsole->AppendText( msg ); m_simConsole->SetInsertionPointEnd(); if( signal.StartsWith( wxS( "V(" ) ) || signal.StartsWith( wxS( "I(" ) ) ) signal = signal.SubString( 2, signal.Length() - 2 ); schematic.SetOperatingPoint( signal, val_list.at( 0 ) ); } } m_schematicFrame->RefreshOperatingPointDisplay(); for( int row = 0; row < m_measurementsGrid->GetNumberRows(); ++row ) UpdateMeasurement( row ); m_lastSimPlot = plotPanelWindow; } void SIM_PLOT_FRAME::onSimUpdate( wxCommandEvent& aEvent ) { static bool updateInProgress = false; // skip update when events are triggered too often and previous call didn't end yet if( updateInProgress ) return; updateInProgress = true; if( m_simulator->IsRunning() ) m_simulator->Stop(); if( getCurrentPlotWindow() != m_lastSimPlot ) { // We need to rerun simulation, as the simulator currently stores // results for another plot StartSimulation(); } else { std::unique_lock simulatorLock( m_simulator->GetMutex(), std::try_to_lock ); if( simulatorLock.owns_lock() ) { // Incremental update m_simConsole->Clear(); // Do not export netlist, it is already stored in the simulator applyTuners(); m_simulator->Run(); } else { DisplayErrorMessage( this, _( "Another simulation is already running." ) ); } } updateInProgress = false; } void SIM_PLOT_FRAME::onSimReport( wxCommandEvent& aEvent ) { m_simConsole->AppendText( aEvent.GetString() + "\n" ); m_simConsole->SetInsertionPointEnd(); } void SIM_PLOT_FRAME::onExit( wxCommandEvent& event ) { Kiway().OnKiCadExit(); } wxDEFINE_EVENT( EVT_SIM_UPDATE, wxCommandEvent ); wxDEFINE_EVENT( EVT_SIM_REPORT, wxCommandEvent ); wxDEFINE_EVENT( EVT_SIM_STARTED, wxCommandEvent ); wxDEFINE_EVENT( EVT_SIM_FINISHED, wxCommandEvent );