simulator_frame_ui.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/>.
 */
 
#pragma once
 
 
#include <sim/simulator_frame_ui_base.h>
#include <sim/sim_types.h>
#include <sim/sim_plot_tab.h>
#include <sim/sim_preferences.h>
 
#include <wx/event.h>
 
class SCH_EDIT_FRAME;
class SCH_SYMBOL;
 
class SPICE_SIMULATOR;
class SPICE_SETTINGS;
class EESCHEMA_SETTINGS;
class SPICE_CIRCUIT_MODEL;
 
class TUNER_SLIDER;
class STD_BITMAP_BUTTON;
 

class SIMULATOR_FRAME_UI : public SIMULATOR_FRAME_UI_BASE
{
public:
    SIMULATOR_FRAME_UI( SIMULATOR_FRAME* aSimulatorFrame, SCH_EDIT_FRAME* aSchematicFrame );
    ~SIMULATOR_FRAME_UI();

    SIM_TAB* NewSimTab( const wxString& aSimCommand );
 
    std::vector<wxString> SimPlotVectors() const;
 
    std::vector<wxString> Signals() const;
 
    const std::map<int, wxString>& UserDefinedSignals() { return m_userDefinedSignals; }
    void SetUserDefinedSignals( const std::map<int, wxString>& aSignals );

    void CreateNewCursor();

    void DeleteCursor();

    void AddTrace( const wxString& aName, SIM_TRACE_TYPE aType );

    SPICE_VALUE_FORMAT GetCursorFormat( int aCursorId, int aValueCol ) const
    {
        return m_cursorFormatsDyn[aCursorId][aValueCol];
    }
 
    void SetCursorFormat( int aCursorId, int aValueCol, const SPICE_VALUE_FORMAT& aFormat )
    {
        m_cursorFormatsDyn[ aCursorId ][ aValueCol ] = aFormat;
 
        wxCommandEvent dummy;
        onPlotCursorUpdate( dummy );
    }

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

    void RemoveTuner( TUNER_SLIDER* aTuner );

    void UpdateTunerValue( const SCH_SHEET_PATH& aSheetPath, const KIID& aSymbol,
                           const wxString& aRef, const wxString& aValue );

    void AddMeasurement( const wxString& aCmd );

    void DeleteMeasurement( int aRow );

    SPICE_VALUE_FORMAT GetMeasureFormat( int aRow ) const;
    void SetMeasureFormat( int aRow, const SPICE_VALUE_FORMAT& aFormat );

    void UpdateMeasurement( int aRow );
 
    void DoFourier( const wxString& aSignal, const wxString& aFundamental );

    const SPICE_CIRCUIT_MODEL* GetExporter() const;
 
    bool IsSimConsoleShown();
    void ToggleSimConsole();
    bool IsSimSidePanelShown();
    void ToggleSimSidePanel();
 
    bool DarkModePlots() const { return m_darkMode; }
    void ToggleDarkModePlots();

    void ToggleSmithChart();
 
    void ShowChangedLanguage();

    void InitWorkbook();

    bool LoadWorkbook( const wxString& aPath );

    bool SaveWorkbook( const wxString& aPath );
 
    void LoadSettings( EESCHEMA_SETTINGS* aCfg );
 
    void SaveSettings( EESCHEMA_SETTINGS* aCfg );

    void ApplyPreferences( const SIM_PREFERENCES& aPrefs );

    void SetSubWindowsSashSize();

    SIM_TAB* GetCurrentSimTab() const
    {
        return dynamic_cast<SIM_TAB*>( m_plotNotebook->GetCurrentPage() );
    }
 
    SIM_TAB* GetSimTab( SIM_TYPE aType ) const
    {
        for( int ii = 0; ii < (int) m_plotNotebook->GetPageCount(); ++ii )
        {
            SIM_TAB* candidate = dynamic_cast<SIM_TAB*>( m_plotNotebook->GetPage( ii ) );
 
            if( candidate && candidate->GetSimType() == aType )
                return candidate;
        }
 
        return nullptr;
    }
 
