Special netlist exporter flavor that allows one to override simulation commands. More...

#include <spice_circuit_model.h>

Inheritance diagram for SPICE_CIRCUIT_MODEL:

Public Types
enum	OPTIONS { OPTION_ADJUST_INCLUDE_PATHS = 0x0010 , OPTION_ADJUST_PASSIVE_VALS = 0x0020 , OPTION_SAVE_ALL_VOLTAGES = 0x0040 , OPTION_SAVE_ALL_CURRENTS = 0x0080 , OPTION_SAVE_ALL_DISSIPATIONS = 0x0100 , OPTION_CUR_SHEET_AS_ROOT = 0x0200 , OPTION_SIM_COMMAND = 0x0400 , OPTION_DEFAULT_FLAGS }

Public Member Functions
	SPICE_CIRCUIT_MODEL (SCHEMATIC_IFACE aSchematic, wxWindow aDialogParent=nullptr)

virtual	~SPICE_CIRCUIT_MODEL ()

SIM_TRACE_TYPE	VectorToSignal (const std::string &aVector, wxString &aSignal) const
	Return name of Spice dataset for a specific trace.

bool	GetNetlist (const wxString &aCommand, unsigned aOptions, OUTPUTFORMATTER *aFormatter, REPORTER &aReporter)

wxString	GetSchTextSimCommand ()
	Return simulation command directives placed in schematic sheets (if any).

bool	ParseDCCommand (const wxString &aCmd, SPICE_DC_PARAMS aSource1, SPICE_DC_PARAMS aSource2)
	Parse a two-source .dc command directive into its symbols.

bool	ParsePZCommand (const wxString &aCmd, wxString transferFunction, wxString input, wxString inputRef, wxString output, wxString outputRef, SPICE_PZ_ANALYSES analyses)

bool	ParseNoiseCommand (const wxString &aCmd, wxString aOutput, wxString aRef, wxString aSource, wxString aScale, SPICE_VALUE aPts, SPICE_VALUE aFStart, SPICE_VALUE aFStop, bool aSaveAll)

bool	WriteNetlist (const wxString &aOutFileName, unsigned aNetlistOptions, REPORTER &aReporter) override
	Write to specified output file.

bool	DoWriteNetlist (const wxString &aSimCommand, unsigned aSimOptions, OUTPUTFORMATTER &aFormatter, REPORTER &aReporter)
	Write the netlist in aFormatter.

virtual void	WriteHead (OUTPUTFORMATTER &aFormatter, unsigned aNetlistOptions)
	Write the netlist head (title and so on).

virtual void	WriteTail (OUTPUTFORMATTER &aFormatter, unsigned aNetlistOptions)
	Write the tail (.end).

virtual bool	ReadSchematicAndLibraries (unsigned aNetlistOptions, REPORTER &aReporter)
	Process the schematic and Spice libraries to create net mapping and a list of SPICE_ITEMs.

std::set< std::string >	GetNets () const
	Return the list of nets.

std::string	GetItemName (const std::string &aRefName) const
	Return name of Spice device corresponding to a schematic symbol.

const std::list< SPICE_ITEM > &	GetItems () const
	Return the list of items representing schematic symbols in the Spice world.

const SPICE_ITEM *	FindItem (const std::string &aRefName) const
	Find and return the item corresponding to aRefName.

const std::vector< wxString > &	GetDirectives ()

Static Public Member Functions
static bool	IsSimCommand (const wxString &aCmd)
	Determine if a directive is a simulation command.

static SIM_TYPE	CommandToSimType (const wxString &aCmd)
	Return simulation type basing on a simulation command directive.

static void	ConvertToSpiceMarkup (std::string &aNetName)
	Remove formatting wrappers and replace illegal spice net name characters with underscores.

static wxString	MakeCommandLine (const wxString &aFormatString, const wxString &aNetlistFile, const wxString &aFinalFile, const wxString &aProjectDirectory)
	Build up a string that describes a command line for executing a child process.

Protected Member Functions
void	WriteDirectives (const wxString &aSimCommand, unsigned aSimOptions, OUTPUTFORMATTER &aFormatter) const override

