ngspice_circuit_model.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-2022 CERN
 * Copyright (C) 2017-2023 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @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, 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
 */
 
#ifndef NGSPICE_CIRCUIT_MODEL_H
#define NGSPICE_CIRCUIT_MODEL_H
 
#include <netlist_exporters/netlist_exporter_spice.h>
#include <vector>
 
#include "sim_types.h"
#include "spice_simulator.h"
#include "spice_value.h"
 
 
struct SPICE_DC_PARAMS
{
 wxString m_source;
 SPICE_VALUE m_vstart;
 SPICE_VALUE m_vend;
 SPICE_VALUE m_vincrement;
};
 
class NGSPICE_CIRCUIT_MODEL : public NETLIST_EXPORTER_SPICE, public SIMULATION_MODEL
{
public:
 NGSPICE_CIRCUIT_MODEL( SCHEMATIC_IFACE* aSchematic, wxWindow* aDialogParent = nullptr ) :
 NETLIST_EXPORTER_SPICE( aSchematic, aDialogParent ),
 m_options( NETLIST_EXPORTER_SPICE::OPTION_DEFAULT_FLAGS )
 {}
 
 virtual ~NGSPICE_CIRCUIT_MODEL() {}
 
 SIM_TRACE_TYPE VectorToSignal( const std::string& aVector, wxString& aSignal ) const;
 
 void SetSimOptions( int aOptions ) { m_options = aOptions; }
 int GetSimOptions() const { return m_options; }
 
 bool GetNetlist( OUTPUTFORMATTER* aFormatter, REPORTER& aReporter )
 {
 return NGSPICE_CIRCUIT_MODEL::DoWriteNetlist( *aFormatter, m_options, aReporter );
 }
 
 void SetSimCommandOverride( const wxString& aCmd )
 {
 if( aCmd != m_simCommand )
 {
 m_lastSchTextSimCommand = GetSchTextSimCommand();
 m_simCommand = aCmd;
 }
 }
 
 wxString GetSimCommand()
 {
 return m_simCommand.IsEmpty() ? GetSchTextSimCommand() : m_simCommand;
 }
 
 wxString GetSimCommandOverride() const { return m_simCommand; }
 
 SIM_TYPE GetSimType();
 
 wxString GetSchTextSimCommand();
 
 wxString GetLastSchTextSimCommand() const { return m_lastSchTextSimCommand; }
 
 bool ParseDCCommand( const wxString& aCmd, SPICE_DC_PARAMS* aSource1,
 SPICE_DC_PARAMS* aSource2 );
 
 static bool IsSimCommand( const wxString& aCmd )
 {
 return CommandToSimType( aCmd ) != ST_UNKNOWN;
 }
 
 static SIM_TYPE CommandToSimType( const wxString& aCmd );
 
protected:
 void WriteDirectives( OUTPUTFORMATTER& aFormatter, unsigned aNetlistOptions ) const override;
 
private:
 wxString m_simCommand;
 
 wxString m_lastSchTextSimCommand;
 
 int m_options;
};
 
#endif /* NGSPICE_CIRCUIT_MODEL_H */