An abstract class used for the netlist exporters that Eeschema supports. More...

#include <netlist_exporter_base.h>

Inheritance diagram for NETLIST_EXPORTER_BASE:

Public Member Functions
	NETLIST_EXPORTER_BASE (SCHEMATIC_IFACE *aSchematic)

virtual	~NETLIST_EXPORTER_BASE ()=default

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

Static Public Member Functions
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
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...

Detailed Description

An abstract class used for the netlist exporters that Eeschema supports.

Definition at line 91 of file netlist_exporter_base.h.

Constructor & Destructor Documentation

◆ NETLIST_EXPORTER_BASE()

NETLIST_EXPORTER_BASE::NETLIST_EXPORTER_BASE ( SCHEMATIC_IFACE * aSchematic )

inline

Parameters

aMasterList	we take ownership of this here.
aLibTable	is the symbol library table of the project.

Definition at line 98 of file netlist_exporter_base.h.

◆ ~NETLIST_EXPORTER_BASE()

virtual NETLIST_EXPORTER_BASE::~NETLIST_EXPORTER_BASE ( )

virtualdefault

Member Function Documentation

◆ CreatePinList()

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

protected

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(), eraseDuplicatePins(), findAllUnitsOfSymbol(), CONNECTION_GRAPH::FindSubgraphByName(), CONNECTION_SUBGRAPH::GetItems(), SCH_SYMBOL::GetLibSymbolRef(), CONNECTION_SUBGRAPH::GetNoConnect(), SCH_SYMBOL::GetPins(), SCH_SYMBOL::GetRef(), SCH_SYMBOL::IsPower(), m_libParts, m_schematic, and pin.

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

◆ eraseDuplicatePins()

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

protected

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 CreatePinList().

◆ findAllUnitsOfSymbol()

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

protected

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(), m_schematic, pin, and SCH_SYMBOL_T.

Referenced by CreatePinList().

◆ findNextSymbol()

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

protected

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(), m_libParts, 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(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

◆ MakeCommandLine()

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

static

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

◆ WriteNetlist()

virtual bool NETLIST_EXPORTER_BASE::WriteNetlist	(	const wxString &	aOutFileName,
		unsigned	aNetlistOptions,
		REPORTER &	aReporter
	)

inlinevirtual

Write to specified output file.

Reimplemented in NETLIST_EXPORTER_ALLEGRO, NETLIST_EXPORTER_CADSTAR, NETLIST_EXPORTER_KICAD, NETLIST_EXPORTER_ORCADPCB2, NETLIST_EXPORTER_SPICE, and NETLIST_EXPORTER_XML.

Definition at line 109 of file netlist_exporter_base.h.

Referenced by SCH_EDIT_FRAME::WriteNetListFile().

Member Data Documentation

◆ m_libParts

std::set<LIB_SYMBOL*, LIB_SYMBOL_LESS_THAN> NETLIST_EXPORTER_BASE::m_libParts

protected

unique library symbols used. LIB_SYMBOL items are sorted by names

Definition at line 200 of file netlist_exporter_base.h.

Referenced by CreatePinList(), NETLIST_EXPORTER_ALLEGRO::extractComponentsInfo(), findNextSymbol(), NETLIST_EXPORTER_XML::makeLibParts(), NETLIST_EXPORTER_XML::makeSymbols(), and NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries().

◆ m_referencesAlreadyFound

UNIQUE_STRINGS NETLIST_EXPORTER_BASE::m_referencesAlreadyFound

protected

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

Definition at line 197 of file netlist_exporter_base.h.

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

◆ m_schematic

SCHEMATIC_IFACE* NETLIST_EXPORTER_BASE::m_schematic

protected

The schematic we're generating a netlist for.

Definition at line 203 of file netlist_exporter_base.h.

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NETLIST_EXPORTER_BASE()

◆ ~NETLIST_EXPORTER_BASE()

Member Function Documentation

◆ CreatePinList()

◆ eraseDuplicatePins()

◆ findAllUnitsOfSymbol()

◆ findNextSymbol()

◆ MakeCommandLine()

◆ WriteNetlist()

Member Data Documentation

◆ m_libParts

◆ m_referencesAlreadyFound

◆ m_schematic