80 wxCommandEvent*
event =
new wxCommandEvent( EVT_SIM_REPORT );
81 event->SetString( aText );
93 wxCommandEvent*
event =
nullptr;
97 case SIM_IDLE:
event =
new wxCommandEvent( EVT_SIM_FINISHED );
break;
98 case SIM_RUNNING:
event =
new wxCommandEvent( EVT_SIM_STARTED );
break;
99 default: wxFAIL;
return;
119 m_schematicFrame(
nullptr ),
120 m_toolBar(
nullptr ),
122 m_simFinished( false ),
123 m_workbookModified( false )
126 wxASSERT( m_schematicFrame );
133 wxBoxSizer* mainSizer =
new wxBoxSizer( wxVERTICAL );
134 SetSizer( mainSizer );
137 mainSizer->Add( m_infoBar, 0, wxEXPAND, 0 );
139 m_tbTopMain =
new ACTION_TOOLBAR(
this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
140 wxAUI_TB_DEFAULT_STYLE|wxAUI_TB_HORZ_LAYOUT|wxAUI_TB_PLAIN_BACKGROUND );
141 m_tbTopMain->Realize();
142 mainSizer->Add( m_tbTopMain, 0, wxEXPAND, 5 );
145 mainSizer->Add( m_ui, 1, wxEXPAND, 5 );
156 if( cfg->GetWorkbookFilename().IsEmpty() )
162 m_simulator->SetReporter( m_reporter );
164 m_circuitModel = std::make_shared<SPICE_CIRCUIT_MODEL>( &m_schematicFrame->Schematic() );
171 m_tbTopMain->SetToolManager( m_toolManager );
173 m_toolbarSettings = GetToolbarSettings<SIMULATOR_TOOLBAR_SETTINGS>(
"sim-toolbars" );
194 m_ui->SetSubWindowsSashSize();
199 m_ui->InitWorkbook();
208 m_simulator->Attach(
nullptr, wxEmptyString, 0, wxEmptyString, devnull );
283 return &cfg->m_Simulator.window;
285 wxFAIL_MSG( wxT(
"SIMULATOR not running with EESCHEMA_SETTINGS" ) );
308 return simTab->GetSimOptions();
317 bool readOnly =
false;
320 wxFileName filename =
Prj().
AbsolutePath( cfg->GetWorkbookFilename() );
322 if( filename.IsOk() && filename.FileExists() )
325 readOnly = !filename.IsFileWritable();
329 title = wxT(
"*" ) + filename.GetName();
331 title = filename.GetName();
334 title += wxS(
" " ) +
_(
"[Read Only]" );
337 title += wxS(
" " ) +
_(
"[Unsaved]" );
339 title += wxT(
" \u2014 " ) +
_(
"SPICE Simulator" );
346#define MAX_MESSAGES 20
353 wxArrayString lines = wxSplit( aReporter.
GetMessages(),
'\n' );
358 lines.Add( wxS(
"..." ) );
364 wxJoin( lines,
'\n' ) );
369 wxJoin( lines,
'\n' ) );
412 if( simTab->
GetSimCommand().Upper().StartsWith( wxT(
"FFT" ) )
413 || simTab->
GetSimCommand().Upper().Contains( wxT(
"\nFFT" ) ) )
415 wxString tranSpicePlot;
420 if( tranSpicePlot.IsEmpty() )
423 "will be used for the fast Fourier transform." ) );
427 m_simulator->Command(
"setplot " + tranSpicePlot.ToStdString() );
429 wxArrayString commands = wxSplit( simTab->
GetSimCommand(),
'\n' );
431 for(
const wxString& command : commands )
454 ||
IsOK(
this,
_(
"Schematic sheet simulation command directive has changed. "
455 "Do you wish to update the Simulation Command?" ) ) )
467 std::unique_lock<std::mutex> simulatorLock(
m_simulator->GetMutex(), std::try_to_lock );
469 if( simulatorLock.owns_lock() )
630 wxFileName filename =
m_simulator->Settings()->GetWorkbookFilename();
632 if( filename.GetName().IsEmpty() )
634 if(
Prj().GetProjectName().IsEmpty() )
635 filename.SetFullName( wxT(
"noname.wbk" ) );
637 filename.SetFullName(
Prj().GetProjectName() + wxT(
".wbk" ) );
677 auto showGridCondition =
684 auto showLegendCondition =
691 auto showDottedCondition =
698 auto darkModePlotCondition =
743 auto isSimConsoleShown =
754 auto isSimSidePanelShown =
766#define ENABLE( x ) ACTION_CONDITIONS().Enable( x )
767#define CHECK( x ) ACTION_CONDITIONS().Check( x )
803 SetCursor( wxCURSOR_ARROWWAIT );
829 SetCursor( wxNullCursor );
846 static bool updateInProgress =
false;
849 if( updateInProgress )
852 updateInProgress =
true;
857 std::unique_lock<std::mutex> simulatorLock(
m_simulator->GetMutex(), std::try_to_lock );
859 if( simulatorLock.owns_lock() )
869 updateInProgress =
false;
881 if( aEvent.GetId() == wxID_EXIT )
884 if( aEvent.GetId() == wxID_CLOSE )
constexpr EDA_IU_SCALE unityScale
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
static TOOL_ACTION toggleGrid
static TOOL_ACTION cancelInteractive
static TOOL_ACTION zoomRedo
static TOOL_ACTION zoomUndo
Manage TOOL_ACTION objects.
void SetConditions(const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
Set the conditions the UI elements for activating a specific tool action should use for determining t...
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Handle actions that are shared between different applications.
void SetPlotSettings(const SIM_TAB *aSimTab)
void SetSimCommand(const wxString &aCommand)
void ApplySettings(SIM_TAB *aTab)
void SetSimOptions(int aOptions)
const wxString & GetSimCommand() const
virtual APP_SETTINGS_BASE * config() const
Return the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
void CommonSettingsChanged(int aFlags) override
Notification event that some of the common (suite-wide) settings have changed.
void ShowChangedLanguage() override
Redraw the menus and what not in current language.
virtual void setupUIConditions()
Setup the UI conditions for the various actions and their controls in this frame.
virtual void OnModify()
Must be called after a model change in order to set the "modify" flag and do other frame-specific pro...
virtual void LoadSettings(APP_SETTINGS_BASE *aCfg)
Load common frame parameters from a configuration file.
virtual void SaveSettings(APP_SETTINGS_BASE *aCfg)
Save common frame parameters to a configuration data file.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
A wxFrame capable of the OpenProjectFiles function, meaning it can load a portion of a KiCad project.
bool Destroy() override
Our version of Destroy() which is virtual from wxWidgets.
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
A singleton reporter that reports to nowhere.
SCHEMATIC_SETTINGS * m_SchematicSettings
virtual PROJECT_FILE & GetProjectFile() const
virtual const wxString AbsolutePath(const wxString &aFileName) const
Fix up aFileName if it is relative to the project's directory to be an absolute path and filename.
A pure virtual class used to derive REPORTER objects from.
virtual bool HasMessageOfSeverity(int aSeverityMask) const
Returns true if the reporter has one or more messages matching the specified severity mask.
std::shared_ptr< NGSPICE_SETTINGS > m_NgspiceSettings
Ngspice simulator settings.
Holds all the data relating to one schematic.
void ClearOperatingPoints()
Clear operating points from a .op simulation.
static TOOL_ACTION toggleSimConsole
static TOOL_ACTION exportPlotToClipboard
static TOOL_ACTION saveWorkbookAs
static TOOL_ACTION toggleSimSidePanel
static TOOL_ACTION exportPlotAsCSV
static TOOL_ACTION simAnalysisProperties
static TOOL_ACTION toggleDottedSecondary
static TOOL_ACTION simTune
static TOOL_ACTION toggleDarkModePlots
static TOOL_ACTION exportPlotAsPNG
static TOOL_ACTION exportPlotToSchematic
static TOOL_ACTION runSimulation
static TOOL_ACTION newAnalysisTab
static TOOL_ACTION simProbe
static TOOL_ACTION showNetlist
static TOOL_ACTION openWorkbook
static TOOL_ACTION saveWorkbook
static TOOL_ACTION toggleLegend
static TOOL_ACTION stopSimulation
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
Schematic editor (Eeschema) main window.
void RefreshOperatingPointDisplay()
Refresh the display of any operating points.
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag and update other data struc...
bool ReadyToNetlist(const wxString &aAnnotateMessage)
Check if we are ready to write a netlist file for the current schematic.
void RecalculateConnections(SCH_COMMIT *aCommit, SCH_CLEANUP_FLAGS aCleanupFlags, PROGRESS_REPORTER *aProgressReporter=nullptr)
Generate the connection data for the entire schematic hierarchy.
SCHEMATIC & Schematic() const
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
static bool ShowAlways(const SELECTION &aSelection)
The default condition function (always returns true).
Handle actions for the various symbol editor and viewers.
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 OnSimRefresh(bool aFinal)
SIM_TAB * GetSimTab(SIM_TYPE aType) const
void ToggleSimSidePanel()
std::vector< wxString > SimPlotVectors() const
std::vector< wxString > Signals() const
bool SaveWorkbook(const wxString &aPath)
Save plot, signal, cursor, measurement, etc.
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.
bool DarkModePlots() const
const std::map< int, wxString > & UserDefinedSignals()
void AddTrace(const wxString &aName, SIM_TRACE_TYPE aType)
Add a new trace to the current plot.
void SaveSettings(EESCHEMA_SETTINGS *aCfg)
int GetSimTabIndex(SIM_TAB *aPlot) const
void ToggleDarkModePlots()
void OnPlotSettingsChanged()
void OnSimReport(const wxString &aMsg)
void ApplyPreferences(const SIM_PREFERENCES &aPrefs)
Called when settings are changed via the common Preferences dialog.
void ShowChangedLanguage()
void AddTuner(const SCH_SHEET_PATH &aSheetPath, SCH_SYMBOL *aSymbol)
Add a tuner for a symbol.
bool IsSimSidePanelShown()
void LoadSettings(EESCHEMA_SETTINGS *aCfg)
The SIMULATOR_FRAME holds the main user-interface for running simulations.
SIM_TAB * GetCurrentSimTab() const
Return the current tab (or NULL if there is none).
void ShowChangedLanguage() override
bool canCloseWindow(wxCloseEvent &aEvent) override
void onSimFinished(wxCommandEvent &aEvent)
bool LoadSimulator(const wxString &aSimCommand, unsigned aSimOptions)
Check and load the current netlist into the simulator.
void onSimReport(wxCommandEvent &aEvent)
wxString GetCurrentSimCommand() const
void CommonSettingsChanged(int aFlags) override
Notification event that some of the common (suite-wide) settings have changed.
void showNetlistErrors(const WX_STRING_REPORTER &aReporter)
void onExit(wxCommandEvent &event)
std::shared_ptr< SPICE_SIMULATOR > m_simulator
SIM_TYPE GetCurrentSimType() const
void setupUIConditions() override
Setup the UI conditions for the various actions and their controls in this frame.
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
void AddCurrentTrace(const wxString &aDeviceName)
Add a current trace for a given device to the current plot.
void OnModify() override
Must be called after a model change in order to set the "modify" flag and do other frame-specific pro...
bool SaveWorkbook(const wxString &aPath)
Save plot, signal, cursor, measurement, etc.
const std::vector< wxString > Signals()
void doCloseWindow() override
const std::vector< wxString > SimPlotVectors()
void AddVoltageTrace(const wxString &aNetName)
Add a voltage trace for a given net to the current plot.
void ToggleDarkModePlots()
Toggle dark-mode of the plot tabs.
SIM_THREAD_REPORTER * m_reporter
void AddTuner(const SCH_SHEET_PATH &aSheetPath, SCH_SYMBOL *aSymbol)
Add a tuner for a symbol.
void onSimStarted(wxCommandEvent &aEvent)
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
std::shared_ptr< SPICE_CIRCUIT_MODEL > m_circuitModel
SIM_TAB * NewSimTab(const wxString &aSimCommand)
Create a new plot tab for a given simulation type.
bool EditAnalysis()
Shows a dialog for editing the current tab's simulation command, or creating a new tab with a differe...
int GetCurrentOptions() const
bool LoadWorkbook(const wxString &aPath)
Load plot, signal, cursor, measurement, etc.
WINDOW_SETTINGS * GetWindowSettings(APP_SETTINGS_BASE *aCfg) override
Return a pointer to the window settings for this frame.
void onUpdateSim(wxCommandEvent &aEvent)
void UpdateTitle()
Set the main window title bar text.
const std::map< int, wxString > & UserDefinedSignals()
void SetUserDefinedSignals(const std::map< int, wxString > &aSignals)
void ToggleSimSidePanel()
void ReloadSimulator(const wxString &aSimCommand, unsigned aSimOptions)
Re-send the current command and settings to the simulator.
SCH_EDIT_FRAME * m_schematicFrame
SIMULATOR_FRAME_UI * m_ui
Simple error container for failure to init the simulation engine and ultimately abort the frame const...
Interface to receive simulation updates from SPICE_SIMULATOR class.
static std::shared_ptr< SPICE_SIMULATOR > CreateInstance(const std::string &aName)
mpWindow * GetPlotWin() const
bool GetDottedSecondary() const
Turn on/off the cursor for a particular trace.
bool IsLegendShown() const
int GetSimOptions() const
const wxString & GetSpicePlotName() const
void SetLastSchTextSimCommand(const wxString &aCmd)
void SetSimCommand(const wxString &aSimCommand)
const wxString & GetSimCommand() const
wxString GetLastSchTextSimCommand() const
void SetSpicePlotName(const wxString &aPlotName)
SIMULATOR_FRAME * m_parent
SIM_THREAD_REPORTER(SIMULATOR_FRAME *aParent)
REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED) override
Report a string with a given severity.
bool HasMessage() const override
Returns true if the reporter client is non-empty.
void OnSimStateChange(SIMULATOR *aObject, SIM_STATE aNewState) override
static SIM_TYPE CommandToSimType(const wxString &aCmd)
Return simulation type basing on a simulation command directive.
A modified version of the wxInfoBar class that allows us to:
A wrapper for reporting to a wxString object.
bool HasMessage() const override
Returns true if the reporter client is non-empty.
const wxString & GetMessages() const
int RedoZoomStackSize() const
int UndoZoomStackSize() const
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
bool HandleUnsavedChanges(wxWindow *aParent, const wxString &aMessage, const std::function< bool()> &aSaveFunction)
Display a dialog with Save, Cancel and Discard Changes buttons.
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
This file is part of the common library.
SIM_TYPE
< Possible simulation types
wxDEFINE_EVENT(EVT_SIM_UPDATE, wxCommandEvent)
static WX_STRING_REPORTER s_reporter
KIWAY Kiway(KFCTL_STANDALONE)
Store the common settings that are saved and loaded for each window / frame.
Definition of file extensions used in Kicad.