void	ReadDirectives (unsigned aNetlistOptions)

virtual std::string	GenerateItemPinNetName (const std::string &aNetName, int &aNcCounter) const

SCH_SHEET_LIST	GetSheets (unsigned aNetlistOptions=0) const
	Return the paths of exported sheets (either all or the current one).

std::vector< PIN_INFO >	CreatePinList (SCH_SYMBOL aSymbol, SCH_SHEET_PATH aSheetPath, bool aKeepUnconnectedPins)
	Find a symbol from the DrawList and builds its pin list.

SCH_SYMBOL *	findNextSymbol (EDA_ITEM aItem, SCH_SHEET_PATH aSheetPath)
	Check if the given symbol should be processed for netlisting.

void	eraseDuplicatePins (std::vector< PIN_INFO > &pins)
	Erase duplicate pins.

void	findAllUnitsOfSymbol (SCH_SYMBOL aSchSymbol, SCH_SHEET_PATH aSheetPath, std::vector< PIN_INFO > &aPins, bool aKeepUnconnectedPins)
	Find all units for symbols with multiple symbols per package.

Protected Attributes
UNIQUE_STRINGS	m_referencesAlreadyFound
	Used for "multiple symbols per package" symbols to avoid processing a lib symbol more than once.

std::set< LIB_SYMBOL *, LIB_SYMBOL_LESS_THAN >	m_libParts
	unique library symbols used. LIB_SYMBOL items are sorted by names

SCHEMATIC_IFACE *	m_schematic
	The schematic we're generating a netlist for.

Private Member Functions
void	readRefName (SCH_SHEET_PATH &aSheet, SCH_SYMBOL &aSymbol, SPICE_ITEM &aItem, std::set< std::string > &aRefNames)

void	readModel (SCH_SHEET_PATH &aSheet, SCH_SYMBOL &aSymbol, SPICE_ITEM &aItem, REPORTER &aReporter)

void	readPinNumbers (SCH_SYMBOL &aSymbol, SPICE_ITEM &aItem, const std::vector< PIN_INFO > &aPins)

void	readPinNetNames (SCH_SYMBOL &aSymbol, SPICE_ITEM &aItem, const std::vector< PIN_INFO > &aPins, int &aNcCounter)

void	getNodePattern (SPICE_ITEM &aItem, std::vector< std::string > &aModifiers)

void	readNodePattern (SPICE_ITEM &aItem)

void	writeInclude (OUTPUTFORMATTER &aFormatter, unsigned aNetlistOptions, const wxString &aPath)

void	writeIncludes (OUTPUTFORMATTER &aFormatter, unsigned aNetlistOptions)

void	writeModels (OUTPUTFORMATTER &aFormatter)

void	writeItems (OUTPUTFORMATTER &aFormatter)

Private Attributes
SIM_LIB_MGR	m_libMgr
	Holds libraries and models.

NAME_GENERATOR	m_modelNameGenerator
	Generates unique model names.

NAME_GENERATOR	m_netNameGenerator

std::vector< wxString >	m_directives
	Spice directives found in the schematic sheet.

std::set< wxString >	m_rawIncludes
	include directives found in symbols

std::set< std::string >	m_nets
	Items representing schematic symbols in Spice world.

std::list< SPICE_ITEM >	m_items

wxWindow *	m_dialogParent

Detailed Description

Special netlist exporter flavor that allows one to override simulation commands.

Definition at line 54 of file spice_circuit_model.h.

Member Enumeration Documentation

◆ OPTIONS

enum NETLIST_EXPORTER_SPICE::OPTIONS

inherited

Enumerator
OPTION_ADJUST_INCLUDE_PATHS
OPTION_ADJUST_PASSIVE_VALS
OPTION_SAVE_ALL_VOLTAGES
OPTION_SAVE_ALL_CURRENTS
OPTION_SAVE_ALL_DISSIPATIONS
OPTION_CUR_SHEET_AS_ROOT
OPTION_SIM_COMMAND
OPTION_DEFAULT_FLAGS

