KiCad PCB EDA Suite
Loading...
Searching...
No Matches
simulator_frame_ui.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2016-2023 CERN
5 * Copyright (C) 2016-2024 KiCad Developers, see AUTHORS.txt for contributors.
6 * @author Tomasz Wlostowski <[email protected]>
7 * @author Maciej Suminski <[email protected]>
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 3
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, you may find one here:
21 * https://www.gnu.org/licenses/gpl-3.0.html
22 * or you may search the http://www.gnu.org website for the version 3 license,
23 * or you may write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25 */
26
27#include <memory>
28
29#include <fmt/format.h>
30#include <wx/wfstream.h>
31#include <wx/stdstream.h>
32#include <wx/debug.h>
33#include <wx/clipbrd.h>
34#include <wx/log.h>
35
37#include <sch_edit_frame.h>
38#include <confirm.h>
42#include <widgets/wx_grid.h>
43#include <grid_tricks.h>
44#include <eda_pattern_match.h>
45#include <string_utils.h>
46#include <pgm_base.h>
48#include <sim/simulator_frame.h>
49#include <sim/sim_plot_tab.h>
50#include <sim/spice_simulator.h>
53#include <eeschema_settings.h>
54#include "kiplatform/app.h"
55
56
58{
59 int res = (int) aFirst | (int) aSecond;
60
61 return (SIM_TRACE_TYPE) res;
62}
63
64
66{
72};
73
74
76{
81};
82
83
85{
89};
90
91
92enum
93{
103
107
108
110{
111public:
113 GRID_TRICKS( aGrid ),
114 m_parent( aParent ),
115 m_menuRow( 0 ),
116 m_menuCol( 0 )
117 {}
118
119protected:
120 void showPopupMenu( wxMenu& menu, wxGridEvent& aEvent ) override;
121 void doPopupSelection( wxCommandEvent& event ) override;
122
123protected:
127};
128
129
130void SIGNALS_GRID_TRICKS::showPopupMenu( wxMenu& menu, wxGridEvent& aEvent )
131{
132 m_menuRow = aEvent.GetRow();
133 m_menuCol = aEvent.GetCol();
134
136 {
137 if( !( m_grid->IsInSelection( m_menuRow, m_menuCol ) ) )
138 m_grid->ClearSelection();
139
140 m_grid->SetGridCursor( m_menuRow, m_menuCol );
141
142 if( SIM_TAB* panel = m_parent->GetCurrentSimTab() )
143 {
144 if( panel->GetSimType() == ST_TRAN || panel->GetSimType() == ST_AC
145 || panel->GetSimType() == ST_DC || panel->GetSimType() == ST_SP )
146 {
147 menu.Append( MYID_MEASURE_MIN, _( "Measure Min" ) );
148 menu.Append( MYID_MEASURE_MAX, _( "Measure Max" ) );
149 menu.Append( MYID_MEASURE_AVG, _( "Measure Average" ) );
150 menu.Append( MYID_MEASURE_RMS, _( "Measure RMS" ) );
151 menu.Append( MYID_MEASURE_PP, _( "Measure Peak-to-peak" ) );
152
153 if( panel->GetSimType() == ST_AC || panel->GetSimType() == ST_SP )
154 {
155 menu.Append( MYID_MEASURE_MIN_AT, _( "Measure Frequency of Min" ) );
156 menu.Append( MYID_MEASURE_MAX_AT, _( "Measure Frequency of Max" ) );
157 }
158 else
159 {
160 menu.Append( MYID_MEASURE_MIN_AT, _( "Measure Time of Min" ) );
161 menu.Append( MYID_MEASURE_MAX_AT, _( "Measure Time of Max" ) );
162 }
163
164 menu.Append( MYID_MEASURE_INTEGRAL, _( "Measure Integral" ) );
165
166 if( panel->GetSimType() == ST_TRAN )
167 {
168 menu.AppendSeparator();
169 menu.Append( MYID_FOURIER, _( "Perform Fourier Analysis..." ) );
170 }
171
172 menu.AppendSeparator();
173 menu.Append( GRIDTRICKS_ID_COPY, _( "Copy Signal Name" ) + "\tCtrl+C" );
174
175 m_grid->PopupMenu( &menu );
176 }
177 }
178 }
179}
180
181
182void SIGNALS_GRID_TRICKS::doPopupSelection( wxCommandEvent& event )
183{
184 std::vector<wxString> signals;
185
186 wxGridCellCoordsArray cells1 = m_grid->GetSelectionBlockTopLeft();
187 wxGridCellCoordsArray cells2 = m_grid->GetSelectionBlockBottomRight();
188
189 for( size_t i = 0; i < cells1.Count(); i++ )
190 {
191 if( cells1[i].GetCol() == COL_SIGNAL_NAME )
192 {
193 for( int j = cells1[i].GetRow(); j < cells2[i].GetRow() + 1; j++ )
194 {
195 signals.push_back( m_grid->GetCellValue( j, cells1[i].GetCol() ) );
196 }
197 }
198 }
199
200 wxGridCellCoordsArray cells3 = m_grid->GetSelectedCells();
201
202 for( size_t i = 0; i < cells3.Count(); i++ )
203 {
204 if( cells3[i].GetCol() == COL_SIGNAL_NAME )
205 signals.push_back( m_grid->GetCellValue( cells3[i].GetRow(), cells3[i].GetCol() ) );
206 }
207
208 if( signals.size() < 1 )
209 signals.push_back( m_grid->GetCellValue( m_menuRow, m_menuCol ) );
210
211 auto addMeasurement =
212 [this]( const wxString& cmd, wxString signal )
213 {
214 if( signal.EndsWith( _( " (phase)" ) ) )
215 return;
216
217 if( signal.EndsWith( _( " (gain)" ) ) || signal.EndsWith( _( " (amplitude)" ) ) )
218 {
219 signal = signal.Left( signal.length() - 7 );
220
221 if( signal.Upper().StartsWith( wxS( "V(" ) ) )
222 signal = wxS( "vdb" ) + signal.Mid( 1 );
223 }
224
225 m_parent->AddMeasurement( cmd + wxS( " " ) + signal );
226 };
227
228 if( event.GetId() == MYID_MEASURE_MIN )
229 {
230 for( const wxString& signal : signals )
231 addMeasurement( wxS( "MIN" ), signal );
232 }
233 else if( event.GetId() == MYID_MEASURE_MAX )
234 {
235 for( const wxString& signal : signals )
236 addMeasurement( wxS( "MAX" ), signal );
237 }
238 else if( event.GetId() == MYID_MEASURE_AVG )
239 {
240 for( const wxString& signal : signals )
241 addMeasurement( wxS( "AVG" ), signal );
242 }
243 else if( event.GetId() == MYID_MEASURE_RMS )
244 {
245 for( const wxString& signal : signals )
246 addMeasurement( wxS( "RMS" ), signal );
247 }
248 else if( event.GetId() == MYID_MEASURE_PP )
249 {
250 for( const wxString& signal : signals )
251 addMeasurement( wxS( "PP" ), signal );
252 }
253 else if( event.GetId() == MYID_MEASURE_MIN_AT )
254 {
255 for( const wxString& signal : signals )
256 addMeasurement( wxS( "MIN_AT" ), signal );
257 }
258 else if( event.GetId() == MYID_MEASURE_MAX_AT )
259 {
260 for( const wxString& signal : signals )
261 addMeasurement( wxS( "MAX_AT" ), signal );
262 }
263 else if( event.GetId() == MYID_MEASURE_INTEGRAL )
264 {
265 for( const wxString& signal : signals )
266 addMeasurement( wxS( "INTEG" ), signal );
267 }
268 else if( event.GetId() == MYID_FOURIER )
269 {
270 wxString title;
271 wxString fundamental = wxT( "1K" );
272
273 if( signals.size() == 1 )
274 title.Printf( _( "Fourier Analysis of %s" ), signals[0] );
275 else
276 title = _( "Fourier Analyses of Multiple Signals" );
277
278 WX_TEXT_ENTRY_DIALOG dlg( m_parent, _( "Fundamental frequency:" ), title, fundamental );
279
280 if( dlg.ShowModal() != wxID_OK )
281 return;
282
283 if( !dlg.GetValue().IsEmpty() )
284 fundamental = dlg.GetValue();
285
286 for( const wxString& signal : signals )
287 m_parent->DoFourier( signal, fundamental );
288 }
289 else if( event.GetId() == GRIDTRICKS_ID_COPY )
290 {
291 wxLogNull doNotLog; // disable logging of failed clipboard actions
292 wxString txt;
293
294 for( const wxString& signal : signals )
295 {
296 if( !txt.IsEmpty() )
297 txt += '\r';
298
299 txt += signal;
300 }
301
302 if( wxTheClipboard->Open() )
303 {
304 wxTheClipboard->SetData( new wxTextDataObject( txt ) );
305 wxTheClipboard->Flush(); // Allow data to be available after closing KiCad
306 wxTheClipboard->Close();
307 }
308 }
309}
310
311
313{
314public:
316 GRID_TRICKS( aGrid ),
317 m_parent( aParent ),
318 m_menuRow( 0 ),
319 m_menuCol( 0 )
320 {}
321
322protected:
323 void showPopupMenu( wxMenu& menu, wxGridEvent& aEvent ) override;
324 void doPopupSelection( wxCommandEvent& event ) override;
325
326protected:
330};
331
332
333void CURSORS_GRID_TRICKS::showPopupMenu( wxMenu& menu, wxGridEvent& aEvent )
334{
335 m_menuRow = aEvent.GetRow();
336 m_menuCol = aEvent.GetCol();
337
339 {
340 wxString msg = m_grid->GetColLabelValue( m_menuCol );
341
342 menu.Append( MYID_FORMAT_VALUE, wxString::Format( _( "Format %s..." ), msg ) );
343 menu.AppendSeparator();
344 }
345
346 GRID_TRICKS::showPopupMenu( menu, aEvent );
347}
348
349
350void CURSORS_GRID_TRICKS::doPopupSelection( wxCommandEvent& event )
351{
352 auto getSignalName =
353 [this]( int row ) -> wxString
354 {
355 wxString signal = m_grid->GetCellValue( row, COL_CURSOR_SIGNAL );
356
357 if( signal.EndsWith( "[2 - 1]" ) )
358 signal = signal.Left( signal.length() - 7 );
359
360 return signal;
361 };
362
363 if( event.GetId() == MYID_FORMAT_VALUE )
364 {
365 int axis = m_menuCol - COL_CURSOR_X;
367 DIALOG_SIM_FORMAT_VALUE formatDialog( m_parent, &format );
368
369 if( formatDialog.ShowModal() == wxID_OK )
370 {
371 for( int row = 0; row < m_grid->GetNumberRows(); ++row )
372 {
373 if( getSignalName( row ) == getSignalName( m_menuRow ) )
374 m_parent->SetCursorFormat( row, axis, format );
375 }
376 }
377 }
378 else
379 {
381 }
382}
383
384
386{
387public:
389 GRID_TRICKS( aGrid ),
390 m_parent( aParent ),
391 m_menuRow( 0 ),
392 m_menuCol( 0 )
393 {}
394
395protected:
396 void showPopupMenu( wxMenu& menu, wxGridEvent& aEvent ) override;
397 void doPopupSelection( wxCommandEvent& event ) override;
398
399protected:
403};
404
405
406void MEASUREMENTS_GRID_TRICKS::showPopupMenu( wxMenu& menu, wxGridEvent& aEvent )
407{
408 m_menuRow = aEvent.GetRow();
409 m_menuCol = aEvent.GetCol();
410
411 if( !( m_grid->IsInSelection( m_menuRow, m_menuCol ) ) )
412 m_grid->ClearSelection();
413
414 m_grid->SetGridCursor( m_menuRow, m_menuCol );
415
417 menu.Append( MYID_FORMAT_VALUE, _( "Format Value..." ) );
418
419 if( m_menuRow < ( m_grid->GetNumberRows() - 1 ) )
420 menu.Append( MYID_DELETE_MEASUREMENT, _( "Delete Measurement" ) );
421
422 menu.AppendSeparator();
423
424 GRID_TRICKS::showPopupMenu( menu, aEvent );
425}
426
427
429{
430 if( event.GetId() == MYID_FORMAT_VALUE )
431 {
433 DIALOG_SIM_FORMAT_VALUE formatDialog( m_parent, &format );
434
435 if( formatDialog.ShowModal() == wxID_OK )
436 {
440 }
441 }
442 else if( event.GetId() == MYID_DELETE_MEASUREMENT )
443 {
444 std::vector<int> measurements;
445
446 wxGridCellCoordsArray cells1 = m_grid->GetSelectionBlockTopLeft();
447 wxGridCellCoordsArray cells2 = m_grid->GetSelectionBlockBottomRight();
448
449 for( size_t i = 0; i < cells1.Count(); i++ )
450 {
451 if( cells1[i].GetCol() == COL_MEASUREMENT )
452 {
453 for( int j = cells1[i].GetRow(); j < cells2[i].GetRow() + 1; j++ )
454 measurements.push_back( j );
455 }
456 }
457
458 wxGridCellCoordsArray cells3 = m_grid->GetSelectedCells();
459
460 for( size_t i = 0; i < cells3.Count(); i++ )
461 {
462 if( cells3[i].GetCol() == COL_MEASUREMENT )
463 measurements.push_back( cells3[i].GetRow() );
464 }
465
466 if( measurements.size() < 1 )
467 measurements.push_back( m_menuRow );
468
469 // When deleting a row, we'll change the indexes.
470 // To avoid problems, we can start with the highest indexes.
471 sort( measurements.begin(), measurements.end(), std::greater<>() );
472
473 for( int row : measurements )
475
476 m_grid->ClearSelection();
477
479 }
480 else
481 {
483 }
484}
485
486
488{
489public:
491 m_frame( aFrame )
492 {
494 }
495
497 {
499 }
500
501private:
503};
504
505
506#define ID_SIM_REFRESH 10207
507#define REFRESH_INTERVAL 50 // 20 frames/second.
508
509
511 SCH_EDIT_FRAME* aSchematicFrame ) :
512 SIMULATOR_FRAME_UI_BASE( aSimulatorFrame ),
513 m_SuppressGridEvents( 0 ),
514 m_simulatorFrame( aSimulatorFrame ),
515 m_schematicFrame( aSchematicFrame ),
516 m_darkMode( true ),
517 m_plotNumber( 0 ),
518 m_refreshTimer( this, ID_SIM_REFRESH )
519{
520 // Get the previous size and position of windows:
522
523 m_filter->SetHint( _( "Filter" ) );
524
525 m_signalsGrid->wxGrid::SetLabelFont( KIUI::GetStatusFont( this ) );
526 m_cursorsGrid->wxGrid::SetLabelFont( KIUI::GetStatusFont( this ) );
527 m_measurementsGrid->wxGrid::SetLabelFont( KIUI::GetStatusFont( this ) );
528
529 m_signalsGrid->PushEventHandler( new SIGNALS_GRID_TRICKS( this, m_signalsGrid ) );
530 m_cursorsGrid->PushEventHandler( new CURSORS_GRID_TRICKS( this, m_cursorsGrid ) );
531 m_measurementsGrid->PushEventHandler( new MEASUREMENTS_GRID_TRICKS( this, m_measurementsGrid ) );
532
533 wxGridCellAttr* attr = new wxGridCellAttr;
534 attr->SetReadOnly();
535 m_signalsGrid->SetColAttr( COL_SIGNAL_NAME, attr );
536
537 attr = new wxGridCellAttr;
538 attr->SetReadOnly();
539 m_cursorsGrid->SetColAttr( COL_CURSOR_NAME, attr );
540
541 attr = new wxGridCellAttr;
542 attr->SetReadOnly();
543 m_cursorsGrid->SetColAttr( COL_CURSOR_SIGNAL, attr );
544
545 attr = new wxGridCellAttr;
546 attr->SetReadOnly();
547 m_cursorsGrid->SetColAttr( COL_CURSOR_Y, attr );
548
549 for( int cursorId = 0; cursorId < 3; ++cursorId )
550 {
551 m_cursorFormats[ cursorId ][ 0 ] = { 3, wxS( "~s" ) };
552 m_cursorFormats[ cursorId ][ 1 ] = { 3, wxS( "~V" ) };
553 }
554
555 attr = new wxGridCellAttr;
556 attr->SetReadOnly();
557 m_measurementsGrid->SetColAttr( COL_MEASUREMENT_VALUE, attr );
558
559 // Prepare the color list to plot traces
561
562 Bind( EVT_SIM_CURSOR_UPDATE, &SIMULATOR_FRAME_UI::onPlotCursorUpdate, this );
563
564 Bind( wxEVT_TIMER,
565 [&]( wxTimerEvent& aEvent )
566 {
567 OnSimRefresh( false );
568
569 if( m_simulatorFrame->GetSimulator()->IsRunning() )
570 m_refreshTimer.Start( REFRESH_INTERVAL, wxTIMER_ONE_SHOT );
571 },
572 m_refreshTimer.GetId() );
573
574#ifndef wxHAS_NATIVE_TABART
575 // Default non-native tab art has ugly gradients we don't want
576 m_plotNotebook->SetArtProvider( new wxAuiSimpleTabArt() );
577#endif
578}
579
580
582{
583 // Delete the GRID_TRICKS.
584 m_signalsGrid->PopEventHandler( true );
585 m_cursorsGrid->PopEventHandler( true );
586 m_measurementsGrid->PopEventHandler( true );
587}
588
589
591{
592 for( int ii = 0; ii < (int) m_plotNotebook->GetPageCount(); ++ii )
593 {
594 if( SIM_TAB* simTab = dynamic_cast<SIM_TAB*>( m_plotNotebook->GetPage( ii ) ) )
595 {
596 simTab->OnLanguageChanged();
597
598 wxString pageTitle( simulator()->TypeToName( simTab->GetSimType(), true ) );
599 pageTitle.Prepend( wxString::Format( _( "Analysis %u - " ), ii+1 /* 1-based */ ) );
600
601 m_plotNotebook->SetPageText( ii, pageTitle );
602 }
603 }
604
605 m_filter->SetHint( _( "Filter" ) );
606
607 m_signalsGrid->SetColLabelValue( COL_SIGNAL_NAME, _( "Signal" ) );
608 m_signalsGrid->SetColLabelValue( COL_SIGNAL_SHOW, _( "Plot" ) );
609 m_signalsGrid->SetColLabelValue( COL_SIGNAL_COLOR, _( "Color" ) );
610 m_signalsGrid->SetColLabelValue( COL_CURSOR_1, _( "Cursor 1" ) );
611 m_signalsGrid->SetColLabelValue( COL_CURSOR_2, _( "Cursor 2" ) );
612
613 m_cursorsGrid->SetColLabelValue( COL_CURSOR_NAME, _( "Cursor" ) );
614 m_cursorsGrid->SetColLabelValue( COL_CURSOR_SIGNAL, _( "Signal" ) );
615 m_cursorsGrid->SetColLabelValue( COL_CURSOR_X, _( "Time" ) );
616 m_cursorsGrid->SetColLabelValue( COL_CURSOR_Y, _( "Value" ) );
618
619 for( TUNER_SLIDER* tuner : m_tuners )
620 tuner->ShowChangedLanguage();
621}
622
623
625{
626 const EESCHEMA_SETTINGS::SIMULATOR& settings = aCfg->m_Simulator;
627
628 // Read subwindows sizes (should be > 0 )
634 m_darkMode = !settings.view.white_background;
635
636 m_preferences = settings.preferences;
637}
638
639
641{
643
644 settings.view.plot_panel_width = m_splitterLeftRight->GetSashPosition();
645 settings.view.plot_panel_height = m_splitterPlotAndConsole->GetSashPosition();
646 settings.view.signal_panel_height = m_splitterSignals->GetSashPosition();
647 settings.view.cursors_panel_height = m_splitterCursors->GetSashPosition();
648 settings.view.measurements_panel_height = m_splitterMeasurements->GetSashPosition();
649 settings.view.white_background = !m_darkMode;
650}
651
652
654{
655 m_preferences = aPrefs;
656
657 const std::size_t pageCount = m_plotNotebook->GetPageCount();
658 for( std::size_t i = 0; i < pageCount; ++i )
659 {
660 wxWindow* page = m_plotNotebook->GetPage( i );
661 auto simTab = dynamic_cast<SIM_TAB*>( page );
662 wxASSERT( simTab != nullptr );
663 simTab->ApplyPreferences( aPrefs );
664 }
665}
666
667
669{
670 if( !simulator()->Settings()->GetWorkbookFilename().IsEmpty() )
671 {
672 wxFileName filename = simulator()->Settings()->GetWorkbookFilename();
673 filename.SetPath( m_schematicFrame->Prj().GetProjectPath() );
674
675 if( !LoadWorkbook( filename.GetFullPath() ) )
676 simulator()->Settings()->SetWorkbookFilename( "" );
677 }
678 else if( m_simulatorFrame->LoadSimulator( wxEmptyString, 0 ) )
679 {
680 wxString schTextSimCommand = circuitModel()->GetSchTextSimCommand();
681
682 if( !schTextSimCommand.IsEmpty() )
683 {
684 SIM_TAB* simTab = NewSimTab( schTextSimCommand );
686 }
687
689 rebuildSignalsGrid( m_filter->GetValue() );
690 }
691}
692
693
695{
698
701
704
707
710}
711
712
713void sortSignals( std::vector<wxString>& signals )
714{
715 std::sort( signals.begin(), signals.end(),
716 []( const wxString& lhs, const wxString& rhs )
717 {
718 // Sort voltages first
719 if( lhs.Upper().StartsWith( 'V' ) && !rhs.Upper().StartsWith( 'V' ) )
720 return true;
721 else if( !lhs.Upper().StartsWith( 'V' ) && rhs.Upper().StartsWith( 'V' ) )
722 return false;
723
724 return StrNumCmp( lhs, rhs, true /* ignore case */ ) < 0;
725 } );
726}
727
728
730{
731 SUPPRESS_GRID_CELL_EVENTS raii( this );
732
734
735 SIM_PLOT_TAB* plotPanel = dynamic_cast<SIM_PLOT_TAB*>( GetCurrentSimTab() );
736
737 if( !plotPanel )
738 return;
739
740 SIM_TYPE simType = plotPanel->GetSimType();
741 std::vector<wxString> signals;
742
743 if( plotPanel->GetSimType() == ST_FFT )
744 {
745 wxStringTokenizer tokenizer( plotPanel->GetSimCommand(), wxT( " \t\r\n" ), wxTOKEN_STRTOK );
746
747 while( tokenizer.HasMoreTokens() && tokenizer.GetNextToken().Lower() != wxT( "fft" ) )
748 {};
749
750 while( tokenizer.HasMoreTokens() )
751 signals.emplace_back( tokenizer.GetNextToken() );
752 }
753 else
754 {
755 // NB: m_signals are already broken out into gain/phase, but m_userDefinedSignals are
756 // as the user typed them
757
758 for( const wxString& signal : m_signals )
759 signals.push_back( signal );
760
761 for( const auto& [ id, signal ] : m_userDefinedSignals )
762 {
763 if( simType == ST_AC )
764 {
765 signals.push_back( signal + _( " (gain)" ) );
766 signals.push_back( signal + _( " (phase)" ) );
767 }
768 else if( simType == ST_SP )
769 {
770 signals.push_back( signal + _( " (amplitude)" ) );
771 signals.push_back( signal + _( " (phase)" ) );
772 }
773 else
774 {
775 signals.push_back( signal );
776 }
777 }
778
779 sortSignals( signals );
780 }
781
782 if( aFilter.IsEmpty() )
783 aFilter = wxS( "*" );
784
785 EDA_COMBINED_MATCHER matcher( aFilter.Upper(), CTX_SIGNAL );
786 int row = 0;
787
788 for( const wxString& signal : signals )
789 {
790 if( matcher.Find( signal.Upper() ) )
791 {
792 int traceType = SPT_UNKNOWN;
793 wxString vectorName = vectorNameFromSignalName( plotPanel, signal, &traceType );
794 TRACE* trace = plotPanel->GetTrace( vectorName, traceType );
795
796 m_signalsGrid->AppendRows( 1 );
797 m_signalsGrid->SetCellValue( row, COL_SIGNAL_NAME, signal );
798
799 wxGridCellAttr* attr = new wxGridCellAttr;
800 attr->SetRenderer( new wxGridCellBoolRenderer() );
801 attr->SetReadOnly(); // not really; we delegate interactivity to GRID_TRICKS
802 attr->SetAlignment( wxALIGN_CENTER, wxALIGN_CENTER );
803 m_signalsGrid->SetAttr( row, COL_SIGNAL_SHOW, attr );
804
805 if( !trace )
806 {
807 attr = new wxGridCellAttr;
808 attr->SetReadOnly();
809 m_signalsGrid->SetAttr( row, COL_SIGNAL_COLOR, attr );
810 m_signalsGrid->SetCellValue( row, COL_SIGNAL_COLOR, wxEmptyString );
811
812 attr = new wxGridCellAttr;
813 attr->SetReadOnly();
814 m_signalsGrid->SetAttr( row, COL_CURSOR_1, attr );
815
816 attr = new wxGridCellAttr;
817 attr->SetReadOnly();
818 m_signalsGrid->SetAttr( row, COL_CURSOR_2, attr );
819 }
820 else
821 {
822 m_signalsGrid->SetCellValue( row, COL_SIGNAL_SHOW, wxS( "1" ) );
823
824 attr = new wxGridCellAttr;
825 attr->SetRenderer( new GRID_CELL_COLOR_RENDERER( this ) );
826 attr->SetEditor( new GRID_CELL_COLOR_SELECTOR( this, m_signalsGrid ) );
827 attr->SetAlignment( wxALIGN_CENTER, wxALIGN_CENTER );
828 m_signalsGrid->SetAttr( row, COL_SIGNAL_COLOR, attr );
829 KIGFX::COLOR4D color( trace->GetPen().GetColour() );
830 m_signalsGrid->SetCellValue( row, COL_SIGNAL_COLOR, color.ToCSSString() );
831
832 attr = new wxGridCellAttr;
833 attr->SetRenderer( new wxGridCellBoolRenderer() );
834 attr->SetReadOnly(); // not really; we delegate interactivity to GRID_TRICKS
835 attr->SetAlignment( wxALIGN_CENTER, wxALIGN_CENTER );
836 m_signalsGrid->SetAttr( row, COL_CURSOR_1, attr );
837 m_signalsGrid->SetCellValue( row, COL_CURSOR_1, trace->GetCursor( 1 ) ? "1" : "0" );
838
839 attr = new wxGridCellAttr;
840 attr->SetRenderer( new wxGridCellBoolRenderer() );
841 attr->SetReadOnly(); // not really; we delegate interactivity to GRID_TRICKS
842 attr->SetAlignment( wxALIGN_CENTER, wxALIGN_CENTER );
843 m_signalsGrid->SetAttr( row, COL_CURSOR_2, attr );
844 m_signalsGrid->SetCellValue( row, COL_CURSOR_2, trace->GetCursor( 2 ) ? "1" : "0" );
845 }
846
847 row++;
848 }
849 }
850}
851
852
854{
855 m_signals.clear();
856
857 int options = m_simulatorFrame->GetCurrentOptions();
859 wxString unconnected = wxString( wxS( "unconnected-(" ) );
860
861 if( simType == ST_UNKNOWN )
862 simType = ST_TRAN;
863
864 unconnected.Replace( '(', '_' ); // Convert to SPICE markup
865
866 auto addSignal =
867 [&]( const wxString& aSignalName )
868 {
869 if( simType == ST_AC )
870 {
871 m_signals.push_back( aSignalName + _( " (gain)" ) );
872 m_signals.push_back( aSignalName + _( " (phase)" ) );
873 }
874 else if( simType == ST_SP )
875 {
876 m_signals.push_back( aSignalName + _( " (amplitude)" ) );
877 m_signals.push_back( aSignalName + _( " (phase)" ) );
878 }
879 else
880 {
881 m_signals.push_back( aSignalName );
882 }
883 };
884
886 && ( simType == ST_TRAN || simType == ST_DC || simType == ST_AC || simType == ST_FFT) )
887 {
888 for( const wxString& net : circuitModel()->GetNets() )
889 {
890 // netnames are escaped (can contain "{slash}" for '/') Unscape them:
891 wxString netname = UnescapeString( net );
893
894 if( netname == "GND" || netname == "0" || netname.StartsWith( unconnected ) )
895 continue;
896
897 m_quotedNetnames[ netname ] = wxString::Format( wxS( "\"%s\"" ), netname );
898 addSignal( wxString::Format( wxS( "V(%s)" ), netname ) );
899 }
900 }
901
903 && ( simType == ST_TRAN || simType == ST_DC || simType == ST_AC ) )
904 {
905 for( const SPICE_ITEM& item : circuitModel()->GetItems() )
906 {
907 // Add all possible currents for the device.
908 for( const std::string& name : item.model->SpiceGenerator().CurrentNames( item ) )
909 addSignal( name );
910 }
911 }
912
914 && ( simType == ST_TRAN || simType == ST_DC ) )
915 {
916 for( const SPICE_ITEM& item : circuitModel()->GetItems() )
917 {
918 if( item.model->GetPinCount() >= 2 )
919 {
920 wxString name = item.model->SpiceGenerator().ItemName( item );
921 addSignal( wxString::Format( wxS( "P(%s)" ), name ) );
922 }
923 }
924 }
925
926 if( simType == ST_NOISE )
927 {
928 addSignal( wxS( "inoise_spectrum" ) );
929 addSignal( wxS( "onoise_spectrum" ) );
930 }
931
932 if( simType == ST_SP )
933 {
934 std::vector<std::string> portnums;
935
936 for( const SPICE_ITEM& item : circuitModel()->GetItems() )
937 {
938 wxString name = item.model->SpiceGenerator().ItemName( item );
939
940 // We are only looking for voltage sources in .SP mode
941 if( !name.StartsWith( "V" ) )
942 continue;
943
944 std::string portnum = "";
945
946 if( const SIM_MODEL::PARAM* portnum_param = item.model->FindParam( "portnum" ) )
947 portnum = SIM_VALUE::ToSpice( portnum_param->value );
948
949 if( portnum != "" )
950 portnums.push_back( portnum );
951 }
952
953 for( const std::string& portnum1 : portnums )
954 {
955 for( const std::string& portnum2 : portnums )
956 {
957 addSignal( wxString::Format( wxS( "S_%s_%s" ), portnum1, portnum2 ) );
958 }
959 }
960 }
961
962 // Add .SAVE and .PROBE directives
963 for( const wxString& directive : circuitModel()->GetDirectives() )
964 {
965 wxStringTokenizer directivesTokenizer( directive, wxT( "\r\n" ), wxTOKEN_STRTOK );
966
967 while( directivesTokenizer.HasMoreTokens() )
968 {
969 wxString line = directivesTokenizer.GetNextToken().Upper();
970 wxString directiveParams;
971
972 if( line.StartsWith( wxS( ".SAVE" ), &directiveParams )
973 || line.StartsWith( wxS( ".PROBE" ), &directiveParams ) )
974 {
975 wxStringTokenizer paramsTokenizer( directiveParams, wxT( " \t" ), wxTOKEN_STRTOK );
976
977 while( paramsTokenizer.HasMoreTokens() )
978 addSignal( paramsTokenizer.GetNextToken() );
979 }
980 }
981 }
982}
983
984
985SIM_TAB* SIMULATOR_FRAME_UI::NewSimTab( const wxString& aSimCommand )
986{
987 SIM_TAB* simTab = nullptr;
988 SIM_TYPE simType = SPICE_CIRCUIT_MODEL::CommandToSimType( aSimCommand );
989
990 if( SIM_TAB::IsPlottable( simType ) )
991 {
992 SIM_PLOT_TAB* panel = new SIM_PLOT_TAB( aSimCommand, m_plotNotebook );
993 simTab = panel;
995 }
996 else
997 {
998 simTab = new SIM_NOPLOT_TAB( aSimCommand, m_plotNotebook );
999 }
1000
1001 wxString pageTitle( simulator()->TypeToName( simType, true ) );
1002 pageTitle.Prepend( wxString::Format( _( "Analysis %u - " ), (unsigned int) ++m_plotNumber ) );
1003
1004 m_plotNotebook->AddPage( simTab, pageTitle, true );
1005
1006 return simTab;
1007}
1008
1009
1010void SIMULATOR_FRAME_UI::OnFilterText( wxCommandEvent& aEvent )
1011{
1012 rebuildSignalsGrid( m_filter->GetValue() );
1013}
1014
1015
1016void SIMULATOR_FRAME_UI::OnFilterMouseMoved( wxMouseEvent& aEvent )
1017{
1018 wxPoint pos = aEvent.GetPosition();
1019 wxRect ctrlRect = m_filter->GetScreenRect();
1020 int buttonWidth = ctrlRect.GetHeight(); // Presume buttons are square
1021
1022 if( m_filter->IsSearchButtonVisible() && pos.x < buttonWidth )
1023 SetCursor( wxCURSOR_ARROW );
1024 else if( m_filter->IsCancelButtonVisible() && pos.x > ctrlRect.GetWidth() - buttonWidth )
1025 SetCursor( wxCURSOR_ARROW );
1026 else
1027 SetCursor( wxCURSOR_IBEAM );
1028}
1029
1030
1031wxString vectorNameFromSignalId( int aUserDefinedSignalId )
1032{
1033 return wxString::Format( wxS( "user%d" ), aUserDefinedSignalId );
1034}
1035
1036
1042 const wxString& aSignalName,
1043 int* aTraceType )
1044{
1045 std::map<wxString, int> suffixes;
1046 suffixes[ _( " (amplitude)" ) ] = SPT_SP_AMP;
1047 suffixes[ _( " (gain)" ) ] = SPT_AC_GAIN;
1048 suffixes[ _( " (phase)" ) ] = SPT_AC_PHASE;
1049
1050 if( aTraceType )
1051 {
1052 if( aPlotTab && aPlotTab->GetSimType() == ST_NOISE )
1053 {
1054 if( getNoiseSource().Upper().StartsWith( 'I' ) )
1055 *aTraceType = SPT_CURRENT;
1056 else
1057 *aTraceType = SPT_VOLTAGE;
1058 }
1059 else
1060 {
1061 wxUniChar firstChar = aSignalName.Upper()[0];
1062
1063 if( firstChar == 'V' )
1064 *aTraceType = SPT_VOLTAGE;
1065 else if( firstChar == 'I' )
1066 *aTraceType = SPT_CURRENT;
1067 else if( firstChar == 'P' )
1068 *aTraceType = SPT_POWER;
1069 }
1070 }
1071
1072 wxString suffix;
1073 wxString name = aSignalName;
1074
1075 for( const auto& [ candidate, type ] : suffixes )
1076 {
1077 if( name.EndsWith( candidate ) )
1078 {
1079 name = name.Left( name.Length() - candidate.Length() );
1080
1081 if( aTraceType )
1082 *aTraceType |= type;
1083
1084 break;
1085 }
1086 }
1087
1088 for( const auto& [ id, signal ] : m_userDefinedSignals )
1089 {
1090 if( name == signal )
1091 return vectorNameFromSignalId( id );
1092 }
1093
1094 return name;
1095};
1096
1097
1099{
1100 if( m_SuppressGridEvents > 0 )
1101 return;
1102
1103 SIM_PLOT_TAB* plotTab = dynamic_cast<SIM_PLOT_TAB*>( GetCurrentSimTab() );
1104
1105 if( !plotTab )
1106 return;
1107
1108 int row = aEvent.GetRow();
1109 int col = aEvent.GetCol();
1110 wxString text = m_signalsGrid->GetCellValue( row, col );
1111 wxString signalName = m_signalsGrid->GetCellValue( row, COL_SIGNAL_NAME );
1112 int traceType = SPT_UNKNOWN;
1113 wxString vectorName = vectorNameFromSignalName( plotTab, signalName, &traceType );
1114
1115 if( col == COL_SIGNAL_SHOW )
1116 {
1117 if( text == wxS( "1" ) )
1118 updateTrace( vectorName, traceType, plotTab );
1119 else
1120 plotTab->DeleteTrace( vectorName, traceType );
1121
1122 plotTab->GetPlotWin()->UpdateAll();
1123
1124 // Update enabled/visible states of other controls
1127 OnModify();
1128 }
1129 else if( col == COL_SIGNAL_COLOR )
1130 {
1131 KIGFX::COLOR4D color( m_signalsGrid->GetCellValue( row, COL_SIGNAL_COLOR ) );
1132 TRACE* trace = plotTab->GetTrace( vectorName, traceType );
1133
1134 if( trace )
1135 {
1136 trace->SetTraceColour( color.ToColour() );
1137 plotTab->UpdateTraceStyle( trace );
1138 plotTab->UpdatePlotColors();
1139 OnModify();
1140 }
1141 }
1142 else if( col == COL_CURSOR_1 || col == COL_CURSOR_2 )
1143 {
1144 for( int ii = 0; ii < m_signalsGrid->GetNumberRows(); ++ii )
1145 {
1146 signalName = m_signalsGrid->GetCellValue( ii, COL_SIGNAL_NAME );
1147 vectorName = vectorNameFromSignalName( plotTab, signalName, &traceType );
1148
1149 int id = col == COL_CURSOR_1 ? 1 : 2;
1150 bool enable = ii == row && text == wxS( "1" );
1151
1152 plotTab->EnableCursor( vectorName, traceType, id, enable, signalName );
1153 OnModify();
1154 }
1155
1156 // Update cursor checkboxes (which are really radio buttons)
1158 }
1159}
1160
1161
1163{
1164 if( m_SuppressGridEvents > 0 )
1165 return;
1166
1167 SIM_PLOT_TAB* plotTab = dynamic_cast<SIM_PLOT_TAB*>( GetCurrentSimTab() );
1168
1169 if( !plotTab )
1170 return;
1171
1172 int row = aEvent.GetRow();
1173 int col = aEvent.GetCol();
1174 wxString text = m_cursorsGrid->GetCellValue( row, col );
1175 wxString cursorName = m_cursorsGrid->GetCellValue( row, COL_CURSOR_NAME );
1176
1177 if( col == COL_CURSOR_X )
1178 {
1179 CURSOR* cursor1 = nullptr;
1180 CURSOR* cursor2 = nullptr;
1181
1182 for( const auto& [name, trace] : plotTab->GetTraces() )
1183 {
1184 if( CURSOR* cursor = trace->GetCursor( 1 ) )
1185 cursor1 = cursor;
1186
1187 if( CURSOR* cursor = trace->GetCursor( 2 ) )
1188 cursor2 = cursor;
1189 }
1190
1191 double value = SPICE_VALUE( text ).ToDouble();
1192
1193 if( cursorName == wxS( "1" ) && cursor1 )
1194 cursor1->SetCoordX( value );
1195 else if( cursorName == wxS( "2" ) && cursor2 )
1196 cursor2->SetCoordX( value );
1197 else if( cursorName == _( "Diff" ) && cursor1 && cursor2 )
1198 cursor2->SetCoordX( cursor1->GetCoords().x + value );
1199
1201 OnModify();
1202 }
1203 else
1204 {
1205 wxFAIL_MSG( wxT( "All other columns are supposed to be read-only!" ) );
1206 }
1207}
1208
1209
1211{
1212 SPICE_VALUE_FORMAT result;
1213 result.FromString( m_measurementsGrid->GetCellValue( aRow, COL_MEASUREMENT_FORMAT ) );
1214 return result;
1215}
1216
1217
1219{
1220 m_measurementsGrid->SetCellValue( aRow, COL_MEASUREMENT_FORMAT, aFormat.ToString() );
1221}
1222
1223
1225{
1226 if( aRow < ( m_measurementsGrid->GetNumberRows() - 1 ) )
1227 m_measurementsGrid->DeleteRows( aRow, 1 );
1228}
1229
1230
1232{
1233 SIM_PLOT_TAB* plotTab = dynamic_cast<SIM_PLOT_TAB*>( GetCurrentSimTab() );
1234
1235 if( !plotTab )
1236 return;
1237
1238 int row = aEvent.GetRow();
1239 int col = aEvent.GetCol();
1240 wxString text = m_measurementsGrid->GetCellValue( row, col );
1241
1242 if( col == COL_MEASUREMENT )
1243 {
1244 UpdateMeasurement( row );
1246 OnModify();
1247 }
1248 else
1249 {
1250 wxFAIL_MSG( wxT( "All other columns are supposed to be read-only!" ) );
1251 }
1252
1253 // Always leave a single empty row for type-in
1254
1255 int rowCount = (int) m_measurementsGrid->GetNumberRows();
1256 int emptyRows = 0;
1257
1258 for( row = rowCount - 1; row >= 0; row-- )
1259 {
1260 if( m_measurementsGrid->GetCellValue( row, COL_MEASUREMENT ).IsEmpty() )
1261 emptyRows++;
1262 else
1263 break;
1264 }
1265
1266 if( emptyRows > 1 )
1267 {
1268 int killRows = emptyRows - 1;
1269 m_measurementsGrid->DeleteRows( rowCount - killRows, killRows );
1270 }
1271 else if( emptyRows == 0 )
1272 {
1273 m_measurementsGrid->AppendRows( 1 );
1274 }
1275}
1276
1277
1278void SIMULATOR_FRAME_UI::OnUpdateUI( wxUpdateUIEvent& event )
1279{
1280 if( SIM_PLOT_TAB* plotTab = dynamic_cast<SIM_PLOT_TAB*>( GetCurrentSimTab() ) )
1281 {
1282 if( plotTab->GetLegendPosition() != plotTab->m_LastLegendPosition )
1283 {
1284 plotTab->m_LastLegendPosition = plotTab->GetLegendPosition();
1285 OnModify();
1286 }
1287 }
1288}
1289
1290
1306{
1307 static wxRegEx measureParamsRegEx( wxT( "^"
1308 " *"
1309 "([a-zA-Z_]+)"
1310 " +"
1311 "([a-zA-Z]*)\\(([^\\)]+)\\)" ) );
1312
1313 SIM_PLOT_TAB* plotTab = dynamic_cast<SIM_PLOT_TAB*>( GetCurrentSimTab() );
1314
1315 if( !plotTab )
1316 return;
1317
1318 wxString text = m_measurementsGrid->GetCellValue( aRow, COL_MEASUREMENT );
1319
1320 if( text.IsEmpty() )
1321 {
1322 m_measurementsGrid->SetCellValue( aRow, COL_MEASUREMENT_VALUE, wxEmptyString );
1323 return;
1324 }
1325
1326 wxString simType = simulator()->TypeToName( plotTab->GetSimType(), true );
1327 wxString resultName = wxString::Format( wxS( "meas_result_%u" ), aRow );
1328 wxString result = wxS( "?" );
1329
1330 if( measureParamsRegEx.Matches( text ) )
1331 {
1332 wxString func = measureParamsRegEx.GetMatch( text, 1 ).Upper();
1333 wxString signalType = measureParamsRegEx.GetMatch( text, 2 ).Upper();
1334 wxString deviceName = measureParamsRegEx.GetMatch( text, 3 );
1335 wxString units;
1337
1338 if( signalType.EndsWith( wxS( "DB" ) ) )
1339 {
1340 units = wxS( "dB" );
1341 }
1342 else if( signalType.StartsWith( 'I' ) )
1343 {
1344 units = wxS( "A" );
1345 }
1346 else if( signalType.StartsWith( 'P' ) )
1347 {
1348 units = wxS( "W" );
1349 // Our syntax is different from ngspice for power signals
1350 text = func + " " + deviceName + ":power";
1351 }
1352 else
1353 {
1354 units = wxS( "V" );
1355 }
1356
1357 if( func.EndsWith( wxS( "_AT" ) ) )
1358 {
1359 if( plotTab->GetSimType() == ST_AC || plotTab->GetSimType() == ST_SP )
1360 units = wxS( "Hz" );
1361 else
1362 units = wxS( "s" );
1363 }
1364 else if( func.StartsWith( wxS( "INTEG" ) ) )
1365 {
1366 switch( plotTab->GetSimType() )
1367 {
1368 case ST_TRAN:
1369 if ( signalType.StartsWith( 'P' ) )
1370 units = wxS( "J" );
1371 else
1372 units += wxS( ".s" );
1373
1374 break;
1375
1376 case ST_AC:
1377 case ST_SP:
1378 case ST_DISTO:
1379 case ST_NOISE:
1380 case ST_FFT:
1381 case ST_SENS: // If there is a vector, it is frequency
1382 units += wxS( "·Hz" );
1383 break;
1384
1385 case ST_DC: // Could be a lot of things : V, A, deg C, ohm, ...
1386 case ST_OP: // There is no vector for integration
1387 case ST_PZ: // There is no vector for integration
1388 case ST_TF: // There is no vector for integration
1389 default:
1390 units += wxS( "·?" );
1391 break;
1392 }
1393 }
1394
1395 fmt.UpdateUnits( units );
1396 SetMeasureFormat( aRow, fmt );
1397
1399 }
1400
1402 {
1403 wxString cmd = wxString::Format( wxS( "meas %s %s %s" ), simType, resultName, text );
1404 simulator()->Command( "echo " + cmd.ToStdString() );
1405 simulator()->Command( cmd.ToStdString() );
1406
1407 std::vector<double> resultVec = simulator()->GetGainVector( resultName.ToStdString() );
1408
1409 if( resultVec.size() > 0 )
1410 result = SPICE_VALUE( resultVec[0] ).ToString( GetMeasureFormat( aRow ) );
1411 }
1412
1413 m_measurementsGrid->SetCellValue( aRow, COL_MEASUREMENT_VALUE, result );
1414}
1415
1416
1417void SIMULATOR_FRAME_UI::AddTuner( const SCH_SHEET_PATH& aSheetPath, SCH_SYMBOL* aSymbol )
1418{
1419 SIM_PLOT_TAB* plotTab = dynamic_cast<SIM_PLOT_TAB*>( GetCurrentSimTab() );
1420
1421 if( !plotTab )
1422 return;
1423
1424 wxString ref = aSymbol->GetRef( &aSheetPath );
1425
1426 // Do not add multiple instances for the same component.
1427 for( TUNER_SLIDER* tuner : m_tuners )
1428 {
1429 if( tuner->GetSymbolRef() == ref )
1430 return;
1431 }
1432
1433 const SPICE_ITEM* item = GetExporter()->FindItem( ref );
1434
1435 // Do nothing if the symbol is not tunable.
1436 if( !item || !item->model->GetTunerParam() )
1437 return;
1438
1439 try
1440 {
1441 TUNER_SLIDER* tuner = new TUNER_SLIDER( this, m_panelTuners, aSheetPath, aSymbol );
1442 m_sizerTuners->Add( tuner );
1443 m_tuners.push_back( tuner );
1444 m_panelTuners->Layout();
1445 OnModify();
1446 }
1447 catch( const KI_PARAM_ERROR& e )
1448 {
1449 DisplayErrorMessage( nullptr, e.What() );
1450 }
1451}
1452
1453
1454void SIMULATOR_FRAME_UI::UpdateTunerValue( const SCH_SHEET_PATH& aSheetPath, const KIID& aSymbol,
1455 const wxString& aRef, const wxString& aValue )
1456{
1457 SCH_ITEM* item = aSheetPath.GetItem( aSymbol );
1458 SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>( item );
1459
1460 if( !symbol )
1461 {
1462 DisplayErrorMessage( this, _( "Could not apply tuned value(s):" ) + wxS( " " )
1463 + wxString::Format( _( "%s not found" ), aRef ) );
1464 return;
1465 }
1466
1467 NULL_REPORTER devnull;
1468 SIM_LIB_MGR mgr( &m_schematicFrame->Prj() );
1469 SIM_MODEL& model = mgr.CreateModel( &aSheetPath, *symbol, devnull ).model;
1470
1471 const SIM_MODEL::PARAM* tunerParam = model.GetTunerParam();
1472
1473 if( !tunerParam )
1474 {
1475 DisplayErrorMessage( this, _( "Could not apply tuned value(s):" ) + wxS( " " )
1476 + wxString::Format( _( "%s is not tunable" ), aRef ) );
1477 return;
1478 }
1479
1480 model.SetParamValue( tunerParam->info.name, std::string( aValue.ToUTF8() ) );
1481 model.WriteFields( symbol->GetFields() );
1482
1483 m_schematicFrame->UpdateItem( symbol, false, true );
1485}
1486
1487
1489{
1490 m_tuners.remove( aTuner );
1491 aTuner->Destroy();
1492 m_panelTuners->Layout();
1493 OnModify();
1494}
1495
1496
1497void SIMULATOR_FRAME_UI::AddMeasurement( const wxString& aCmd )
1498{
1499 // -1 because the last one is for user input
1500 for( int i = 0; i < m_measurementsGrid->GetNumberRows(); i++ )
1501 {
1502 if ( m_measurementsGrid->GetCellValue( i, COL_MEASUREMENT ) == aCmd )
1503 return; // Don't create duplicates
1504 }
1505
1506 SIM_PLOT_TAB* plotTab = dynamic_cast<SIM_PLOT_TAB*>( GetCurrentSimTab() );
1507
1508 if( !plotTab )
1509 return;
1510
1511 wxString simType = simulator()->TypeToName( plotTab->GetSimType(), true );
1512 int row;
1513
1514 for( row = 0; row < m_measurementsGrid->GetNumberRows(); ++row )
1515 {
1516 if( m_measurementsGrid->GetCellValue( row, COL_MEASUREMENT ).IsEmpty() )
1517 break;
1518 }
1519
1520 if( !m_measurementsGrid->GetCellValue( row, COL_MEASUREMENT ).IsEmpty() )
1521 {
1522 m_measurementsGrid->AppendRows( 1 );
1523 row = m_measurementsGrid->GetNumberRows() - 1;
1524 }
1525
1526 m_measurementsGrid->SetCellValue( row, COL_MEASUREMENT, aCmd );
1527
1528 UpdateMeasurement( row );
1530 OnModify();
1531
1532 // Always leave at least one empty row for type-in:
1533 row = m_measurementsGrid->GetNumberRows() - 1;
1534
1535 if( !m_measurementsGrid->GetCellValue( row, COL_MEASUREMENT ).IsEmpty() )
1536 m_measurementsGrid->AppendRows( 1 );
1537}
1538
1539
1540void SIMULATOR_FRAME_UI::DoFourier( const wxString& aSignal, const wxString& aFundamental )
1541{
1542 wxString cmd = wxString::Format( wxS( "fourier %s %s" ),
1543 SPICE_VALUE( aFundamental ).ToSpiceString(),
1544 aSignal );
1545
1546 simulator()->Command( cmd.ToStdString() );
1547}
1548
1549
1551{
1552 return circuitModel().get();
1553}
1554
1555
1556void SIMULATOR_FRAME_UI::AddTrace( const wxString& aName, SIM_TRACE_TYPE aType )
1557{
1558 if( !GetCurrentSimTab() )
1559 {
1560 m_simConsole->AppendText( _( "Error: no current simulation.\n" ) );
1561 m_simConsole->SetInsertionPointEnd();
1562 return;
1563 }
1564
1565 SIM_TYPE simType = SPICE_CIRCUIT_MODEL::CommandToSimType( GetCurrentSimTab()->GetSimCommand() );
1566
1567 if( simType == ST_UNKNOWN )
1568 {
1569 m_simConsole->AppendText( _( "Error: simulation type not defined.\n" ) );
1570 m_simConsole->SetInsertionPointEnd();
1571 return;
1572 }
1573 else if( !SIM_TAB::IsPlottable( simType ) )
1574 {
1575 m_simConsole->AppendText( _( "Error: simulation type doesn't support plotting.\n" ) );
1576 m_simConsole->SetInsertionPointEnd();
1577 return;
1578 }
1579
1580 if( SIM_PLOT_TAB* plotTab = dynamic_cast<SIM_PLOT_TAB*>( GetCurrentSimTab() ) )
1581 {
1582 if( simType == ST_AC )
1583 {
1584 updateTrace( aName, aType | SPT_AC_GAIN, plotTab );
1585 updateTrace( aName, aType | SPT_AC_PHASE, plotTab );
1586 }
1587 else if( simType == ST_SP )
1588 {
1589 updateTrace( aName, aType | SPT_AC_GAIN, plotTab );
1590 updateTrace( aName, aType | SPT_AC_PHASE, plotTab );
1591 }
1592 else
1593 {
1594 updateTrace( aName, aType, plotTab );
1595 }
1596
1597 plotTab->GetPlotWin()->UpdateAll();
1598 }
1599
1601 OnModify();
1602}
1603
1604
1605void SIMULATOR_FRAME_UI::SetUserDefinedSignals( const std::map<int, wxString>& aNewSignals )
1606{
1607 for( size_t ii = 0; ii < m_plotNotebook->GetPageCount(); ++ii )
1608 {
1609 SIM_PLOT_TAB* plotTab = dynamic_cast<SIM_PLOT_TAB*>( m_plotNotebook->GetPage( ii ) );
1610
1611 if( !plotTab )
1612 continue;
1613
1614 for( const auto& [ id, existingSignal ] : m_userDefinedSignals )
1615 {
1616 int traceType = SPT_UNKNOWN;
1617 wxString vectorName = vectorNameFromSignalName( plotTab, existingSignal, &traceType );
1618
1619 if( aNewSignals.count( id ) == 0 )
1620 {
1621 if( plotTab->GetSimType() == ST_AC )
1622 {
1623 for( int subType : { SPT_AC_GAIN, SPT_AC_PHASE } )
1624 plotTab->DeleteTrace( vectorName, traceType | subType );
1625 }
1626 else if( plotTab->GetSimType() == ST_SP )
1627 {
1628 for( int subType : { SPT_SP_AMP, SPT_AC_PHASE } )
1629 plotTab->DeleteTrace( vectorName, traceType | subType );
1630 }
1631 else
1632 {
1633 plotTab->DeleteTrace( vectorName, traceType );
1634 }
1635 }
1636 else
1637 {
1638 if( plotTab->GetSimType() == ST_AC )
1639 {
1640 for( int subType : { SPT_AC_GAIN, SPT_AC_PHASE } )
1641 {
1642 if( TRACE* trace = plotTab->GetTrace( vectorName, traceType | subType ) )
1643 trace->SetName( aNewSignals.at( id ) );
1644 }
1645 }
1646 else if( plotTab->GetSimType() == ST_SP )
1647 {
1648 for( int subType : { SPT_SP_AMP, SPT_AC_PHASE } )
1649 {
1650 if( TRACE* trace = plotTab->GetTrace( vectorName, traceType | subType ) )
1651 trace->SetName( aNewSignals.at( id ) );
1652 }
1653 }
1654 else
1655 {
1656 if( TRACE* trace = plotTab->GetTrace( vectorName, traceType ) )
1657 trace->SetName( aNewSignals.at( id ) );
1658 }
1659 }
1660 }
1661 }
1662
1663 m_userDefinedSignals = aNewSignals;
1664
1667
1669 rebuildSignalsGrid( m_filter->GetValue() );
1672 OnModify();
1673}
1674
1675
1676void SIMULATOR_FRAME_UI::updateTrace( const wxString& aVectorName, int aTraceType,
1677 SIM_PLOT_TAB* aPlotTab, std::vector<double>* aDataX,
1678 bool aClearData )
1679{
1681
1682 aTraceType &= aTraceType & SPT_Y_AXIS_MASK;
1683 aTraceType |= getXAxisType( simType );
1684
1685 wxString simVectorName = aVectorName;
1686
1687 if( aTraceType & SPT_POWER )
1688 simVectorName = simVectorName.AfterFirst( '(' ).BeforeLast( ')' ) + wxS( ":power" );
1689
1690 if( !SIM_TAB::IsPlottable( simType ) )
1691 {
1692 // There is no plot to be shown
1693 simulator()->Command( wxString::Format( wxT( "print %s" ), aVectorName ).ToStdString() );
1694
1695 return;
1696 }
1697
1698 std::vector<double> data_x;
1699 std::vector<double> data_y;
1700
1701 if( !aDataX || aClearData )
1702 aDataX = &data_x;
1703
1704 // First, handle the x axis
1705 if( aDataX->empty() && !aClearData )
1706 {
1707 wxString xAxisName( simulator()->GetXAxis( simType ) );
1708
1709 if( xAxisName.IsEmpty() )
1710 return;
1711
1712 *aDataX = simulator()->GetGainVector( (const char*) xAxisName.c_str() );
1713 }
1714
1715 unsigned int size = aDataX->size();
1716
1717 switch( simType )
1718 {
1719 case ST_AC:
1720 if( aTraceType & SPT_AC_GAIN )
1721 data_y = simulator()->GetGainVector( (const char*) simVectorName.c_str(), size );
1722 else if( aTraceType & SPT_AC_PHASE )
1723 data_y = simulator()->GetPhaseVector( (const char*) simVectorName.c_str(), size );
1724 else
1725 wxFAIL_MSG( wxT( "Plot type missing AC_PHASE or AC_MAG bit" ) );
1726
1727 break;
1728 case ST_SP:
1729 if( aTraceType & SPT_SP_AMP )
1730 data_y = simulator()->GetGainVector( (const char*) simVectorName.c_str(), size );
1731 else if( aTraceType & SPT_AC_PHASE )
1732 data_y = simulator()->GetPhaseVector( (const char*) simVectorName.c_str(), size );
1733 else
1734 wxFAIL_MSG( wxT( "Plot type missing AC_PHASE or SPT_SP_AMP bit" ) );
1735
1736 break;
1737
1738 case ST_DC:
1739 data_y = simulator()->GetGainVector( (const char*) simVectorName.c_str(), -1 );
1740 break;
1741
1742 case ST_NOISE:
1743 case ST_TRAN:
1744 case ST_FFT:
1745 data_y = simulator()->GetGainVector( (const char*) simVectorName.c_str(), size );
1746 break;
1747
1748 default:
1749 wxFAIL_MSG( wxT( "Unhandled plot type" ) );
1750 }
1751
1752 SPICE_DC_PARAMS source1, source2;
1753 int sweepCount = 1;
1754 size_t sweepSize = std::numeric_limits<size_t>::max();
1755
1756 if( simType == ST_DC
1757 && circuitModel()->ParseDCCommand( aPlotTab->GetSimCommand(), &source1, &source2 )
1758 && !source2.m_source.IsEmpty() )
1759 {
1760 SPICE_VALUE v = ( source2.m_vend - source2.m_vstart ) / source2.m_vincrement;
1761
1762 sweepCount = KiROUND( v.ToDouble() ) + 1;
1763 sweepSize = aDataX->size() / sweepCount;
1764 }
1765
1766 if( TRACE* trace = aPlotTab->GetOrAddTrace( aVectorName, aTraceType ) )
1767 {
1768 if( data_y.size() >= size )
1769 aPlotTab->SetTraceData( trace, *aDataX, data_y, sweepCount, sweepSize );
1770 }
1771}
1772
1773
1775{
1776 SIM_PLOT_TAB* plotTab = dynamic_cast<SIM_PLOT_TAB*>( GetCurrentSimTab() );
1777
1778 for( int row = 0; row < m_signalsGrid->GetNumberRows(); ++row )
1779 {
1780 wxString signalName = m_signalsGrid->GetCellValue( row, COL_SIGNAL_NAME );
1781 int traceType = SPT_UNKNOWN;
1782 wxString vectorName = vectorNameFromSignalName( plotTab, signalName, &traceType );
1783
1784 if( TRACE* trace = plotTab ? plotTab->GetTrace( vectorName, traceType ) : nullptr )
1785 {
1786 m_signalsGrid->SetCellValue( row, COL_SIGNAL_SHOW, wxS( "1" ) );
1787
1788 wxGridCellAttr* attr = new wxGridCellAttr;
1789 attr->SetRenderer( new GRID_CELL_COLOR_RENDERER( this ) );
1790 attr->SetEditor( new GRID_CELL_COLOR_SELECTOR( this, m_signalsGrid ) );
1791 attr->SetAlignment( wxALIGN_CENTER, wxALIGN_CENTER );
1792 m_signalsGrid->SetAttr( row, COL_SIGNAL_COLOR, attr );
1793
1794 KIGFX::COLOR4D color( trace->GetPen().GetColour() );
1795 m_signalsGrid->SetCellValue( row, COL_SIGNAL_COLOR, color.ToCSSString() );
1796
1797 attr = new wxGridCellAttr;
1798 attr->SetRenderer( new wxGridCellBoolRenderer() );
1799 attr->SetReadOnly(); // not really; we delegate interactivity to GRID_TRICKS
1800 attr->SetAlignment( wxALIGN_CENTER, wxALIGN_CENTER );
1801 m_signalsGrid->SetAttr( row, COL_CURSOR_1, attr );
1802
1803 attr = new wxGridCellAttr;
1804 attr->SetRenderer( new wxGridCellBoolRenderer() );
1805 attr->SetReadOnly(); // not really; we delegate interactivity to GRID_TRICKS
1806 attr->SetAlignment( wxALIGN_CENTER, wxALIGN_CENTER );
1807 m_signalsGrid->SetAttr( row, COL_CURSOR_2, attr );
1808
1809 if( trace->HasCursor( 1 ) )
1810 m_signalsGrid->SetCellValue( row, COL_CURSOR_1, wxS( "1" ) );
1811 else
1812 m_signalsGrid->SetCellValue( row, COL_CURSOR_1, wxEmptyString );
1813
1814 if( trace->HasCursor( 2 ) )
1815 m_signalsGrid->SetCellValue( row, COL_CURSOR_2, wxS( "1" ) );
1816 else
1817 m_signalsGrid->SetCellValue( row, COL_CURSOR_2, wxEmptyString );
1818 }
1819 else
1820 {
1821 m_signalsGrid->SetCellValue( row, COL_SIGNAL_SHOW, wxEmptyString );
1822
1823 wxGridCellAttr* attr = new wxGridCellAttr;
1824 attr->SetReadOnly();
1825 m_signalsGrid->SetAttr( row, COL_SIGNAL_COLOR, attr );
1826 m_signalsGrid->SetCellValue( row, COL_SIGNAL_COLOR, wxEmptyString );
1827
1828 attr = new wxGridCellAttr;
1829 attr->SetReadOnly();
1830 m_signalsGrid->SetAttr( row, COL_CURSOR_1, attr );
1831 m_signalsGrid->SetCellValue( row, COL_CURSOR_1, wxEmptyString );
1832
1833 attr = new wxGridCellAttr;
1834 attr->SetReadOnly();
1835 m_signalsGrid->SetAttr( row, COL_CURSOR_2, attr );
1836 m_signalsGrid->SetCellValue( row, COL_CURSOR_2, wxEmptyString );
1837 }
1838 }
1839}
1840
1841
1843{
1844 auto quoteNetNames =
1845 [&]( wxString aExpression ) -> wxString
1846 {
1847 for( const auto& [netname, quotedNetname] : m_quotedNetnames )
1848 aExpression.Replace( netname, quotedNetname );
1849
1850 return aExpression;
1851 };
1852
1853 for( const auto& [ id, signal ] : m_userDefinedSignals )
1854 {
1855 constexpr const char* cmd = "let user{} = {}";
1856
1857 simulator()->Command( "echo " + fmt::format( cmd, id, signal.ToStdString() ) );
1858 simulator()->Command( fmt::format( cmd, id, quoteNetNames( signal ).ToStdString() ) );
1859 }
1860}
1861
1862
1864{
1865 WX_STRING_REPORTER reporter;
1866
1867 for( const TUNER_SLIDER* tuner : m_tuners )
1868 {
1869 SCH_SHEET_PATH sheetPath;
1870 wxString ref = tuner->GetSymbolRef();
1871 KIID symbolId = tuner->GetSymbol( &sheetPath );
1872 SCH_ITEM* schItem = sheetPath.GetItem( symbolId );
1873 SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>( schItem );
1874
1875 if( !symbol )
1876 {
1877 reporter.Report( wxString::Format( _( "%s not found" ), ref ) );
1878 continue;
1879 }
1880
1881 const SPICE_ITEM* item = GetExporter()->FindItem( tuner->GetSymbolRef() );
1882
1883 if( !item || !item->model->GetTunerParam() )
1884 {
1885 reporter.Report( wxString::Format( _( "%s is not tunable" ), ref ) );
1886 continue;
1887 }
1888
1889 double floatVal = tuner->GetValue().ToDouble();
1890
1891 simulator()->Command( item->model->SpiceGenerator().TunerCommand( *item, floatVal ) );
1892 }
1893
1894 if( reporter.HasMessage() )
1895 DisplayErrorMessage( this, _( "Could not apply tuned value(s):" ) + wxS( "\n" )
1896 + reporter.GetMessages() );
1897}
1898
1899
1900bool SIMULATOR_FRAME_UI::LoadWorkbook( const wxString& aPath )
1901{
1902 wxTextFile file( aPath );
1903
1904 if( !file.Open() )
1905 return false;
1906
1907 wxString firstLine = file.GetFirstLine();
1908 long dummy;
1909 bool legacy = firstLine.StartsWith( wxT( "version " ) ) || firstLine.ToLong( &dummy );
1910
1911 file.Close();
1912
1913 m_plotNotebook->DeleteAllPages();
1914 m_userDefinedSignals.clear();
1915
1916 if( legacy )
1917 {
1918 if( !loadLegacyWorkbook( aPath ) )
1919 return false;
1920 }
1921 else
1922 {
1923 if( !loadJsonWorkbook( aPath ) )
1924 return false;
1925 }
1926
1928
1929 rebuildSignalsGrid( m_filter->GetValue() );
1933
1934 wxFileName filename( aPath );
1935 filename.MakeRelativeTo( m_schematicFrame->Prj().GetProjectPath() );
1936
1937 // Remember the loaded workbook filename.
1938 simulator()->Settings()->SetWorkbookFilename( filename.GetFullPath() );
1939
1940 return true;
1941}
1942
1943
1944bool SIMULATOR_FRAME_UI::loadJsonWorkbook( const wxString& aPath )
1945{
1946 wxFFileInputStream fp( aPath, wxT( "rt" ) );
1947 wxStdInputStream fstream( fp );
1948
1949 if( !fp.IsOk() )
1950 return false;
1951
1952 try
1953 {
1954 nlohmann::json js = nlohmann::json::parse( fstream, nullptr, true, true );
1955
1956 std::map<SIM_PLOT_TAB*, nlohmann::json> traceInfo;
1957
1958 for( const nlohmann::json& tab_js : js[ "tabs" ] )
1959 {
1960 wxString simCommand;
1963
1964 for( const nlohmann::json& cmd : tab_js[ "commands" ] )
1965 {
1966 if( cmd == ".kicad adjustpaths" )
1968 else if( cmd == ".save all" )
1970 else if( cmd == ".probe alli" )
1972 else if( cmd == ".probe allp" )
1974 else if( cmd == ".kicad esavenone" )
1975 simOptions &= ~NETLIST_EXPORTER_SPICE::OPTION_SAVE_ALL_EVENTS;
1976 else
1977 simCommand += wxString( cmd.get<wxString>() ).Trim();
1978 }
1979
1980 SIM_TAB* simTab = NewSimTab( simCommand );
1981 SIM_PLOT_TAB* plotTab = dynamic_cast<SIM_PLOT_TAB*>( simTab );
1982
1983 simTab->SetSimOptions( simOptions );
1984
1985 if( plotTab )
1986 {
1987 if( tab_js.contains( "traces" ) )
1988 traceInfo[plotTab] = tab_js[ "traces" ];
1989
1990 if( tab_js.contains( "measurements" ) )
1991 {
1992 for( const nlohmann::json& m_js : tab_js[ "measurements" ] )
1993 plotTab->Measurements().emplace_back( m_js[ "expr" ], m_js[ "format" ] );
1994 }
1995
1996 plotTab->SetDottedSecondary( tab_js[ "dottedSecondary" ] );
1997 plotTab->ShowGrid( tab_js[ "showGrid" ] );
1998
1999 if( tab_js.contains( "fixedY1scale" ) )
2000 {
2001 const nlohmann::json& scale_js = tab_js[ "fixedY1scale" ];
2002 plotTab->SetY1Scale( true, scale_js[ "min" ], scale_js[ "max" ] );
2003 plotTab->GetPlotWin()->LockY( true );
2004 }
2005
2006 if( tab_js.contains( "fixedY2scale" ) )
2007 {
2008 const nlohmann::json& scale_js = tab_js[ "fixedY2scale" ];
2009 plotTab->SetY2Scale( true, scale_js[ "min" ], scale_js[ "max" ] );
2010 plotTab->GetPlotWin()->LockY( true );
2011 }
2012
2013 if( tab_js.contains( "fixedY3scale" ) )
2014 {
2015 plotTab->EnsureThirdYAxisExists();
2016 const nlohmann::json& scale_js = tab_js[ "fixedY3scale" ];
2017 plotTab->SetY3Scale( true, scale_js[ "min" ], scale_js[ "max" ] );
2018 plotTab->GetPlotWin()->LockY( true );
2019 }
2020
2021 if( tab_js.contains( "legend" ) )
2022 {
2023 const nlohmann::json& legend_js = tab_js[ "legend" ];
2024 plotTab->SetLegendPosition( wxPoint( legend_js[ "x" ], legend_js[ "y" ] ) );
2025 plotTab->ShowLegend( true );
2026 }
2027
2028 if( tab_js.contains( "margins" ) )
2029 {
2030 const nlohmann::json& margins_js = tab_js[ "margins" ];
2031 plotTab->GetPlotWin()->SetMargins( margins_js[ "top" ],
2032 margins_js[ "right" ],
2033 margins_js[ "bottom" ],
2034 margins_js[ "left" ] );
2035 }
2036 }
2037 }
2038
2039 int ii = 0;
2040
2041 if( js.contains( "user_defined_signals" ) )
2042 {
2043 for( const nlohmann::json& signal_js : js[ "user_defined_signals" ] )
2044 m_userDefinedSignals[ii++] = wxString( signal_js.get<wxString>() );
2045 }
2046
2047 auto addCursor =
2048 [this]( SIM_PLOT_TAB* aPlotTab, TRACE* aTrace, const wxString& aSignalName,
2049 int aCursorId, const nlohmann::json& aCursor_js )
2050 {
2051 if( aCursorId == 1 || aCursorId == 2 )
2052 {
2053 CURSOR* cursor = new CURSOR( aTrace, aPlotTab );
2054
2055 cursor->SetName( aSignalName );
2056 cursor->SetCoordX( aCursor_js[ "position" ] );
2057
2058 aTrace->SetCursor( aCursorId, cursor );
2059 aPlotTab->GetPlotWin()->AddLayer( cursor );
2060 }
2061
2062 m_cursorFormats[aCursorId-1][0].FromString( aCursor_js[ "x_format" ] );
2063 m_cursorFormats[aCursorId-1][1].FromString( aCursor_js[ "y_format" ] );
2064 };
2065
2066 for( const auto& [ plotTab, traces_js ] : traceInfo )
2067 {
2068 for( const nlohmann::json& trace_js : traces_js )
2069 {
2070 wxString signalName = trace_js[ "signal" ];
2071 wxString vectorName = vectorNameFromSignalName( plotTab, signalName, nullptr );
2072 TRACE* trace = plotTab->GetOrAddTrace( vectorName, trace_js[ "trace_type" ] );
2073
2074 if( trace )
2075 {
2076 if( trace_js.contains( "cursor1" ) )
2077 addCursor( plotTab, trace, signalName, 1, trace_js[ "cursor1" ] );
2078
2079 if( trace_js.contains( "cursor2" ) )
2080 addCursor( plotTab, trace, signalName, 2, trace_js[ "cursor2" ] );
2081
2082 if( trace_js.contains( "cursorD" ) )
2083 addCursor( plotTab, trace, signalName, 3, trace_js[ "cursorD" ] );
2084
2085 if( trace_js.contains( "color" ) )
2086 {
2087 wxColour color;
2088 color.Set( wxString( trace_js["color"].get<wxString>() ) );
2089 trace->SetTraceColour( color );
2090 plotTab->UpdateTraceStyle( trace );
2091 }
2092 }
2093 }
2094
2095 plotTab->UpdatePlotColors();
2096 }
2097
2098 if( SIM_TAB* simTab = GetCurrentSimTab() )
2099 {
2100 m_simulatorFrame->LoadSimulator( simTab->GetSimCommand(), simTab->GetSimOptions() );
2101
2102 if( SIM_TAB* firstTab = dynamic_cast<SIM_TAB*>( m_plotNotebook->GetPage( 0 ) ) )
2103 firstTab->SetLastSchTextSimCommand( js[ "last_sch_text_sim_command" ] );
2104 }
2105 }
2106 catch( nlohmann::json::parse_error& error )
2107 {
2108 wxLogTrace( traceSettings, wxT( "Json parse error reading %s: %s" ), aPath, error.what() );
2109
2110 return false;
2111 }
2112 catch( nlohmann::json::type_error& error )
2113 {
2114 wxLogTrace( traceSettings, wxT( "Json type error reading %s: %s" ), aPath, error.what() );
2115
2116 return false;
2117 }
2118 catch( nlohmann::json::invalid_iterator& error )
2119 {
2120 wxLogTrace( traceSettings, wxT( "Json invalid_iterator error reading %s: %s" ), aPath, error.what() );
2121
2122 return false;
2123 }
2124 catch( nlohmann::json::out_of_range& error )
2125 {
2126 wxLogTrace( traceSettings, wxT( "Json out_of_range error reading %s: %s" ), aPath, error.what() );
2127
2128 return false;
2129 }
2130 catch( ... )
2131 {
2132 wxLogTrace( traceSettings, wxT( "Error reading %s" ), aPath );
2133 return false;
2134 }
2135
2136 return true;
2137}
2138
2139
2140bool SIMULATOR_FRAME_UI::SaveWorkbook( const wxString& aPath )
2141{
2143
2144 wxFileName filename = aPath;
2145 filename.SetExt( FILEEXT::WorkbookFileExtension );
2146
2147 wxFile file;
2148
2149 file.Create( filename.GetFullPath(), true /* overwrite */ );
2150
2151 if( !file.IsOpened() )
2152 return false;
2153
2154 nlohmann::json tabs_js = nlohmann::json::array();
2155
2156 for( size_t i = 0; i < m_plotNotebook->GetPageCount(); i++ )
2157 {
2158 SIM_TAB* simTab = dynamic_cast<SIM_TAB*>( m_plotNotebook->GetPage( i ) );
2159
2160 if( !simTab )
2161 continue;
2162
2163 SIM_TYPE simType = simTab->GetSimType();
2164
2165 nlohmann::json commands_js = nlohmann::json::array();
2166
2167 commands_js.push_back( simTab->GetSimCommand() );
2168
2169 int options = simTab->GetSimOptions();
2170
2172 commands_js.push_back( ".kicad adjustpaths" );
2173
2175 commands_js.push_back( ".save all" );
2176
2178 commands_js.push_back( ".probe alli" );
2179
2181 commands_js.push_back( ".probe allp" );
2182
2184 commands_js.push_back( ".kicad esavenone" );
2185
2186 nlohmann::json tab_js = nlohmann::json(
2187 { { "analysis", SPICE_SIMULATOR::TypeToName( simType, true ) },
2188 { "commands", commands_js } } );
2189
2190 if( SIM_PLOT_TAB* plotTab = dynamic_cast<SIM_PLOT_TAB*>( simTab ) )
2191 {
2192 nlohmann::json traces_js = nlohmann::json::array();
2193
2194 auto findSignalName =
2195 [&]( const wxString& aVectorName ) -> wxString
2196 {
2197 wxString vectorName;
2198 wxString suffix;
2199
2200 if( aVectorName.EndsWith( _( " (phase)" ) ) )
2201 suffix = _( " (phase)" );
2202 else if( aVectorName.EndsWith( _( " (gain)" ) ) )
2203 suffix = _( " (gain)" );
2204
2205 vectorName = aVectorName.Left( aVectorName.Length() - suffix.Length() );
2206
2207 for( const auto& [ id, signal ] : m_userDefinedSignals )
2208 {
2209 if( vectorName == vectorNameFromSignalId( id ) )
2210 return signal + suffix;
2211 }
2212
2213 return aVectorName;
2214 };
2215
2216 for( const auto& [name, trace] : plotTab->GetTraces() )
2217 {
2218 nlohmann::json trace_js = nlohmann::json(
2219 { { "trace_type", (int) trace->GetType() },
2220 { "signal", findSignalName( trace->GetDisplayName() ) },
2221 { "color", COLOR4D( trace->GetTraceColour() ).ToCSSString() } } );
2222
2223 if( CURSOR* cursor = trace->GetCursor( 1 ) )
2224 {
2225 trace_js["cursor1"] = nlohmann::json(
2226 { { "position", cursor->GetCoords().x },
2227 { "x_format", m_cursorFormats[0][0].ToString() },
2228 { "y_format", m_cursorFormats[0][1].ToString() } } );
2229 }
2230
2231 if( CURSOR* cursor = trace->GetCursor( 2 ) )
2232 {
2233 trace_js["cursor2"] = nlohmann::json(
2234 { { "position", cursor->GetCoords().x },
2235 { "x_format", m_cursorFormats[1][0].ToString() },
2236 { "y_format", m_cursorFormats[1][1].ToString() } } );
2237 }
2238
2239 if( trace->GetCursor( 1 ) || trace->GetCursor( 2 ) )
2240 {
2241 trace_js["cursorD"] = nlohmann::json(
2242 { { "x_format", m_cursorFormats[2][0].ToString() },
2243 { "y_format", m_cursorFormats[2][1].ToString() } } );
2244 }
2245
2246 traces_js.push_back( trace_js );
2247 }
2248
2249 nlohmann::json measurements_js = nlohmann::json::array();
2250
2251 for( const auto& [ measurement, format ] : plotTab->Measurements() )
2252 {
2253 measurements_js.push_back( nlohmann::json( { { "expr", measurement },
2254 { "format", format } } ) );
2255 }
2256
2257 tab_js[ "traces" ] = traces_js;
2258 tab_js[ "measurements" ] = measurements_js;
2259 tab_js[ "dottedSecondary" ] = plotTab->GetDottedSecondary();
2260 tab_js[ "showGrid" ] = plotTab->IsGridShown();
2261
2262 double min, max;
2263
2264 if( plotTab->GetY1Scale( &min, &max ) )
2265 tab_js[ "fixedY1scale" ] = nlohmann::json( { { "min", min }, { "max", max } } );
2266
2267 if( plotTab->GetY2Scale( &min, &max ) )
2268 tab_js[ "fixedY2scale" ] = nlohmann::json( { { "min", min }, { "max", max } } );
2269
2270 if( plotTab->GetY3Scale( &min, &max ) )
2271 tab_js[ "fixedY3scale" ] = nlohmann::json( { { "min", min }, { "max", max } } );
2272
2273 if( plotTab->IsLegendShown() )
2274 {
2275 tab_js[ "legend" ] = nlohmann::json( { { "x", plotTab->GetLegendPosition().x },
2276 { "y", plotTab->GetLegendPosition().y } } );
2277 }
2278
2279 mpWindow* plotWin = plotTab->GetPlotWin();
2280
2281 tab_js[ "margins" ] = nlohmann::json( { { "left", plotWin->GetMarginLeft() },
2282 { "right", plotWin->GetMarginRight() },
2283 { "top", plotWin->GetMarginTop() },
2284 { "bottom", plotWin->GetMarginBottom() } } );
2285 }
2286
2287 tabs_js.push_back( tab_js );
2288 }
2289
2290 nlohmann::json userDefinedSignals_js = nlohmann::json::array();
2291
2292 for( const auto& [ id, signal ] : m_userDefinedSignals )
2293 userDefinedSignals_js.push_back( signal );
2294
2295 nlohmann::json js = nlohmann::json( { { "version", 6 },
2296 { "tabs", tabs_js },
2297 { "user_defined_signals", userDefinedSignals_js } } );
2298
2299 // Store the value of any simulation command found on the schematic sheet in a SCH_TEXT
2300 // object. If this changes we want to warn the user and ask them if they want to update
2301 // the corresponding panel's sim command.
2302 if( m_plotNotebook->GetPageCount() > 0 )
2303 {
2304 SIM_TAB* simTab = dynamic_cast<SIM_TAB*>( m_plotNotebook->GetPage( 0 ) );
2305 js[ "last_sch_text_sim_command" ] = simTab->GetLastSchTextSimCommand();
2306 }
2307
2308 std::stringstream buffer;
2309 buffer << std::setw( 2 ) << js << std::endl;
2310
2311 bool res = file.Write( buffer.str() );
2312 file.Close();
2313
2314 // Store the filename of the last saved workbook.
2315 if( res )
2316 {
2317 filename.MakeRelativeTo( m_schematicFrame->Prj().GetProjectPath() );
2318 simulator()->Settings()->SetWorkbookFilename( filename.GetFullPath() );
2319 }
2320
2321 return res;
2322}
2323
2324
2326{
2327 switch( aType )
2328 {
2330 case ST_AC: return SPT_LIN_FREQUENCY;
2331 case ST_SP: return SPT_LIN_FREQUENCY;
2332 case ST_FFT: return SPT_LIN_FREQUENCY;
2333 case ST_DC: return SPT_SWEEP;
2334 case ST_TRAN: return SPT_TIME;
2335 case ST_NOISE: return SPT_LIN_FREQUENCY;
2336 default: wxFAIL_MSG( wxS( "Unhandled simulation type" ) ); return SPT_UNKNOWN;
2337 }
2338}
2339
2340
2342{
2343 wxString output;
2344 wxString ref;
2345 wxString source;
2346 wxString scale;
2347 SPICE_VALUE pts;
2348 SPICE_VALUE fStart;
2349 SPICE_VALUE fStop;
2350 bool saveAll;
2351
2352 if( GetCurrentSimTab() )
2353 {
2354 circuitModel()->ParseNoiseCommand( GetCurrentSimTab()->GetSimCommand(), &output, &ref,
2355 &source, &scale, &pts, &fStart, &fStop, &saveAll );
2356 }
2357
2358 return source;
2359}
2360
2361
2363{
2365
2366 // Rebuild the color list to plot traces
2368
2369 // Now send changes to all SIM_PLOT_TAB
2370 for( size_t page = 0; page < m_plotNotebook->GetPageCount(); page++ )
2371 {
2372 wxWindow* curPage = m_plotNotebook->GetPage( page );
2373
2374 // ensure it is truly a plot plotTab and not the (zero plots) placeholder
2375 // which is only SIM_TAB
2376 SIM_PLOT_TAB* plotTab = dynamic_cast<SIM_PLOT_TAB*>( curPage );
2377
2378 if( plotTab )
2379 plotTab->UpdatePlotColors();
2380 }
2381}
2382
2383
2384void SIMULATOR_FRAME_UI::onPlotClose( wxAuiNotebookEvent& event )
2385{
2386 OnModify();
2387}
2388
2389
2390void SIMULATOR_FRAME_UI::onPlotClosed( wxAuiNotebookEvent& event )
2391{
2392 CallAfter( [this]()
2393 {
2395 rebuildSignalsGrid( m_filter->GetValue() );
2397
2398 SIM_TAB* panel = GetCurrentSimTab();
2399
2400 if( !panel || panel->GetSimType() != ST_OP )
2401 {
2402 SCHEMATIC& schematic = m_schematicFrame->Schematic();
2403 schematic.ClearOperatingPoints();
2406 }
2407 } );
2408}
2409
2410
2412{
2413 if( SIM_PLOT_TAB* plotTab = dynamic_cast<SIM_PLOT_TAB*>( GetCurrentSimTab() ) )
2414 {
2415 std::vector<std::pair<wxString, wxString>>& measurements = plotTab->Measurements();
2416
2417 measurements.clear();
2418
2419 for( int row = 0; row < m_measurementsGrid->GetNumberRows(); ++row )
2420 {
2421 if( !m_measurementsGrid->GetCellValue( row, COL_MEASUREMENT ).IsEmpty() )
2422 {
2423 measurements.emplace_back( m_measurementsGrid->GetCellValue( row, COL_MEASUREMENT ),
2424 m_measurementsGrid->GetCellValue( row, COL_MEASUREMENT_FORMAT ) );
2425 }
2426 }
2427 }
2428}
2429
2430
2431void SIMULATOR_FRAME_UI::onPlotChanging( wxAuiNotebookEvent& event )
2432{
2434
2435 event.Skip();
2436}
2437
2438
2440{
2442 rebuildSignalsGrid( m_filter->GetValue() );
2444
2446
2447 for( int row = 0; row < m_measurementsGrid->GetNumberRows(); ++row )
2448 UpdateMeasurement( row );
2449}
2450
2451
2452void SIMULATOR_FRAME_UI::onPlotChanged( wxAuiNotebookEvent& event )
2453{
2454 if( SIM_TAB* simTab = GetCurrentSimTab() )
2455 simulator()->Command( "setplot " + simTab->GetSpicePlotName().ToStdString() );
2456
2458
2459 event.Skip();
2460}
2461
2462
2464{
2466
2467 if( SIM_PLOT_TAB* plotTab = dynamic_cast<SIM_PLOT_TAB*>( GetCurrentSimTab() ) )
2468 {
2469 for( const auto& [ measurement, format ] : plotTab->Measurements() )
2470 {
2471 int row = m_measurementsGrid->GetNumberRows();
2472 m_measurementsGrid->AppendRows();
2473 m_measurementsGrid->SetCellValue( row, COL_MEASUREMENT, measurement );
2474 m_measurementsGrid->SetCellValue( row, COL_MEASUREMENT_FORMAT, format );
2475 }
2476
2477 if( plotTab->GetSimType() == ST_TRAN || plotTab->GetSimType() == ST_AC
2478 || plotTab->GetSimType() == ST_DC || plotTab->GetSimType() == ST_SP )
2479 {
2480 m_measurementsGrid->AppendRows(); // Empty row at end
2481 }
2482 }
2483}
2484
2485
2486void SIMULATOR_FRAME_UI::onPlotDragged( wxAuiNotebookEvent& event )
2487{
2488}
2489
2490
2491std::shared_ptr<SPICE_SIMULATOR> SIMULATOR_FRAME_UI::simulator() const
2492{
2494}
2495
2496
2497std::shared_ptr<SPICE_CIRCUIT_MODEL> SIMULATOR_FRAME_UI::circuitModel() const
2498{
2500}
2501
2502
2504{
2505 SUPPRESS_GRID_CELL_EVENTS raii( this );
2506
2508
2509 SIM_PLOT_TAB* plotTab = dynamic_cast<SIM_PLOT_TAB*>( GetCurrentSimTab() );
2510
2511 if( !plotTab )
2512 return;
2513
2514 // Update cursor values
2515 CURSOR* cursor1 = nullptr;
2516 wxString cursor1Name;
2517 wxString cursor1Units;
2518 CURSOR* cursor2 = nullptr;
2519 wxString cursor2Name;
2520 wxString cursor2Units;
2521
2522 auto getUnitsY =
2523 [&]( TRACE* aTrace ) -> wxString
2524 {
2525 if( plotTab->GetSimType() == ST_AC )
2526 {
2527 if( aTrace->GetType() & SPT_AC_PHASE )
2528 return plotTab->GetUnitsY2();
2529 else
2530 return plotTab->GetUnitsY1();
2531 }
2532 else
2533 {
2534 if( aTrace->GetType() & SPT_POWER )
2535 return plotTab->GetUnitsY3();
2536 else if( aTrace->GetType() & SPT_CURRENT )
2537 return plotTab->GetUnitsY2();
2538 else
2539 return plotTab->GetUnitsY1();
2540 }
2541 };
2542
2543 auto getNameY =
2544 [&]( TRACE* aTrace ) -> wxString
2545 {
2546 if( plotTab->GetSimType() == ST_AC )
2547 {
2548 if( aTrace->GetType() & SPT_AC_PHASE )
2549 return plotTab->GetLabelY2();
2550 else
2551 return plotTab->GetLabelY1();
2552 }
2553 else
2554 {
2555 if( aTrace->GetType() & SPT_POWER )
2556 return plotTab->GetLabelY3();
2557 else if( aTrace->GetType() & SPT_CURRENT )
2558 return plotTab->GetLabelY2();
2559 else
2560 return plotTab->GetLabelY1();
2561 }
2562 };
2563
2564 auto formatValue =
2565 [this]( double aValue, int aCursorId, int aCol ) -> wxString
2566 {
2567 if( ( !m_simulatorFrame->SimFinished() && aCol == 1 ) || std::isnan( aValue ) )
2568 return wxS( "--" );
2569 else
2570 return SPICE_VALUE( aValue ).ToString( m_cursorFormats[ aCursorId ][ aCol ] );
2571 };
2572
2573 for( const auto& [name, trace] : plotTab->GetTraces() )
2574 {
2575 if( CURSOR* cursor = trace->GetCursor( 1 ) )
2576 {
2577 cursor1 = cursor;
2578 cursor1Name = getNameY( trace );
2579 cursor1Units = getUnitsY( trace );
2580
2581 wxRealPoint coords = cursor->GetCoords();
2582 int row = m_cursorsGrid->GetNumberRows();
2583
2584 m_cursorFormats[0][0].UpdateUnits( plotTab->GetUnitsX() );
2585 m_cursorFormats[0][1].UpdateUnits( cursor1Units );
2586
2587 m_cursorsGrid->AppendRows( 1 );
2588 m_cursorsGrid->SetCellValue( row, COL_CURSOR_NAME, wxS( "1" ) );
2589 m_cursorsGrid->SetCellValue( row, COL_CURSOR_SIGNAL, cursor->GetName() );
2590 m_cursorsGrid->SetCellValue( row, COL_CURSOR_X, formatValue( coords.x, 0, 0 ) );
2591 m_cursorsGrid->SetCellValue( row, COL_CURSOR_Y, formatValue( coords.y, 0, 1 ) );
2592 break;
2593 }
2594 }
2595
2596 for( const auto& [name, trace] : plotTab->GetTraces() )
2597 {
2598 if( CURSOR* cursor = trace->GetCursor( 2 ) )
2599 {
2600 cursor2 = cursor;
2601 cursor2Name = getNameY( trace );
2602 cursor2Units = getUnitsY( trace );
2603
2604 wxRealPoint coords = cursor->GetCoords();
2605 int row = m_cursorsGrid->GetNumberRows();
2606
2607 m_cursorFormats[1][0].UpdateUnits( plotTab->GetUnitsX() );
2608 m_cursorFormats[1][1].UpdateUnits( cursor2Units );
2609
2610 m_cursorsGrid->AppendRows( 1 );
2611 m_cursorsGrid->SetCellValue( row, COL_CURSOR_NAME, wxS( "2" ) );
2612 m_cursorsGrid->SetCellValue( row, COL_CURSOR_SIGNAL, cursor->GetName() );
2613 m_cursorsGrid->SetCellValue( row, COL_CURSOR_X, formatValue( coords.x, 1, 0 ) );
2614 m_cursorsGrid->SetCellValue( row, COL_CURSOR_Y, formatValue( coords.y, 1, 1 ) );
2615 break;
2616 }
2617 }
2618
2619 if( cursor1 && cursor2 && cursor1Units == cursor2Units )
2620 {
2621 wxRealPoint coords = cursor2->GetCoords() - cursor1->GetCoords();
2622 wxString signal;
2623
2624 m_cursorFormats[2][0].UpdateUnits( plotTab->GetUnitsX() );
2625 m_cursorFormats[2][1].UpdateUnits( cursor1Units );
2626
2627 if( cursor1->GetName() == cursor2->GetName() )
2628 signal = wxString::Format( wxS( "%s[2 - 1]" ), cursor2->GetName() );
2629 else
2630 signal = wxString::Format( wxS( "%s - %s" ), cursor2->GetName(), cursor1->GetName() );
2631
2632 m_cursorsGrid->AppendRows( 1 );
2633 m_cursorsGrid->SetCellValue( 2, COL_CURSOR_NAME, _( "Diff" ) );
2634 m_cursorsGrid->SetCellValue( 2, COL_CURSOR_SIGNAL, signal );
2635 m_cursorsGrid->SetCellValue( 2, COL_CURSOR_X, formatValue( coords.x, 2, 0 ) );
2636 m_cursorsGrid->SetCellValue( 2, COL_CURSOR_Y, formatValue( coords.y, 2, 1 ) );
2637 }
2638
2639 // Set up the labels
2640 m_cursorsGrid->SetColLabelValue( COL_CURSOR_X, plotTab->GetLabelX() );
2641
2642 wxString valColName = _( "Value" );
2643
2644 if( !cursor1Name.IsEmpty() )
2645 {
2646 if( cursor2Name.IsEmpty() || cursor1Name == cursor2Name )
2647 valColName = cursor1Name;
2648 }
2649 else if( !cursor2Name.IsEmpty() )
2650 {
2651 valColName = cursor2Name;
2652 }
2653
2654 m_cursorsGrid->SetColLabelValue( COL_CURSOR_Y, valColName );
2655}
2656
2657
2658void SIMULATOR_FRAME_UI::onPlotCursorUpdate( wxCommandEvent& aEvent )
2659{
2661 OnModify();
2662}
2663
2664
2666{
2667 if( SIM_PLOT_TAB* plotTab = dynamic_cast<SIM_PLOT_TAB*>( GetCurrentSimTab() ) )
2668 plotTab->ResetScales( true );
2669
2670 m_simConsole->Clear();
2671
2672 // Do not export netlist, it is already stored in the simulator
2673 applyTuners();
2674
2675 m_refreshTimer.Start( REFRESH_INTERVAL, wxTIMER_ONE_SHOT );
2676}
2677
2678
2679void SIMULATOR_FRAME_UI::OnSimReport( const wxString& aMsg )
2680{
2681 m_simConsole->AppendText( aMsg + "\n" );
2682 m_simConsole->SetInsertionPointEnd();
2683}
2684
2685
2686std::vector<wxString> SIMULATOR_FRAME_UI::SimPlotVectors() const
2687{
2688 std::vector<wxString> signals;
2689
2690 for( const std::string& vec : simulator()->AllVectors() )
2691 signals.emplace_back( vec );
2692
2693 return signals;
2694}
2695
2696
2697std::vector<wxString> SIMULATOR_FRAME_UI::Signals() const
2698{
2699 std::vector<wxString> signals;
2700
2701 for( const wxString& signal : m_signals )
2702 signals.emplace_back( signal );
2703
2704 for( const auto& [ id, signal ] : m_userDefinedSignals )
2705 signals.emplace_back( signal );
2706
2707 sortSignals( signals );
2708
2709 return signals;
2710}
2711
2712
2714{
2715 if( aFinal )
2716 m_refreshTimer.Stop();
2717
2718 SIM_TAB* simTab = GetCurrentSimTab();
2719
2720 if( !simTab )
2721 return;
2722
2723 SIM_TYPE simType = simTab->GetSimType();
2724 wxString msg;
2725
2726 if( aFinal )
2727 {
2730 }
2731
2732 // If there are any signals plotted, update them
2733 if( SIM_TAB::IsPlottable( simType ) )
2734 {
2735 simTab->SetSpicePlotName( simulator()->CurrentPlotName() );
2736
2737 if( simType == ST_NOISE && aFinal )
2738 {
2739 m_simConsole->AppendText( _( "\n\nSimulation results:\n\n" ) );
2740 m_simConsole->SetInsertionPointEnd();
2741
2742 // The simulator will create noise1 & noise2 on the first run, noise3 and noise4
2743 // on the second, etc. The first plot for each run contains the spectral density
2744 // noise vectors and second contains the integrated noise.
2745 long number;
2746 simulator()->CurrentPlotName().Mid( 5 ).ToLong( &number );
2747
2748 for( const std::string& vec : simulator()->AllVectors() )
2749 {
2750 std::vector<double> val_list = simulator()->GetRealVector( vec, 1 );
2751 wxString value = SPICE_VALUE( val_list[ 0 ] ).ToSpiceString();
2752
2753 msg.Printf( wxS( "%s: %sV\n" ), vec, value );
2754
2755 m_simConsole->AppendText( msg );
2756 m_simConsole->SetInsertionPointEnd();
2757 }
2758
2759 simulator()->Command( fmt::format( "setplot noise{}", number - 1 ) );
2760 simTab->SetSpicePlotName( simulator()->CurrentPlotName() );
2761 }
2762
2763 SIM_PLOT_TAB* plotTab = dynamic_cast<SIM_PLOT_TAB*>( simTab );
2764 wxCHECK_RET( plotTab, wxT( "not a SIM_PLOT_TAB" ) );
2765
2766 struct TRACE_INFO
2767 {
2768 wxString Vector;
2769 int TraceType;
2770 bool ClearData;
2771 };
2772
2773 std::map<TRACE*, TRACE_INFO> traceMap;
2774
2775 for( const auto& [ name, trace ] : plotTab->GetTraces() )
2776 traceMap[ trace ] = { wxEmptyString, SPT_UNKNOWN, false };
2777
2778 // NB: m_signals are already broken out into gain/phase, but m_userDefinedSignals are
2779 // as the user typed them
2780
2781 for( const wxString& signal : m_signals )
2782 {
2783 int traceType = SPT_UNKNOWN;
2784 wxString vectorName = vectorNameFromSignalName( plotTab, signal, &traceType );
2785
2786 if( TRACE* trace = plotTab->GetTrace( vectorName, traceType ) )
2787 traceMap[ trace ] = { vectorName, traceType, false };
2788 }
2789
2790 for( const auto& [ id, signal ] : m_userDefinedSignals )
2791 {
2792 int traceType = SPT_UNKNOWN;
2793 wxString vectorName = vectorNameFromSignalName( plotTab, signal, &traceType );
2794
2795 if( simType == ST_AC )
2796 {
2797 int baseType = traceType &= ~( SPT_AC_GAIN | SPT_AC_PHASE );
2798
2799 for( int subType : { baseType | SPT_AC_GAIN, baseType | SPT_AC_PHASE } )
2800 {
2801 if( TRACE* trace = plotTab->GetTrace( vectorName, subType ) )
2802 traceMap[ trace ] = { vectorName, subType, !aFinal };
2803 }
2804 }
2805 else if( simType == ST_SP )
2806 {
2807 int baseType = traceType &= ~( SPT_SP_AMP | SPT_AC_PHASE );
2808
2809 for( int subType : { baseType | SPT_SP_AMP, baseType | SPT_AC_PHASE } )
2810 {
2811 if( TRACE* trace = plotTab->GetTrace( vectorName, subType ) )
2812 traceMap[trace] = { vectorName, subType, !aFinal };
2813 }
2814 }
2815 else
2816 {
2817 if( TRACE* trace = plotTab->GetTrace( vectorName, traceType ) )
2818 traceMap[ trace ] = { vectorName, traceType, !aFinal };
2819 }
2820 }
2821
2822 // Two passes so that DC-sweep sub-traces get deleted and re-created:
2823
2824 for( const auto& [ trace, traceInfo ] : traceMap )
2825 {
2826 if( traceInfo.Vector.IsEmpty() )
2827 plotTab->DeleteTrace( trace );
2828 }
2829
2830 for( const auto& [ trace, info ] : traceMap )
2831 {
2832 std::vector<double> data_x;
2833
2834 if( !info.Vector.IsEmpty() )
2835 updateTrace( info.Vector, info.TraceType, plotTab, &data_x, info.ClearData );
2836 }
2837
2838 plotTab->GetPlotWin()->UpdateAll();
2839
2840 if( aFinal )
2841 {
2842 for( int row = 0; row < m_measurementsGrid->GetNumberRows(); ++row )
2843 UpdateMeasurement( row );
2844
2845 plotTab->ResetScales( true );
2846 }
2847
2848 plotTab->GetPlotWin()->Fit();
2849
2851 }
2852 else if( simType == ST_OP && aFinal )
2853 {
2854 m_simConsole->AppendText( _( "\n\nSimulation results:\n\n" ) );
2855 m_simConsole->SetInsertionPointEnd();
2856
2857 for( const std::string& vec : simulator()->AllVectors() )
2858 {
2859 std::vector<double> val_list = simulator()->GetRealVector( vec, 1 );
2860
2861 if( val_list.empty() )
2862 continue;
2863
2864 wxString value = SPICE_VALUE( val_list[ 0 ] ).ToSpiceString();
2865 wxString signal;
2866 SIM_TRACE_TYPE type = circuitModel()->VectorToSignal( vec, signal );
2867
2868 const size_t tab = 25; //characters
2869 size_t padding = ( signal.length() < tab ) ? ( tab - signal.length() ) : 1;
2870
2871 switch( type )
2872 {
2873 case SPT_VOLTAGE: value.Append( wxS( "V" ) ); break;
2874 case SPT_CURRENT: value.Append( wxS( "A" ) ); break;
2875 case SPT_POWER: value.Append( wxS( "W" ) ); break;
2876 default: value.Append( wxS( "?" ) ); break;
2877 }
2878
2879 msg.Printf( wxT( "%s%s\n" ),
2880 ( signal + wxT( ":" ) ).Pad( padding, wxUniChar( ' ' ) ),
2881 value );
2882
2883 m_simConsole->AppendText( msg );
2884 m_simConsole->SetInsertionPointEnd();
2885
2886 if( type == SPT_VOLTAGE || type == SPT_CURRENT || type == SPT_POWER )
2887 signal = signal.SubString( 2, signal.Length() - 2 );
2888
2889 if( type == SPT_POWER )
2890 signal += wxS( ":power" );
2891
2892 m_schematicFrame->Schematic().SetOperatingPoint( signal, val_list.at( 0 ) );
2893 }
2894 }
2895 else if( simType == ST_PZ && aFinal )
2896 {
2897 m_simConsole->AppendText( _( "\n\nSimulation results:\n\n" ) );
2898 m_simConsole->SetInsertionPointEnd();
2899 simulator()->Command( "print all" );
2900 }
2901}
2902
2903
2905{
2907}
int color
Definition: DXF_plotter.cpp:58
const char * name
Definition: DXF_plotter.cpp:57
constexpr BOX2I KiROUND(const BOX2D &aBoxD)
Definition: box2.h:990
void showPopupMenu(wxMenu &menu, wxGridEvent &aEvent) override
void doPopupSelection(wxCommandEvent &event) override
SIMULATOR_FRAME_UI * m_parent
CURSORS_GRID_TRICKS(SIMULATOR_FRAME_UI *aParent, WX_GRID *aGrid)
The SIMULATOR_FRAME holds the main user-interface for running simulations.
Definition: sim_plot_tab.h:64
const wxRealPoint & GetCoords() const
Definition: sim_plot_tab.h:100
void SetCoordX(double aValue)
bool Find(const wxString &aTerm, int &aMatchersTriggered, int &aPosition)
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
Add mouse and command handling (such as cut, copy, and paste) to a WX_GRID instance.
Definition: grid_tricks.h:61
virtual void doPopupSelection(wxCommandEvent &event)
virtual void showPopupMenu(wxMenu &menu, wxGridEvent &aEvent)
WX_GRID * m_grid
I don't own the grid, but he owns me.
Definition: grid_tricks.h:125
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
wxString ToCSSString() const
Definition: color4d.cpp:147
Definition: kiid.h:49
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
Hold a translatable error message and may be used when throwing exceptions containing a translated er...
Definition: ki_exception.h:46
const wxString What() const
Definition: ki_exception.h:58
void doPopupSelection(wxCommandEvent &event) override
void showPopupMenu(wxMenu &menu, wxGridEvent &aEvent) override
SIMULATOR_FRAME_UI * m_parent
MEASUREMENTS_GRID_TRICKS(SIMULATOR_FRAME_UI *aParent, WX_GRID *aGrid)
static void ConvertToSpiceMarkup(wxString *aNetName)
Remove formatting wrappers and replace illegal spice net name characters with underscores.
const SPICE_ITEM * FindItem(const wxString &aRefName) const
Find and return the item corresponding to aRefName.
A singleton reporter that reports to nowhere.
Definition: reporter.h:203
virtual const wxString GetProjectPath() const
Return the full path of the project.
Definition: project.cpp:135
Holds all the data relating to one schematic.
Definition: schematic.h:77
void SetOperatingPoint(const wxString &aSignal, double aValue)
Set operating points from a .op simulation.
Definition: schematic.h:246
void ClearOperatingPoints()
Clear operating points from a .op simulation.
Definition: schematic.h:238
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
EESCHEMA_SETTINGS * eeconfig() const
Schematic editor (Eeschema) main window.
void RefreshOperatingPointDisplay()
Refresh the display of any operaintg points.
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag and update other data struc...
SCHEMATIC & Schematic() const
void UpdateItem(EDA_ITEM *aItem, bool isAddOrDelete=false, bool aUpdateRtree=false) override
Mark an item for refresh.
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:166
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
SCH_ITEM * GetItem(const KIID &aID) const
Fetch a SCH_ITEM by ID.
Schematic symbol object.
Definition: sch_symbol.h:104
void GetFields(std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly)
Populate a std::vector with SCH_FIELDs.
Definition: sch_symbol.cpp:983
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const override
Definition: sch_symbol.cpp:736
void doPopupSelection(wxCommandEvent &event) override
void showPopupMenu(wxMenu &menu, wxGridEvent &aEvent) override
SIMULATOR_FRAME_UI * m_parent
SIGNALS_GRID_TRICKS(SIMULATOR_FRAME_UI *aParent, WX_GRID *aGrid)
Class SIMULATOR_FRAME_UI_BASE.
wxSplitterWindow * m_splitterLeftRight
wxSplitterWindow * m_splitterMeasurements
wxSplitterWindow * m_splitterCursors
wxSplitterWindow * m_splitterPlotAndConsole
wxSplitterWindow * m_splitterSignals
The SIMULATOR_FRAME_UI holds the main user-interface for running simulations.
SIM_TAB * NewSimTab(const wxString &aSimCommand)
Create a new simulation tab for a given simulation type.
void SetUserDefinedSignals(const std::map< int, wxString > &aSignals)
void updatePlotCursors()
Update the cursor values (in the grid) and graphics (in the plot window).
void OnSimRefresh(bool aFinal)
void onPlotClose(wxAuiNotebookEvent &event) override
void onPlotChanged(wxAuiNotebookEvent &event) override
void rebuildSignalsGrid(wxString aFilter)
Rebuild the filtered list of signals in the signals grid.
void DoFourier(const wxString &aSignal, const wxString &aFundamental)
void rebuildMeasurementsGrid()
Rebuild the measurements grid for the current plot.
std::list< TUNER_SLIDER * > m_tuners
SPICE expressions need quoted versions of the netnames since KiCad allows '-' and '/' in netnames.
void rebuildSignalsList()
Rebuild the list of signals available from the netlist.
bool loadLegacyWorkbook(const wxString &aPath)
void UpdateMeasurement(int aRow)
Update a measurement in the measurements grid.
wxString getNoiseSource() const
std::vector< wxString > SimPlotVectors() const
void applyUserDefinedSignals()
Apply user-defined signals to the SPICE session.
std::map< wxString, wxString > m_quotedNetnames
SIM_PREFERENCES m_preferences
void DeleteMeasurement(int aRow)
Delete a row from the measurements grid.
SCH_EDIT_FRAME * m_schematicFrame
wxString vectorNameFromSignalName(SIM_PLOT_TAB *aPlotTab, const wxString &aSignalName, int *aTraceType)
Get the simulator output vector name for a given signal name and type.
void updateSignalsGrid()
Update the values in the signals grid.
void onCursorsGridCellChanged(wxGridEvent &aEvent) override
void onPlotDragged(wxAuiNotebookEvent &event) override
std::vector< wxString > Signals() const
bool SaveWorkbook(const wxString &aPath)
Save plot, signal, cursor, measurement, etc.
std::vector< wxString > m_signals
SIM_TAB * GetCurrentSimTab() const
Return the currently opened plot panel (or NULL if there is none).
bool LoadWorkbook(const wxString &aPath)
Load plot, signal, cursor, measurement, etc.
SPICE_VALUE_FORMAT GetMeasureFormat(int aRow) const
Get/Set the format of a value in the measurements grid.
std::map< int, wxString > m_userDefinedSignals
void UpdateTunerValue(const SCH_SHEET_PATH &aSheetPath, const KIID &aSymbol, const wxString &aRef, const wxString &aValue)
Safely update a field of the associated symbol without dereferencing the symbol.
void AddTrace(const wxString &aName, SIM_TRACE_TYPE aType)
Add a new trace to the current plot.
void onPlotClosed(wxAuiNotebookEvent &event) override
void RemoveTuner(TUNER_SLIDER *aTuner)
Remove an existing tuner.
void SaveSettings(EESCHEMA_SETTINGS *aCfg)
std::shared_ptr< SPICE_CIRCUIT_MODEL > circuitModel() const
void OnFilterText(wxCommandEvent &aEvent) override
void onMeasurementsGridCellChanged(wxGridEvent &aEvent) override
void applyTuners()
Apply component values specified using tuner sliders to the current netlist.
bool loadJsonWorkbook(const wxString &aPath)
void OnFilterMouseMoved(wxMouseEvent &aEvent) override
void AddMeasurement(const wxString &aCmd)
Add a measurement to the measurements grid.
void onPlotChanging(wxAuiNotebookEvent &event) override
std::shared_ptr< SPICE_SIMULATOR > simulator() const
void onPlotCursorUpdate(wxCommandEvent &aEvent)
void onSignalsGridCellChanged(wxGridEvent &aEvent) override
void SetCursorFormat(int aCursorId, int aValueCol, const SPICE_VALUE_FORMAT &aFormat)
void InitWorkbook()
Load the currently active workbook stored in the project settings.
SIM_TRACE_TYPE getXAxisType(SIM_TYPE aType) const
Return X axis for a given simulation type.
void SetMeasureFormat(int aRow, const SPICE_VALUE_FORMAT &aFormat)
void OnSimReport(const wxString &aMsg)
void ApplyPreferences(const SIM_PREFERENCES &aPrefs)
Called when settings are changed via the common Preferences dialog.
const SPICE_CIRCUIT_MODEL * GetExporter() const
Return the netlist exporter object used for simulations.
SIMULATOR_FRAME * m_simulatorFrame
void AddTuner(const SCH_SHEET_PATH &aSheetPath, SCH_SYMBOL *aSymbol)
Add a tuner for a symbol.
SPICE_VALUE_FORMAT GetCursorFormat(int aCursorId, int aValueCol) const
Get/Set the number of significant digits and the range for formatting a cursor value.
void OnUpdateUI(wxUpdateUIEvent &event) override
void updateTrace(const wxString &aVectorName, int aTraceType, SIM_PLOT_TAB *aPlotTab, std::vector< double > *aDataX=nullptr, bool aClearData=false)
Update a trace in a particular SIM_PLOT_TAB.
SIMULATOR_FRAME_UI(SIMULATOR_FRAME *aSimulatorFrame, SCH_EDIT_FRAME *aSchematicFrame)
SPICE_VALUE_FORMAT m_cursorFormats[3][2]
void LoadSettings(EESCHEMA_SETTINGS *aCfg)
The SIMULATOR_FRAME holds the main user-interface for running simulations.
bool LoadSimulator(const wxString &aSimCommand, unsigned aSimOptions)
Check and load the current netlist into the simulator.
std::shared_ptr< SPICE_CIRCUIT_MODEL > GetCircuitModel() const
SIM_TYPE GetCurrentSimType() const
void OnModify() override
Must be called after a model change in order to set the "modify" flag and do other frame-specific pro...
bool SimFinished() const
int GetCurrentOptions() const
std::shared_ptr< SPICE_SIMULATOR > GetSimulator() const
SIM_MODEL & CreateModel(SIM_MODEL::TYPE aType, const std::vector< SCH_PIN * > &aPins, REPORTER &aReporter)
virtual const PARAM * GetTunerParam() const
Definition: sim_model.h:484
const SPICE_GENERATOR & SpiceGenerator() const
Definition: sim_model.h:435
void WriteFields(std::vector< SCH_FIELD > &aFields) const
Definition: sim_model.cpp:445
void SetParamValue(int aParamIndex, const std::string &aValue, SIM_VALUE::NOTATION aNotation=SIM_VALUE::NOTATION::SI)
Definition: sim_model.cpp:845
static void FillDefaultColorList(bool aWhiteBg)
Fills m_colorList by a default set of colors.
bool DeleteTrace(const wxString &aVectorName, int aTraceType)
void EnableCursor(const wxString &aVectorName, int aType, int aCursorId, bool aEnable, const wxString &aSignalName)
Reset scale ranges to fit the current traces.
wxString GetLabelY1() const
Definition: sim_plot_tab.h:208
mpWindow * GetPlotWin() const
Definition: sim_plot_tab.h:350
void ShowGrid(bool aEnable)
Definition: sim_plot_tab.h:268
wxString GetUnitsY2() const
void SetY2Scale(bool aLock, double aMin, double aMax)
TRACE * GetTrace(const wxString &aVecName, int aType) const
Definition: sim_plot_tab.h:261
wxString GetLabelX() const
Definition: sim_plot_tab.h:203
const std::map< wxString, TRACE * > & GetTraces() const
Definition: sim_plot_tab.h:256
wxString GetLabelY3() const
Definition: sim_plot_tab.h:218
void SetY1Scale(bool aLock, double aMin, double aMax)
void SetY3Scale(bool aLock, double aMin, double aMax)
std::vector< std::pair< wxString, wxString > > & Measurements()
Definition: sim_plot_tab.h:360
void UpdateTraceStyle(TRACE *trace)
Update plot colors.
void SetLegendPosition(const wxPoint &aPosition)
Definition: sim_plot_tab.h:309
void ResetScales(bool aIncludeX)
Update trace line style.
void UpdatePlotColors()
void ShowLegend(bool aEnable)
Definition: sim_plot_tab.h:293
wxString GetLabelY2() const
Definition: sim_plot_tab.h:213
void SetTraceData(TRACE *aTrace, std::vector< double > &aX, std::vector< double > &aY, int aSweepCount, size_t aSweepSize)
wxString GetUnitsX() const
void EnsureThirdYAxisExists()
TRACE * GetOrAddTrace(const wxString &aVectorName, int aType)
void SetDottedSecondary(bool aEnable)
Draw secondary signal traces (current or phase) with dotted lines.
Definition: sim_plot_tab.h:319
void ApplyPreferences(const SIM_PREFERENCES &aPrefs) override
Definition: sim_plot_tab.h:198
wxString GetUnitsY1() const
wxString GetUnitsY3() const
int GetSimOptions() const
Definition: sim_tab.h:55
SIM_TYPE GetSimType() const
Definition: sim_tab.cpp:75
const wxString & GetSimCommand() const
Definition: sim_tab.h:52
static bool IsPlottable(SIM_TYPE aSimType)
Definition: sim_tab.cpp:53
void SetSimOptions(int aOptions)
Definition: sim_tab.h:56
wxString GetLastSchTextSimCommand() const
Definition: sim_tab.h:58
void SetSpicePlotName(const wxString &aPlotName)
Definition: sim_tab.h:62
static std::string ToSpice(const std::string &aString)
Definition: sim_value.cpp:419
Special netlist exporter flavor that allows one to override simulation commands.
static SIM_TYPE CommandToSimType(const wxString &aCmd)
Return simulation type basing on a simulation command directive.
virtual std::string TunerCommand(const SPICE_ITEM &aItem, double aValue) const
static wxString TypeToName(SIM_TYPE aType, bool aShortName)
Return a string with simulation name based on enum.
Helper class to recognize Spice formatted values.
Definition: spice_value.h:56
wxString ToString() const
Return string value as when converting double to string (e.g.
wxString ToSpiceString() const
Return string value in Spice format (e.g.
double ToDouble() const
SUPPRESS_GRID_CELL_EVENTS(SIMULATOR_FRAME_UI *aFrame)
SIMULATOR_FRAME_UI * m_frame
void SetTraceColour(const wxColour &aColour)
Definition: sim_plot_tab.h:181
CURSOR * GetCursor(int aCursorId)
Definition: sim_plot_tab.h:176
Custom widget to handle quick component values modification and simulation on the fly.
Definition: tuner_slider.h:44
void ClearRows()
wxWidgets recently added an ASSERT which fires if the position is greater than or equal to the number...
Definition: wx_grid.h:184
A wrapper for reporting to a wxString object.
Definition: reporter.h:171
bool HasMessage() const override
Returns true if the reporter client is non-empty.
Definition: reporter.cpp:97
REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED) override
Report a string with a given severity.
Definition: reporter.cpp:76
const wxString & GetMessages() const
Definition: reporter.cpp:84
A KICAD version of wxTextEntryDialog which supports the various improvements/work-arounds from DIALOG...
wxString GetValue() const
const wxString & GetName() const
Get layer name.
Definition: mathplot.h:239
const wxPen & GetPen() const
Get pen set for this layer.
Definition: mathplot.h:254
Canvas for plotting mpLayer implementations.
Definition: mathplot.h:908
int GetMarginLeft() const
Definition: mathplot.h:1219
void SetMargins(int top, int right, int bottom, int left)
Set window margins, creating a blank area where some kinds of layers cannot draw.
Definition: mathplot.cpp:2385
int GetMarginTop() const
Definition: mathplot.h:1213
void UpdateAll()
Refresh display.
Definition: mathplot.cpp:2286
int GetMarginRight() const
Definition: mathplot.h:1215
int GetMarginBottom() const
Definition: mathplot.h:1217
void LockY(bool aLock)
Definition: mathplot.h:1263
bool AddLayer(mpLayer *layer, bool refreshDisplay=true)
Add a plot layer to the canvas.
Definition: mathplot.cpp:1970
void Fit() override
Set view to fit global bounding box of all plot layers and refresh display.
Definition: mathplot.cpp:1614
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:195
This file is part of the common library.
#define _(s)
Abstract pattern-matching tool and implementations.
@ CTX_SIGNAL
@ GRIDTRICKS_ID_COPY
Definition: grid_tricks.h:43
@ GRIDTRICKS_FIRST_CLIENT_ID
Definition: grid_tricks.h:48
static const std::string WorkbookFileExtension
#define traceSettings
Definition: json_settings.h:52
KICOMMON_API wxFont GetStatusFont(wxWindow *aWindow)
Definition: ui_common.cpp:130
see class PGM_BASE
SIM_TRACE_TYPE
Definition: sim_types.h:50
@ SPT_TIME
Definition: sim_types.h:61
@ SPT_AC_PHASE
Definition: sim_types.h:54
@ SPT_SWEEP
Definition: sim_types.h:64
@ SPT_UNKNOWN
Definition: sim_types.h:67
@ SPT_AC_GAIN
Definition: sim_types.h:55
@ SPT_Y_AXIS_MASK
Definition: sim_types.h:58
@ SPT_SP_AMP
Definition: sim_types.h:57
@ SPT_VOLTAGE
Definition: sim_types.h:52
@ SPT_POWER
Definition: sim_types.h:56
@ SPT_CURRENT
Definition: sim_types.h:53
@ SPT_LIN_FREQUENCY
Definition: sim_types.h:62
SIM_TYPE
< Possible simulation types
Definition: sim_types.h:32
@ ST_SP
Definition: sim_types.h:43
@ ST_TRAN
Definition: sim_types.h:42
@ ST_UNKNOWN
Definition: sim_types.h:33
@ ST_NOISE
Definition: sim_types.h:37
@ ST_AC
Definition: sim_types.h:34
@ ST_DISTO
Definition: sim_types.h:36
@ ST_TF
Definition: sim_types.h:41
@ ST_SENS
Definition: sim_types.h:40
@ ST_DC
Definition: sim_types.h:35
@ ST_OP
Definition: sim_types.h:38
@ ST_FFT
Definition: sim_types.h:44
@ ST_PZ
Definition: sim_types.h:39
void sortSignals(std::vector< wxString > &signals)
wxString vectorNameFromSignalId(int aUserDefinedSignalId)
MEASUREMENTS_GIRD_COLUMNS
@ COL_MEASUREMENT_FORMAT
@ COL_MEASUREMENT_VALUE
@ COL_MEASUREMENT
CURSORS_GRID_COLUMNS
@ COL_CURSOR_NAME
@ COL_CURSOR_SIGNAL
@ COL_CURSOR_X
@ COL_CURSOR_Y
SIGNALS_GRID_COLUMNS
@ COL_SIGNAL_SHOW
@ COL_SIGNAL_NAME
@ COL_CURSOR_1
@ COL_SIGNAL_COLOR
@ COL_CURSOR_2
#define ID_SIM_REFRESH
SIM_TRACE_TYPE operator|(SIM_TRACE_TYPE aFirst, SIM_TRACE_TYPE aSecond)
#define REFRESH_INTERVAL
@ MYID_MEASURE_INTEGRAL
@ MYID_MEASURE_MAX_AT
@ MYID_MEASURE_AVG
@ MYID_MEASURE_MAX
@ MYID_FOURIER
@ MYID_FORMAT_VALUE
@ MYID_MEASURE_RMS
@ MYID_DELETE_MEASUREMENT
@ MYID_MEASURE_MIN
@ MYID_MEASURE_MIN_AT
@ MYID_MEASURE_PP
const int scale
std::vector< FAB_LAYER_COLOR > dummy
wxString UnescapeString(const wxString &aSource)
const INFO & info
Definition: sim_model.h:401
Contains preferences pertaining to the simulator.
SPICE_VALUE m_vincrement
const SIM_MODEL * model
A SPICE_VALUE_FORMAT holds precision and range info for formatting values.Helper class to handle Spic...
Definition: spice_value.h:43
wxString ToString() const
Definition: spice_value.cpp:58
void UpdateUnits(const wxString &aUnits)
Definition: spice_value.cpp:64
void FromString(const wxString &aString)
Definition: spice_value.cpp:41
VECTOR3I res
Definition of file extensions used in Kicad.