#include <netlist_exporter_spice.h>

Inheritance diagram for NETLIST_EXPORTER_SPICE:

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
	NETLIST_EXPORTER_SPICE (SCHEMATIC_IFACE aSchematic, wxWindow aDialogParent=nullptr)

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

bool	DoWriteNetlist (OUTPUTFORMATTER &aFormatter, unsigned aNetlistOptions, REPORTER &aReporter)
	Write the netlist in aFormatter. More...

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

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

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

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

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

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

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

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

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

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. More...

Protected Member Functions
void	ReadDirectives (unsigned aNetlistOptions)

virtual void	WriteDirectives (OUTPUTFORMATTER &candidate, unsigned aNetlistOptions) const

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). More...

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. More...

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

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

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. More...

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

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

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

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)

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	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. More...

NAME_GENERATOR	m_modelNameGenerator
	Generates unique model names. More...

NAME_GENERATOR	m_netNameGenerator

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

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

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

std::list< SPICE_ITEM >	m_items

wxWindow *	m_dialogParent

Detailed Description

Definition at line 49 of file netlist_exporter_spice.h.

Member Enumeration Documentation

◆ OPTIONS

enum NETLIST_EXPORTER_SPICE::OPTIONS

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

◆ NETLIST_EXPORTER_SPICE()

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

Definition at line 95 of file netlist_exporter_spice.cpp.

Member Function Documentation

◆ ConvertToSpiceMarkup()

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

static

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

Definition at line 246 of file netlist_exporter_spice.cpp.

References MARKUP::MARKUP_PARSER::Parse().

Referenced by 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 116 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 ReadSchematicAndLibraries(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

◆ DoWriteNetlist()

bool NETLIST_EXPORTER_SPICE::DoWriteNetlist	(	OUTPUTFORMATTER &	aFormatter,
		unsigned	aNetlistOptions,
		REPORTER &	aReporter
	)

Write the netlist in aFormatter.

Definition at line 113 of file netlist_exporter_spice.cpp.

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

Referenced by NGSPICE_CIRCUIT_MODEL::GetNetlist(), and 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 188 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 221 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

Find and return the item corresponding to aRefName.

Definition at line 307 of file netlist_exporter_spice.cpp.

References GetItems().

Referenced by SIMULATOR_FRAME::AddTuner(), SIMULATOR_FRAME::applyTuners(), 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_XML::makeSymbols(), ReadSchematicAndLibraries(), NETLIST_EXPORTER_CADSTAR::WriteNetlist(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

◆ GenerateItemPinNetName()

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

protectedvirtual

Reimplemented in NETLIST_EXPORTER_SPICE_MODEL.

Definition at line 647 of file netlist_exporter_spice.cpp.

References ConvertToSpiceMarkup(), and UnescapeString().

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

◆ GetDirectives()

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

inline

Definition at line 131 of file netlist_exporter_spice.h.

References m_directives.

Referenced by NGSPICE_CIRCUIT_MODEL::GetSchTextSimCommand().

◆ GetItemName()

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

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 296 of file netlist_exporter_spice.cpp.

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

◆ GetItems()

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

inline

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

Definition at line 124 of file netlist_exporter_spice.h.

References m_items.

Referenced by FindItem().

◆ GetNets()

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

inline

Return the list of nets.

Definition at line 108 of file netlist_exporter_spice.h.

References m_nets.

◆ GetSheets()

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

protected

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

Definition at line 662 of file netlist_exporter_spice.cpp.

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

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

◆ 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 '/'.