Definition at line 52 of file netlist_exporter_spice.h.

Constructor & Destructor Documentation

◆ SPICE_CIRCUIT_MODEL()

SPICE_CIRCUIT_MODEL::SPICE_CIRCUIT_MODEL	(	SCHEMATIC_IFACE *	aSchematic,
		wxWindow *	aDialogParent = `nullptr`
	)

inline

Definition at line 57 of file spice_circuit_model.h.

◆ ~SPICE_CIRCUIT_MODEL()

virtual SPICE_CIRCUIT_MODEL::~SPICE_CIRCUIT_MODEL ( )

inlinevirtual

Definition at line 61 of file spice_circuit_model.h.

Member Function Documentation

◆ CommandToSimType()

SIM_TYPE SPICE_CIRCUIT_MODEL::CommandToSimType ( const wxString & aCmd )

static

Return simulation type basing on a simulation command directive.

Definition at line 98 of file spice_circuit_model.cpp.

References ST_AC, ST_DC, ST_DISTO, ST_FFT, ST_NOISE, ST_OP, ST_PZ, ST_SENS, ST_SP, ST_TF, ST_TRAN, and ST_UNKNOWN.

Referenced by SIMULATOR_FRAME_UI::AddTrace(), BOOST_AUTO_TEST_CASE(), SIMULATOR_FRAME::GetCurrentSimType(), SIM_TAB::GetSimType(), IsSimCommand(), SIMULATOR_FRAME_UI::NewSimTab(), DIALOG_SIM_COMMAND::parseCommand(), and SIMULATOR_FRAME_UI::updateTrace().

◆ ConvertToSpiceMarkup()

void NETLIST_EXPORTER_SPICE::ConvertToSpiceMarkup ( std::string & aNetName )

staticinherited

Remove formatting wrappers and replace illegal spice net name characters with underscores.

Definition at line 242 of file netlist_exporter_spice.cpp.

References MARKUP::MARKUP_PARSER::Parse().

Referenced by NETLIST_EXPORTER_SPICE::GenerateItemPinNetName(), SCHEMATIC::GetOperatingPoint(), and SCH_EDITOR_CONTROL::SimProbe().

◆ CreatePinList()

std::vector< PIN_INFO > NETLIST_EXPORTER_BASE::CreatePinList	(	SCH_SYMBOL *	aSymbol,
		SCH_SHEET_PATH *	aSheetPath,
		bool	aKeepUnconnectedPins
	)

protectedinherited

Find a symbol from the DrawList and builds its pin list.

This list is sorted by pin number. The symbol is the next actual symbol after aSymbol. Power symbols and virtual symbols that have their reference designators starting with '#' are skipped. if aKeepUnconnectedPins = false, unconnected pins will be removed from list but usually we need all pins in netlists.

Definition at line 119 of file netlist_exporter_base.cpp.

References SCHEMATIC_IFACE::ConnectionGraph(), NETLIST_EXPORTER_BASE::eraseDuplicatePins(), NETLIST_EXPORTER_BASE::findAllUnitsOfSymbol(), CONNECTION_GRAPH::FindSubgraphByName(), CONNECTION_SUBGRAPH::GetItems(), SCH_SYMBOL::GetLibSymbolRef(), CONNECTION_SUBGRAPH::GetNoConnect(), SCH_SYMBOL::GetPins(), SCH_SYMBOL::GetRef(), SCH_SYMBOL::IsPower(), NETLIST_EXPORTER_BASE::m_libParts, NETLIST_EXPORTER_BASE::m_schematic, and pin.

Referenced by NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

◆ DoWriteNetlist()

bool NETLIST_EXPORTER_SPICE::DoWriteNetlist	(	const wxString &	aSimCommand,
		unsigned	aSimOptions,
		OUTPUTFORMATTER &	aFormatter,
		REPORTER &	aReporter
	)

inherited

Write the netlist in aFormatter.

Definition at line 113 of file netlist_exporter_spice.cpp.

