kicad/eeschema/sim/sim_plot_frame.cpp

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2016 CERN
 * @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
 * @author Maciej Suminski <maciej.suminski@cern.ch>
 *
 * 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 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */

#include <schframe.h>
#include <eeschema_id.h>
#include <kiway.h>

#include <netlist_exporter_kicad.h>
#include <netlist_exporters/netlist_exporter_pspice.h>

#include "sim_plot_frame.h"
#include "sim_plot_panel.h"
#include "spice_simulator.h"
#include "spice_reporter.h"

class SIM_THREAD_REPORTER : public SPICE_REPORTER
{
public:
    SIM_THREAD_REPORTER( SIM_PLOT_FRAME* aParent )
        : m_parent( aParent )
    {
    }

    REPORTER& Report( const wxString& aText, SEVERITY aSeverity = RPT_UNDEFINED ) override
    {
        wxCommandEvent* event = new wxCommandEvent( wxEVT_SIM_REPORT );
        event->SetString( aText );
        wxQueueEvent( m_parent, event );
        return *this;
    }

    void OnSimStateChange( SPICE_SIMULATOR* aObject, SIM_STATE aNewState ) override
    {
        wxCommandEvent* event = NULL;

        switch( aNewState )
        {
            case SIM_IDLE:
                event = new wxCommandEvent( wxEVT_SIM_FINISHED );
                break;

            case SIM_RUNNING:
                event = new wxCommandEvent( wxEVT_SIM_STARTED );
                break;
        }

        wxQueueEvent( m_parent, event );
    }

private:
    SIM_PLOT_FRAME* m_parent;
};


SIM_PLOT_FRAME::SIM_PLOT_FRAME( KIWAY* aKiway, wxWindow* aParent )
    : SIM_PLOT_FRAME_BASE( aParent )
{
    SetKiway( this, aKiway );

    m_exporter = NULL;
    m_simulator = NULL;

    Connect( wxEVT_CLOSE_WINDOW, wxCloseEventHandler( SIM_PLOT_FRAME::onClose ), NULL, this );
    Connect( wxEVT_SIM_REPORT, wxCommandEventHandler( SIM_PLOT_FRAME::onSimReport ), NULL, this );
    Connect( wxEVT_SIM_STARTED, wxCommandEventHandler( SIM_PLOT_FRAME::onSimStarted ), NULL, this );
    Connect( wxEVT_SIM_FINISHED, wxCommandEventHandler( SIM_PLOT_FRAME::onSimFinished ), NULL, this );

    NewPlotPanel();
}


SIM_PLOT_FRAME::~SIM_PLOT_FRAME()
{
    delete m_exporter;
    delete m_simulator;
}


void SIM_PLOT_FRAME::StartSimulation()
{
    delete m_exporter;
    delete m_simulator;

    m_simConsole->Clear();

    /// @todo is it necessary to recreate simulator every time?
    m_simulator = SPICE_SIMULATOR::CreateInstance( "ngspice" );
    m_simulator->SetReporter( new SIM_THREAD_REPORTER( this ) );
    m_simulator->Init();

    NETLIST_OBJECT_LIST* net_atoms = m_schematicFrame->BuildNetListBase();
    m_exporter = new NETLIST_EXPORTER_PSPICE( net_atoms, Prj().SchLibs(), Prj().SchSearchS() );
    STRING_FORMATTER formatter;

    m_exporter->Format( &formatter, GNL_ALL );
    m_simulator->LoadNetlist( formatter.GetString() );
    m_simulator->Run();
}


void SIM_PLOT_FRAME::StopSimulation()
{
    m_simulator->Stop();
}


void SIM_PLOT_FRAME::NewPlotPanel()
{
    SIM_PLOT_PANEL* plot = new SIM_PLOT_PANEL( this, wxID_ANY );
    m_plotNotebook->AddPage( plot,
            wxString::Format( wxT( "Plot%lu" ), m_plotNotebook->GetPageCount() + 1 ), true );
}


void SIM_PLOT_FRAME::AddVoltagePlot( const wxString& aNetName )
{
    int nodeNumber = getNodeNumber( aNetName );

    if( nodeNumber >= -1 )
    {
        updatePlot( wxString::Format( "V(%d)", nodeNumber ), aNetName,
                    static_cast<SIM_PLOT_PANEL*>( m_plotNotebook->GetCurrentPage() ) );
    }
}


bool SIM_PLOT_FRAME::isSimulationRunning()
{
    return m_simulator ? m_simulator->IsRunning() : false;
}


void SIM_PLOT_FRAME::updatePlot( const wxString& aSpiceName, const wxString& aTitle, SIM_PLOT_PANEL* aPanel )
{
    auto data_y = m_simulator->GetPlot( (const char*) aSpiceName.c_str() );
    auto data_t = m_simulator->GetPlot( "time" );

    if( data_y.empty() || data_t.empty() )
        return;

    aPanel->AddTrace( aSpiceName, aTitle, data_t.size(), data_t.data(), data_y.data(), 0 );
}


int SIM_PLOT_FRAME::getNodeNumber( const wxString& aNetName )
{
    if( !m_exporter )
        return -1;

    const auto& netMapping = m_exporter->GetNetIndexMap();
    auto it = netMapping.find( aNetName );

    if( it == netMapping.end() )
        return -1;

    return it->second;
}


void SIM_PLOT_FRAME::onSignalDblClick( wxCommandEvent& event )
{
    int idx = m_signals->GetSelection();

    if( idx != wxNOT_FOUND )
        AddVoltagePlot( m_signals->GetString( idx ) );
}


void SIM_PLOT_FRAME::onSimulate( wxCommandEvent& event )
{
    if( isSimulationRunning() )
        StopSimulation();
    else
        StartSimulation();
}


void SIM_PLOT_FRAME::onPlaceProbe( wxCommandEvent& event )
{
    if( m_schematicFrame == NULL )
        return;

    wxCommandEvent* placeProbe = new wxCommandEvent( wxEVT_TOOL, ID_SIM_ADD_PROBE );
    wxQueueEvent( m_schematicFrame, placeProbe );
}


void SIM_PLOT_FRAME::onClose( wxCloseEvent& aEvent )
{
    if( isSimulationRunning() )
        m_simulator->Stop();

    Destroy();
}


void SIM_PLOT_FRAME::onSimStarted( wxCommandEvent& aEvent )
{
    m_simulateBtn->SetLabel( wxT( "Stop" ) );
    SetCursor( wxCURSOR_ARROWWAIT );
}


void SIM_PLOT_FRAME::onSimFinished( wxCommandEvent& aEvent )
{
    m_simulateBtn->SetLabel( wxT( "Simulate" ) );
    SetCursor( wxCURSOR_ARROW );

    // Fill the signals listbox
    m_signals->Clear();

    for( const auto& net : m_exporter->GetNetIndexMap() )
    {
        if( net.first != "GND" )
            m_signals->Append( net.first );
    }

    // If there are any signals plotted, update them
    for( unsigned int i = 0; i < m_plotNotebook->GetPageCount(); ++i )
    {
        SIM_PLOT_PANEL* plotPanel = static_cast<SIM_PLOT_PANEL*>( m_plotNotebook->GetPage( i ) );
        plotPanel->ResetAxisRanges();

        for( const auto& trace : plotPanel->GetTraces() )
            updatePlot( trace.spiceName, trace.title, plotPanel );
    }
}


void SIM_PLOT_FRAME::onSimReport( wxCommandEvent& aEvent )
{
    m_simConsole->AppendText( aEvent.GetString() );
    m_simConsole->Newline();
    m_simConsole->MoveEnd();        /// @todo does not work..
}