kicad/eeschema/dialogs/dialog_signal_list.cpp

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2016 CERN
 * Copyright (C) 2021 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @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 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, you may find one here:
 * https://www.gnu.org/licenses/gpl-3.0.html
 * or you may search the http://www.gnu.org website for the version 3 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */

#include "dialog_signal_list.h"
#include <string_utils.h>
#include <sim/sim_plot_frame.h>

#include <sim/ngspice_circuit_model.h>
#include <sim/spice_generator.h>


DIALOG_SIGNAL_LIST::DIALOG_SIGNAL_LIST( SIM_PLOT_FRAME* aParent,
                                        NGSPICE_CIRCUIT_MODEL* aCircuitModel ) :
    DIALOG_SIGNAL_LIST_BASE( aParent ),
    m_plotFrame( aParent ),
    m_circuitModel( aCircuitModel )
{

}


bool DIALOG_SIGNAL_LIST::TransferDataFromWindow()
{
    if( !DIALOG_SIGNAL_LIST_BASE::TransferDataFromWindow() )
        return false;

    addSelectionToPlotFrame();

    return true;
}


bool DIALOG_SIGNAL_LIST::TransferDataToWindow()
{
    // Create a list of possible signals
    /// TODO: it could include separated mag & phase for AC analysis
    if( m_circuitModel )
    {
        // Voltage list
        for( const auto& net : m_circuitModel->GetNets() )
        {
            // netnames are escaped (can contain "{slash}" for '/') Unscape them:
            wxString netname = UnescapeString( net );

            if( netname != "GND" && netname != "0" )
                m_signals->Append( wxString::Format( "V(%s)", netname ) );
        }

        auto simType = m_circuitModel->GetSimType();

        if( simType == ST_TRANSIENT || simType == ST_DC )
        {
            for( const SPICE_ITEM& item : m_circuitModel->GetItems() )
            {
                // Add all possible currents for the primitive.
                for( const std::string& name : item.model->SpiceGenerator().CurrentNames( item ) )
                    m_signals->Append( name );
            }
        }
    }

    bool success = DIALOG_SIGNAL_LIST_BASE::TransferDataToWindow();

    // Now all widgets have the size fixed, call FinishDialogSettings
    finishDialogSettings();

    return success;
}


bool DIALOG_SIGNAL_LIST::addSignalToPlotFrame( const wxString& aPlotName )
{

    // Get the part in the parentheses
    wxString name = aPlotName.AfterFirst( '(' ).BeforeLast( ')' );

    if( !name.IsEmpty() )
    {
        wxUniChar firstChar = aPlotName[0];

        if( firstChar == 'V' || firstChar == 'v' )
            m_plotFrame->AddVoltagePlot( aPlotName );
        else if( firstChar == 'I' || firstChar == 'i' )
            m_plotFrame->AddCurrentPlot( aPlotName );
        else
            return false;
    }
    else
    {
        return false;
    }

    return true;
}


void DIALOG_SIGNAL_LIST::addSelectionToPlotFrame()
{
    for( int i = 0; i < (int) m_signals->GetCount(); ++i )
    {
        if( m_signals->IsSelected( i ) )
        {
            const wxString& plotName = m_signals->GetString( i );

            if( !addSignalToPlotFrame( plotName ) )
                wxASSERT_MSG( false, "Unhandled plot type" );
        }
    }

    // Add manually entered signal, if any
    const wxString& plotName = m_signalEntry->GetValue();

    if( !plotName.IsEmpty() )
    {
        if( !addSignalToPlotFrame( plotName ) )
            m_plotFrame->AddVoltagePlot( plotName ); // Assume it's a V plot by default

        m_signalEntry->SetSelection( -1, -1 );
    }
}