    int GetSimTabIndex( SIM_TAB* aPlot ) const
    {
        return m_plotNotebook->GetPageIndex( aPlot );
    }

    bool IsPlotOwnedByOtherTab( const SIM_TAB* aExcept, const wxString& aPlotName ) const
    {
        if( aPlotName.IsEmpty() )
            return false;
 
        for( int ii = 0; ii < (int) m_plotNotebook->GetPageCount(); ++ii )
        {
            SIM_TAB* candidate = dynamic_cast<SIM_TAB*>( m_plotNotebook->GetPage( ii ) );
 
            if( candidate && candidate != aExcept && candidate->GetSpicePlotName() == aPlotName )
                return true;
        }
 
        return false;
    }
 
    void OnPlotSettingsChanged();
 
    void OnSimUpdate();
    void OnSimRefresh( bool aFinal );
    void FlushSimConsole();
 
    void OnModify();
 
private:
    wxString vectorNameFromSignalName( SIM_PLOT_TAB* aPlotTab, const wxString& aSignalName, int* aTraceType );

    void updateTrace( const wxString& aVectorName, int aTraceType, SIM_PLOT_TAB* aPlotTab,
                      std::vector<double>* aDataX = nullptr, bool aClearData = false, SIM_VIEW* aView = nullptr );

    double getSmithPortImpedance( const wxString& aVectorName );

    void TogglePanel( wxPanel* aPanel, wxSplitterWindow* aSplitterWindow, int& aSashPosition );

    void CustomCursorsInit();

    void rebuildSignalsList();

    void rebuildSignalsGrid( wxString aFilter );

    void updateSignalsGrid();

    void updatePlotCursors();

    void updateSmithCursorColumns( bool aSmithMode );
 
    void fillSmithCursorRow( int aRow, CURSOR* aCursor, TRACE* aTrace );
 
    void setSmithCursorColumnLabels();
 
    void rememberSmithCursorColumns();
 
    void applySmithCursorColumns();

    template <typename T, typename U, typename R>
    void signalsGridCursorUpdate( T t, U u, R r );

    void applyUserDefinedSignals();

    void rebuildMeasurementsGrid();
 
    void updateMeasurementsFromGrid();

    void autoSizeGridColumn( WX_GRID* aGrid, int aCol, int aMinWidth, int aExtraPadding = 0 );

    wxArrayString getViewChoices( SIM_PLOT_TAB* aPlotTab ) const;

    wxString getViewLabel( SIM_PLOT_TAB* aPlotTab, SIM_VIEW* aView ) const;

    std::vector<SIM_VIEW*> getYScaleTargetViews( SIM_PLOT_TAB* aPlotTab, SIM_VIEW* aOwnView ) const;

    wxArrayString getYScaleChoices( SIM_PLOT_TAB* aPlotTab, SIM_VIEW* aOwnView ) const;

    wxString getYScaleLabel( SIM_PLOT_TAB* aPlotTab, TRACE* aTrace ) const;

    void applyTuners();

    SIM_TRACE_TYPE getXAxisType( SIM_TYPE aType ) const;
 
    struct MULTI_RUN_STEP;
 
    void clearMultiRunState( bool aClearTraces );
    void prepareMultiRunState();
    std::vector<MULTI_RUN_STEP> calculateMultiRunSteps( const std::vector<TUNER_SLIDER*>& aTuners ) const;
    std::string multiRunTraceKey( const wxString& aVectorName, int aTraceType ) const;
    void recordMultiRunData( const wxString& aVectorName, int aTraceType,
                             const std::vector<double>& aX, const std::vector<double>& aY );
    bool hasMultiRunTrace( const wxString& aVectorName, int aTraceType ) const;
 
    wxString getNoiseSource() const;
 
    void parseTraceParams( SIM_PLOT_TAB* aPlotTab, TRACE* aTrace, const wxString& aSignalName,
                           const wxString& aParams );
 