References dummy, NETLIST_EXPORTER_SPICE::m_items, NETLIST_EXPORTER_SPICE::m_rawIncludes, NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries(), NETLIST_EXPORTER_SPICE::WriteDirectives(), NETLIST_EXPORTER_SPICE::WriteHead(), NETLIST_EXPORTER_SPICE::writeIncludes(), NETLIST_EXPORTER_SPICE::writeItems(), NETLIST_EXPORTER_SPICE::writeModels(), and NETLIST_EXPORTER_SPICE::WriteTail().

Referenced by GetNetlist(), and NETLIST_EXPORTER_SPICE::WriteNetlist().

◆ eraseDuplicatePins()

void NETLIST_EXPORTER_BASE::eraseDuplicatePins ( std::vector< PIN_INFO > & pins )

protectedinherited

Erase duplicate pins.

(This is a list of pins found in the whole schematic, for a single symbol.) These duplicate pins were put in list because some pins (power pins...) are found more than once when in "multiple symbols per package" symbols. For instance, a 74ls00 has 4 symbols, and therefore the VCC pin and GND pin appears 4 times in the list. Note: this list MUST be sorted by pin number (.m_PinNum member value) Also set the m_Flag member of "removed" NETLIST_OBJECT pin item to 1

Definition at line 191 of file netlist_exporter_base.cpp.

Referenced by NETLIST_EXPORTER_BASE::CreatePinList().

◆ findAllUnitsOfSymbol()

void NETLIST_EXPORTER_BASE::findAllUnitsOfSymbol	(	SCH_SYMBOL *	aSchSymbol,
		SCH_SHEET_PATH *	aSheetPath,
		std::vector< PIN_INFO > &	aPins,
		bool	aKeepUnconnectedPins
	)

protectedinherited

Find all units for symbols with multiple symbols per package.

Search the entire design for all units of aSymbol based on matching reference designator, and for each unit, add all its pins to the sorted pin list. if aKeepUnconnectedPins = false, unconnected pins will be removed from list but usually we need all pins in netlists.

Definition at line 224 of file netlist_exporter_base.cpp.

References SCHEMATIC_IFACE::ConnectionGraph(), CONNECTION_GRAPH::FindSubgraphByName(), CONNECTION_SUBGRAPH::GetItems(), CONNECTION_SUBGRAPH::GetNoConnect(), SCH_SYMBOL::GetPins(), SCH_SYMBOL::GetRef(), SCHEMATIC_IFACE::GetSheets(), NETLIST_EXPORTER_BASE::m_schematic, pin, and SCH_SYMBOL_T.

Referenced by NETLIST_EXPORTER_BASE::CreatePinList().

◆ FindItem()

const SPICE_ITEM * NETLIST_EXPORTER_SPICE::FindItem ( const std::string & aRefName ) const

inherited

Find and return the item corresponding to aRefName.

Definition at line 303 of file netlist_exporter_spice.cpp.

References NETLIST_EXPORTER_SPICE::GetItems().

Referenced by SIMULATOR_FRAME_UI::AddTuner(), SIMULATOR_FRAME_UI::applyTuners(), NETLIST_EXPORTER_SPICE::GetItemName(), and TUNER_SLIDER::TUNER_SLIDER().

◆ findNextSymbol()

SCH_SYMBOL * NETLIST_EXPORTER_BASE::findNextSymbol	(	EDA_ITEM *	aItem,
		SCH_SHEET_PATH *	aSheetPath
	)

protectedinherited

Check if the given symbol should be processed for netlisting.

Prevent processing multi-unit symbols more than once, etc.

Parameters

aItem	is a symbol to check
aSheetPath	is the sheet to check the symbol for

Returns: the symbol if it should be processed, or nullptr

Definition at line 73 of file netlist_exporter_base.cpp.

References SCH_SCREEN::GetLibSymbols(), SCH_SYMBOL::GetRef(), SCH_SYMBOL::GetSchSymbolLibraryName(), LIB_SYMBOL::GetUnitCount(), SCH_SHEET_PATH::LastScreen(), UNIQUE_STRINGS::Lookup(), NETLIST_EXPORTER_BASE::m_libParts, NETLIST_EXPORTER_BASE::m_referencesAlreadyFound, SCH_SYMBOL_T, and EDA_ITEM::Type().

