NETLIST_EXPORTER_BASE Class Reference

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.

 :
 m_schematic( aSchematic )
 {
 wxASSERT( aSchematic );
 }

~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 116 of file netlist_exporter_base.cpp.

{
 wxString ref( aSymbol->GetRef( aSheetPath ) );
 std::vector<PIN_INFO> pins;
 
 // Power symbols and other symbols which have the reference starting with "#" are not
 // included in netlist (pseudo or virtual symbols)
 
 if( ref[0] == wxChar( '#' ) )
 return pins;
 
 // if( aSymbol->m_FlagControlMulti == 1 )
 // continue; /* yes */
 // removed because with multiple instances of one schematic (several sheets pointing to
 // 1 screen), this will be erroneously be toggled.
 
 if( !aSymbol->GetLibSymbolRef() )
 return pins;
 
 // If symbol is a "multi parts per package" type
 if( aSymbol->GetLibSymbolRef()->GetUnitCount() > 1 )
 {
 // Collect all pins for this reference designator by searching the entire design for
 // other parts with the same reference designator.
 // This is only done once, it would be too expensive otherwise.
 findAllUnitsOfSymbol( aSymbol, aSheetPath, pins, aKeepUnconnectedPins );
 }
 
 else // GetUnitCount() <= 1 means one part per package
 {
 CONNECTION_GRAPH* graph = m_schematic->ConnectionGraph();
 
 for( const SCH_PIN* pin : aSymbol->GetPins( aSheetPath ) )
 {
 if( SCH_CONNECTION* conn = pin->Connection( aSheetPath ) )
 {
 const wxString& netName = conn->Name();
 
 if( !aKeepUnconnectedPins ) // Skip unconnected pins if requested
 {
 CONNECTION_SUBGRAPH* sg = graph->FindSubgraphByName( netName, *aSheetPath );
 
 if( !sg || sg->GetNoConnect() || sg->GetItems().size() < 2 )
 continue;
 }
 
 pins.emplace_back( pin->GetShownNumber(), netName );
 }
 }
 }
 
 // Sort pins in m_SortedSymbolPinList by pin number
 std::sort( pins.begin(), pins.end(),
 []( const PIN_INFO& lhs, const PIN_INFO& rhs )
 {
 return StrNumCmp( lhs.num, rhs.num, true ) < 0;
 } );
 
 // Remove duplicate Pins in m_SortedSymbolPinList
 eraseDuplicatePins( pins );
 
 // record the usage of this library symbol
 m_libParts.insert( aSymbol->GetLibSymbolRef().get() ); // rejects non-unique pointers
 
 return pins;
}

References SCHEMATIC_IFACE::ConnectionGraph(), eraseDuplicatePins(), findAllUnitsOfSymbol(), CONNECTION_GRAPH::FindSubgraphByName(), CONNECTION_SUBGRAPH::GetItems(), SCH_SYMBOL::GetLibSymbolRef(), CONNECTION_SUBGRAPH::GetNoConnect(), SCH_SYMBOL::GetPins(), SCH_SYMBOL::GetRef(), 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 186 of file netlist_exporter_base.cpp.

{
 for( unsigned ii = 0; ii < aPins.size(); ii++ )
 {
 if( aPins[ii].num.empty() ) /* already deleted */
 continue;
 
 /* Search for duplicated pins
 * If found, remove duplicates. The priority is to keep connected pins
 * and remove unconnected
 * - So this allows (for instance when using multi op amps per package
 * - to connect only one op amp to power
 * Because the pin list is sorted by m_PinNum value, duplicated pins
 * are necessary successive in list
 */
 int idxref = ii;
 
 for( unsigned jj = ii + 1; jj < aPins.size(); jj++ )
 {
 if( aPins[jj].num.empty() ) // Already removed
 continue;
 
 // if other pin num, stop search,
 // because all pins having the same number are consecutive in list.
 if( aPins[idxref].num != aPins[jj].num )
 break;
 
 aPins[jj].num.clear();
 }
 }
}

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 219 of file netlist_exporter_base.cpp.