    std::shared_ptr<SPICE_SIMULATOR> simulator() const;
    std::shared_ptr<SPICE_CIRCUIT_MODEL> circuitModel() const;
 
    // Event handlers
    void onPlotClose( wxAuiNotebookEvent& event ) override;
    void onPlotClosed( wxAuiNotebookEvent& event ) override;
    void onPlotChanging( wxAuiNotebookEvent& event ) override;
    void onPlotChanged( wxAuiNotebookEvent& event ) override;
    void onPlotDragged( wxAuiNotebookEvent& event ) override;
 
    void OnFilterText( wxCommandEvent& aEvent ) override;
    void OnFilterMouseMoved( wxMouseEvent& aEvent ) override;
 
    void onSignalsGridCellChanged( wxGridEvent& aEvent ) override;
    void onCursorsGridCellChanged( wxGridEvent& aEvent ) override;
    void onMeasurementsGridCellChanged( wxGridEvent& aEvent ) override;
 
    void OnUpdateUI( wxUpdateUIEvent& event ) override;
 
    bool loadLegacyWorkbook( const wxString & aPath );
    bool loadJsonWorkbook( const wxString & aPath );
 
    void SaveCursorToWorkbook( nlohmann::json& aTraceJs, TRACE* aTrace, int aCursorId );
 
    void onPlotCursorUpdate( wxCommandEvent& aEvent );
 
public:
    int                          m_SuppressGridEvents;
 
private:
    SIMULATOR_FRAME*             m_simulatorFrame;
    SCH_EDIT_FRAME*              m_schematicFrame;
 
    STD_BITMAP_BUTTON* m_addViewButton = nullptr;
    STD_BITMAP_BUTTON* m_removeViewButton = nullptr;
 
    std::vector<wxString>        m_signals;
    std::map<int, wxString>      m_userDefinedSignals;
    std::list<TUNER_SLIDER*>     m_tuners;
    std::map<const TUNER_SLIDER*, double> m_tunerOverrides;
 
    struct MULTI_RUN_TRACE
    {
        int traceType = SPT_UNKNOWN;
        std::vector<double> xValues;
        std::vector<std::vector<double>> yValues;
 
        // smith traces carry Re(gamma) in x, different every run, stored per run here
        std::vector<std::vector<double>> xRuns;
    };
 
    struct MULTI_RUN_STEP
    {
        std::map<const TUNER_SLIDER*, double> overrides;
    };
 
    struct MULTI_RUN_STATE
    {
        bool active = false;
        std::vector<TUNER_SLIDER*> tuners;
        std::vector<MULTI_RUN_STEP> steps;
        size_t currentStep = 0;
        size_t storedSteps = 0;
        bool storePending = false;
        std::map<std::string, MULTI_RUN_TRACE> traces;
    };
 
    MULTI_RUN_STATE             m_multiRunState;

    std::vector<wxString>        m_netnames;
 
    SPICE_VALUE_FORMAT           m_cursorFormats[3][2];
 
    // Holds cursor formating for m_cursorsGrid, includes m_cursorFormats[3][2], TODO: merge.
    std::vector<std::vector<SPICE_VALUE_FORMAT>> m_cursorFormatsDyn;
 
    wxString m_smithCursorColumns;
    std::vector<int> m_smithCursorWidths;
 
    // Variables for temporary storage:
    int                          m_splitterLeftRightSashPosition;
    int                          m_splitterPlotAndConsoleSashPosition;
    int                          m_splitterSignalsSashPosition;
    int                          m_splitterCursorsSashPosition;
    int                          m_splitterTuneValuesSashPosition;
    bool                         m_darkMode;
    unsigned int                 m_plotNumber;
    wxTimer                      m_refreshTimer;
    SIM_PREFERENCES              m_preferences;
 
    // Count all available cursors in m_signalsGrid
    int                          m_customCursorsCnt; // Defaults to 2 + 1
};