Referenced by NETLIST_EXPORTER_ALLEGRO::extractComponentsInfo(), NETLIST_EXPORTER_XML::makeSymbols(), NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries(), NETLIST_EXPORTER_CADSTAR::WriteNetlist(), NETLIST_EXPORTER_ORCADPCB2::WriteNetlist(), and NETLIST_EXPORTER_PADS::WriteNetlist().

◆ GenerateItemPinNetName()

std::string NETLIST_EXPORTER_SPICE::GenerateItemPinNetName	(	const std::string &	aNetName,
		int &	aNcCounter
	)		const

protectedvirtualinherited

Reimplemented in NETLIST_EXPORTER_SPICE_MODEL.

Definition at line 712 of file netlist_exporter_spice.cpp.

References NETLIST_EXPORTER_SPICE::ConvertToSpiceMarkup(), and UnescapeString().

Referenced by NETLIST_EXPORTER_SPICE_MODEL::GenerateItemPinNetName(), and NETLIST_EXPORTER_SPICE::readPinNetNames().

◆ GetDirectives()

const std::vector< wxString > & NETLIST_EXPORTER_SPICE::GetDirectives ( )

inlineinherited

Definition at line 131 of file netlist_exporter_spice.h.

References NETLIST_EXPORTER_SPICE::m_directives.

Referenced by GetSchTextSimCommand().

◆ GetItemName()

std::string NETLIST_EXPORTER_SPICE::GetItemName ( const std::string & aRefName ) const

inherited

Return name of Spice device corresponding to a schematic symbol.

Parameters

aRefName is the component reference.

Returns: Spice device name or empty string if there is no such symbol in the netlist. Normally the name is either a plain reference if the first character of reference corresponds to the assigned device model type or a reference prefixed with a character defining the device model type.

Definition at line 292 of file netlist_exporter_spice.cpp.

References NETLIST_EXPORTER_SPICE::FindItem(), SPICE_GENERATOR::ItemName(), SPICE_ITEM::model, and SIM_MODEL::SpiceGenerator().

◆ GetItems()

const std::list< SPICE_ITEM > & NETLIST_EXPORTER_SPICE::GetItems ( ) const

inlineinherited

Return the list of items representing schematic symbols in the Spice world.

Definition at line 124 of file netlist_exporter_spice.h.

References NETLIST_EXPORTER_SPICE::m_items.

Referenced by NETLIST_EXPORTER_SPICE::FindItem(), and DIALOG_SIM_MODEL< T >::newParamProperty().

◆ GetNetlist()

bool SPICE_CIRCUIT_MODEL::GetNetlist	(	const wxString &	aCommand,
		unsigned	aOptions,
		OUTPUTFORMATTER *	aFormatter,
		REPORTER &	aReporter
	)

inline

Definition at line 73 of file spice_circuit_model.h.

References NETLIST_EXPORTER_SPICE::DoWriteNetlist().

Referenced by NGSPICE::Attach().

◆ GetNets()

std::set< std::string > NETLIST_EXPORTER_SPICE::GetNets ( ) const

inlineinherited

Return the list of nets.

Definition at line 108 of file netlist_exporter_spice.h.

References NETLIST_EXPORTER_SPICE::m_nets.

◆ getNodePattern()

void NETLIST_EXPORTER_SPICE::getNodePattern	(	SPICE_ITEM &	aItem,
		std::vector< std::string > &	aModifiers
	)

privateinherited

Definition at line 510 of file netlist_exporter_spice.cpp.

References _, SPICE_ITEM::fields, SIM_MODEL::GetFieldValue(), SPICE_ITEM::refName, SIM_NODES_FORMAT_FIELD, and THROW_IO_ERROR.

Referenced by NETLIST_EXPORTER_SPICE::readNodePattern().

◆ GetSchTextSimCommand()