{
 wxString ref = aSchSymbol->GetRef( aSheetPath );
 wxString ref2;
 
 SCH_SHEET_LIST sheetList = m_schematic->GetSheets();
 CONNECTION_GRAPH* graph = m_schematic->ConnectionGraph();
 
 for( unsigned i = 0; i < sheetList.size(); i++ )
 {
 SCH_SHEET_PATH& sheet = sheetList[i];
 
 for( SCH_ITEM* item : sheetList[i].LastScreen()->Items().OfType( SCH_SYMBOL_T ) )
 {
 SCH_SYMBOL* comp2 = static_cast<SCH_SYMBOL*>( item );
 
 ref2 = comp2->GetRef( &sheet );
 
 if( ref2.CmpNoCase( ref ) != 0 )
 continue;
 
 for( const SCH_PIN* pin : comp2->GetPins( &sheet ) )
 {
 if( SCH_CONNECTION* conn = pin->Connection( &sheet ) )
 {
 const wxString& netName = conn->Name();
 
 if( !aKeepUnconnectedPins ) // Skip unconnected pins if requested
 {
 CONNECTION_SUBGRAPH* sg = graph->FindSubgraphByName( netName, sheet );
 
 if( !sg || sg->GetNoConnect() || sg->GetItems().size() < 2 )
 continue;
 }
 
 aPins.emplace_back( pin->GetShownNumber(), netName );
 }
 }
 }
 }
}

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.

{
 wxCHECK( aItem, nullptr );
 wxCHECK( aSheetPath, nullptr );
 
 wxString ref;
 
 if( aItem->Type() != SCH_SYMBOL_T )
 return nullptr;
 
 // found next symbol
 SCH_SYMBOL* symbol = (SCH_SYMBOL*) aItem;
 
 // Power symbols and other symbols which have the reference starting with "#" are not
 // included in netlist (pseudo or virtual symbols)
 ref = symbol->GetRef( aSheetPath );
 
 if( ref[0] == wxChar( '#' ) )
 return nullptr;
 
 SCH_SCREEN* screen = aSheetPath->LastScreen();
 
 wxCHECK( screen, nullptr );
 
 LIB_SYMBOL* libSymbol = screen->GetLibSymbols()[ symbol->GetSchSymbolLibraryName() ];
 
 wxCHECK( libSymbol, nullptr );
 
 // If symbol is a "multi parts per package" type
 if( libSymbol->GetUnitCount() > 1 )
 {
 // test if this reference has already been processed, and if so skip
 if( m_referencesAlreadyFound.Lookup( ref ) )
 return nullptr;
 }
 
 // record the usage of this library symbol entry.
 m_libParts.insert( libSymbol ); // rejects non-unique pointers
 
 return symbol;
}

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

{
 // Expand format symbols in the command line:
 // %B => base filename of selected output file, minus path and extension.
 // %P => project directory name, without trailing '/' or '\'.
 // %I => full filename of the input file (the intermediate net file).
 // %O => complete filename and path (but without extension) of the user chosen output file.
 
 wxString ret = aFormatString;
 wxFileName in = aNetlistFile;
 wxFileName out = aFinalFile;
 wxString str_out = out.GetFullPath();
 
 ret.Replace( "%P", aProjectPath, true );
 ret.Replace( "%B", out.GetName(), true );
 ret.Replace( "%I", in.GetFullPath(), true );
 
#ifdef __WINDOWS__
 // A ugly hack to run xsltproc that has a serious bug on Window since a long time:
 // the filename given after -o option (output filename) cannot use '\' in filename
 // so replace if by '/' if possible (I mean if the filename does not start by "\\"
 // that is a filename on a Windows server)
 
 if( !str_out.StartsWith( "\\\\" ) )
 str_out.Replace( "\\", "/" );
#endif
 
 ret.Replace( "%O", str_out, true );
 
 return ret;
}

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_CADSTAR, NETLIST_EXPORTER_KICAD, NETLIST_EXPORTER_ORCADPCB2, NETLIST_EXPORTER_SPICE, and NETLIST_EXPORTER_XML.

Definition at line 109 of file netlist_exporter_base.h.

 {
 return false;
 }

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

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), CreatePinList(), findAllUnitsOfSymbol(), NETLIST_EXPORTER_SPICE::GetSheets(), NETLIST_EXPORTER_XML::makeDesignHeader(), NETLIST_EXPORTER_XML::makeLibraries(), NETLIST_EXPORTER_XML::makeListOfNets(), NETLIST_EXPORTER_XML::makeSymbols(), NETLIST_EXPORTER_SPICE::readModel(), NETLIST_EXPORTER_SPICE_MODEL::WriteHead(), NETLIST_EXPORTER_SPICE::writeInclude(), NETLIST_EXPORTER_CADSTAR::writeListOfNets(), NETLIST_EXPORTER_CADSTAR::WriteNetlist(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

---

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

• netlist_exporter_base.h
• netlist_exporter_base.cpp