simulator_frame.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2016-2023 CERN
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Tomasz Wlostowski <[email protected]>
 * @author Maciej Suminski <[email protected]>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef SIMULATOR_FRAME_H
#define SIMULATOR_FRAME_H
 
 
#include <sim/simulator_frame_ui_base.h>
#include <sim/sim_types.h>
 
#include <kiway_player.h>
#include <dialogs/dialog_sim_command.h>
 
#include <wx/event.h>
 
#include <list>
#include <memory>
#include <map>
 
class SCH_EDIT_FRAME;
class SCH_SYMBOL;
class SIMULATOR_FRAME_UI;
class SIM_CONSOLE_REPORTER;
class SIM_FRAME_STATE_LISTENER;
class ACTION_TOOLBAR;
class SPICE_SIMULATOR;
 

class SIMULATOR_INIT_ERR : public std::runtime_error
{
public:
    explicit SIMULATOR_INIT_ERR(const std::string& what_arg)
        : std::runtime_error(what_arg) {}
};
 

 
 
class SIMULATOR_FRAME : public KIWAY_PLAYER
{
public:
    SIMULATOR_FRAME( KIWAY* aKiway, wxWindow* aParent );
    ~SIMULATOR_FRAME();

    bool LoadSimulator( const wxString& aSimCommand, unsigned aSimOptions );

    void ReloadSimulator( const wxString& aSimCommand, unsigned aSimOptions );
 
    void StartSimulation();

    SIM_TAB* NewSimTab( const wxString& aSimCommand );

    bool EditAnalysis();

    const std::vector<wxString> SimPlotVectors();

    const std::vector<wxString> Signals();
 
    const std::map<int, wxString>& UserDefinedSignals();
 
    void SetUserDefinedSignals( const std::map<int, wxString>& aSignals );

    void AddVoltageTrace( const wxString& aNetName );

    void AddCurrentTrace( const wxString& aDeviceName );

    void AddTuner( const SCH_SHEET_PATH& aSheetPath, SCH_SYMBOL* aSymbol );

    SIM_TAB* GetCurrentSimTab() const;
 
    void ToggleSimConsole();
 
    void ToggleSimSidePanel();

    void ToggleDarkModePlots();

    void ToggleSmithChart();
 
    void ShowChangedLanguage() override;

    bool LoadWorkbook( const wxString& aPath );

    bool SaveWorkbook( const wxString& aPath );
 
    void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
 
    void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
 
    void CommonSettingsChanged( int aFlags ) override;
 
    WINDOW_SETTINGS* GetWindowSettings( APP_SETTINGS_BASE* aCfg ) override;
 
    SCH_EDIT_FRAME* GetSchematicFrame() const { return m_schematicFrame; }
 
    std::shared_ptr<SPICE_CIRCUIT_MODEL> GetCircuitModel() const { return m_circuitModel; }
 
    std::shared_ptr<SPICE_SIMULATOR> GetSimulator() const { return m_simulator; }
 
    wxString GetCurrentSimCommand() const;
    SIM_TYPE GetCurrentSimType() const;
    int GetCurrentOptions() const;
 
    bool SimFinished() const { return m_simFinished; }
 
    wxString TakeSimReportMessages();
 
    // Simulator doesn't host a canvas
    wxWindow* GetToolCanvas() const override { return nullptr; }

    void UpdateTitle();
 
    void OnModify() override;
 
    DECLARE_EVENT_TABLE()
 
private:
    void setupTools();
    void doReCreateMenuBar() override;
 
    void setupUIConditions() override;
 
    void showNetlistErrors( const WX_STRING_REPORTER& aReporter );

    void destroyTabPlot( SIM_TAB* aSimTab );
 
    bool canCloseWindow( wxCloseEvent& aEvent ) override;
    void doCloseWindow() override;
 
    void onUpdateSim( wxCommandEvent& aEvent );
    void onSimStarted( wxCommandEvent& aEvent );
    void onSimFinished( wxCommandEvent& aEvent );
 
    void onExit( wxCommandEvent& event );
 
private:
    SCH_EDIT_FRAME*                      m_schematicFrame;
    ACTION_TOOLBAR*                      m_toolBar;
    SIMULATOR_FRAME_UI*                  m_ui;
 
    std::shared_ptr<SPICE_SIMULATOR>     m_simulator;
    SIM_CONSOLE_REPORTER*                m_consoleReporter;
    SIM_FRAME_STATE_LISTENER*            m_stateListener;
    std::shared_ptr<SPICE_CIRCUIT_MODEL> m_circuitModel;
 
    bool                                 m_simFinished;
    bool                                 m_workbookModified;
};
 
// Commands
wxDECLARE_EVENT( EVT_SIM_UPDATE, wxCommandEvent );
 
// Notifications
wxDECLARE_EVENT( EVT_SIM_STARTED, wxCommandEvent );
wxDECLARE_EVENT( EVT_SIM_FINISHED, wxCommandEvent );
 
#endif // SIMULATOR_FRAME_H