wxString SPICE_CIRCUIT_MODEL::GetSchTextSimCommand ( )

Return simulation command directives placed in schematic sheets (if any).

Definition at line 82 of file spice_circuit_model.cpp.

References NETLIST_EXPORTER_SPICE::GetDirectives(), IsSimCommand(), and NETLIST_EXPORTER_SPICE::ReadDirectives().

◆ GetSheets()

SCH_SHEET_LIST NETLIST_EXPORTER_SPICE::GetSheets ( unsigned aNetlistOptions = 0 ) const

protectedinherited

Return the paths of exported sheets (either all or the current one).

Definition at line 727 of file netlist_exporter_spice.cpp.

References SCHEMATIC_IFACE::CurrentSheet(), SCHEMATIC_IFACE::GetSheets(), SCH_SHEET_PATH::Last(), NETLIST_EXPORTER_BASE::m_schematic, and NETLIST_EXPORTER_SPICE::OPTION_CUR_SHEET_AS_ROOT.

Referenced by NETLIST_EXPORTER_SPICE::ReadDirectives(), NETLIST_EXPORTER_SPICE_MODEL::readPorts(), and NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries().

◆ IsSimCommand()

static bool SPICE_CIRCUIT_MODEL::IsSimCommand ( const wxString & aCmd )

inlinestatic

Determine if a directive is a simulation command.

Definition at line 104 of file spice_circuit_model.h.

References CommandToSimType(), and ST_UNKNOWN.

Referenced by GetSchTextSimCommand().

◆ MakeCommandLine()

wxString NETLIST_EXPORTER_BASE::MakeCommandLine	(	const wxString &	aFormatString,
		const wxString &	aNetlistFile,
		const wxString &	aFinalFile,
		const wxString &	aProjectDirectory
	)

staticinherited

Build up a string that describes a command line for executing a child process.

The input and output file names along with any options to the executable are all possibly in the returned string.

Parameters

aFormatString	holds: the name of the external program any options needed by that program formatting sequences, see below.
aNetlistFile	is the name of the input file for the external program, that is a intermediate netlist file in xml format.
aFinalFile	is the name of the output file that the user expects.
aProjectDirectory	is used for P replacement, it should omit the trailing '/'.

Supported formatting sequences and their meaning:

B => base filename of selected output file, minus path and extension.
I => complete filename and path of the temporary input file.
O => complete filename and path of the user chosen output file.
P => project directory, without name and without trailing '/'

Definition at line 37 of file netlist_exporter_base.cpp.

Referenced by SCH_EDIT_FRAME::WriteNetListFile().

◆ ParseDCCommand()

bool SPICE_CIRCUIT_MODEL::ParseDCCommand	(	const wxString &	aCmd,
		SPICE_DC_PARAMS *	aSource1,
		SPICE_DC_PARAMS *	aSource2
	)

Parse a two-source .dc command directive into its symbols.

Parameters

aCmd	is the input command string

Returns: true if the command was parsed successfully

Definition at line 120 of file spice_circuit_model.cpp.

References SPICE_DC_PARAMS::m_source, SPICE_DC_PARAMS::m_vend, SPICE_DC_PARAMS::m_vincrement, and SPICE_DC_PARAMS::m_vstart.

◆ ParseNoiseCommand()

bool SPICE_CIRCUIT_MODEL::ParseNoiseCommand	(	const wxString &	aCmd,
		wxString *	aOutput,
		wxString *	aRef,
		wxString *	aSource,
		wxString *	aScale,
		SPICE_VALUE *	aPts,
		SPICE_VALUE *	aFStart,
		SPICE_VALUE *	aFStop,
		bool *	aSaveAll
	)

Definition at line 187 of file spice_circuit_model.cpp.

◆ ParsePZCommand()

bool SPICE_CIRCUIT_MODEL::ParsePZCommand	(	const wxString &	aCmd,
		wxString *	transferFunction,
		wxString *	input,
		wxString *	inputRef,
		wxString *	output,
		wxString *	outputRef,
		SPICE_PZ_ANALYSES *	analyses
	)