NGSPICE_CIRCUIT_MODEL Class Reference

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

#include <ngspice_circuit_model.h>

Inheritance diagram for NGSPICE_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_CUR_SHEET_AS_ROOT = 0x0100 , OPTION_SIM_COMMAND = 0x0200 , OPTION_DEFAULT_FLAGS }

Public Member Functions
	NGSPICE_CIRCUIT_MODEL (SCHEMATIC_IFACE *aSchematic, wxWindow *aDialogParent=nullptr)
virtual	~NGSPICE_CIRCUIT_MODEL ()
SIM_PLOT_TYPE	VectorToSignal (const std::string &aVector, wxString &aSignal) const
	Return name of Spice dataset for a specific plot. More...
void	SetSimOptions (int aOptions)
int	GetSimOptions () const
bool	GetNetlist (OUTPUTFORMATTER *aFormatter, REPORTER &aReporter)
void	SetSimCommandOverride (const wxString &aCmd)
	Override the simulation command directive. More...
wxString	GetSimCommand ()
	Return the command directive that is in use (either from the sheet or from m_simCommand) More...
wxString	GetSimCommandOverride () const
	Return the simulation command directive if stored separately (not as a sheet directive). More...
SIM_TYPE	GetSimType ()
	Return simulation type basing on the simulation command directives. More...
wxString	GetSheetSimCommand ()
	Return simulation command directives placed in schematic sheets (if any). More...
wxString	GetLastSheetSimCommand () const
	Return the sim command present as a sheet directive when the sim command override was last updated. More...
bool	ParseDCCommand (const wxString &aCmd, SPICE_DC_PARAMS *aSource1, SPICE_DC_PARAMS *aSource2)
	Parse a two-source .dc command directive into its symbols. More...
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 bool	IsSimCommand (const wxString &aCmd)
	Determine if a directive is a simulation command. More...
static SIM_TYPE	CommandToSimType (const wxString &aCmd)
	Return simulation type basing on a simulation command directive. More...
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	WriteDirectives (OUTPUTFORMATTER &aFormatter, unsigned aNetlistOptions) 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). More...
void	CreatePinList (SCH_SYMBOL *aSymbol, SCH_SHEET_PATH *aSheetPath, bool aKeepUnconnectedPins)
	Find a symbol from the DrawList and builds its pin list in m_sortedSymbolPinList. More...
SCH_SYMBOL *	findNextSymbol (EDA_ITEM *aItem, SCH_SHEET_PATH *aSheetPath)
	Check if the given symbol should be processed for netlisting. More...
void	eraseDuplicatePins ()
	Erase duplicate pins from m_sortedSymbolPinList (i.e. More...
void	findAllUnitsOfSymbol (SCH_SYMBOL *aSchSymbol, SCH_SHEET_PATH *aSheetPath, bool aKeepUnconnectedPins)
	Find all units for symbols with multiple symbols per package. More...

Protected Attributes
std::vector< PIN_INFO >	m_sortedSymbolPinList
	Used to temporarily store and filter the list of pins of a schematic symbol when generating schematic symbol data in netlist (comp section). More...
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)
void	readPinNetNames (SCH_SYMBOL &aSymbol, SPICE_ITEM &aItem, 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
wxString	m_simCommand
	< Custom simulation command (has priority over the schematic sheet simulation commands) More...
wxString	m_lastSheetSimCommand
int	m_options
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

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

Definition at line 47 of file ngspice_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_CUR_SHEET_AS_ROOT
OPTION_SIM_COMMAND
OPTION_DEFAULT_FLAGS

Definition at line 52 of file netlist_exporter_spice.h.

 {
 OPTION_ADJUST_INCLUDE_PATHS = 0x0010,
 OPTION_ADJUST_PASSIVE_VALS = 0x0020,
 OPTION_SAVE_ALL_VOLTAGES = 0x0040,
 OPTION_SAVE_ALL_CURRENTS = 0x0080,
 OPTION_CUR_SHEET_AS_ROOT = 0x0100,
 OPTION_SIM_COMMAND = 0x0200,
 OPTION_DEFAULT_FLAGS = OPTION_ADJUST_INCLUDE_PATHS
 | OPTION_ADJUST_PASSIVE_VALS
 | OPTION_SAVE_ALL_VOLTAGES
 | OPTION_SAVE_ALL_CURRENTS
 };

Constructor & Destructor Documentation

NGSPICE_CIRCUIT_MODEL()

NGSPICE_CIRCUIT_MODEL::NGSPICE_CIRCUIT_MODEL ( SCHEMATIC_IFACE *  aSchematic, wxWindow *  aDialogParent = nullptr  )

inline

Definition at line 50 of file ngspice_circuit_model.h.

 :
 NETLIST_EXPORTER_SPICE( aSchematic, aDialogParent ),
 m_options( NETLIST_EXPORTER_SPICE::OPTION_DEFAULT_FLAGS )
 {}

~NGSPICE_CIRCUIT_MODEL()

virtual NGSPICE_CIRCUIT_MODEL::~NGSPICE_CIRCUIT_MODEL ( )

inlinevirtual

Definition at line 55 of file ngspice_circuit_model.h.

{}

Member Function Documentation

CommandToSimType()

SIM_TYPE NGSPICE_CIRCUIT_MODEL::CommandToSimType ( const wxString &  aCmd )

static

Return simulation type basing on a simulation command directive.

Definition at line 90 of file ngspice_circuit_model.cpp.

{
 const std::vector<std::pair<wxString, SIM_TYPE>> simCmds = {
 { wxT( "^.ac\\M.*" ), ST_AC },
 { wxT( "^.dc\\M.*" ), ST_DC },
 { wxT( "^.tran\\M.*" ), ST_TRANSIENT },
 { wxT( "^.op\\M.*" ), ST_OP },
 { wxT( "^.disto\\M.*" ), ST_DISTORTION },
 { wxT( "^.noise\\M.*" ), ST_NOISE },
 { wxT( "^.pz\\M.*" ), ST_POLE_ZERO },
 { wxT( "^.sens\\M.*" ), ST_SENSITIVITY },
 { wxT( "^.tf\\M.*" ), ST_TRANS_FUNC } };
 wxRegEx simCmd;
 
 for( const std::pair<wxString, SIM_TYPE>& c : simCmds )
 {
 simCmd.Compile( c.first, wxRE_ADVANCED | wxRE_NOSUB | wxRE_ICASE );
 
 if( simCmd.Matches( aCmd ) )
 return c.second;
 }
 
 return ST_UNKNOWN;
}

References ST_AC, ST_DC, ST_DISTORTION, ST_NOISE, ST_OP, ST_POLE_ZERO, ST_SENSITIVITY, ST_TRANS_FUNC, ST_TRANSIENT, and ST_UNKNOWN.

Referenced by BOOST_AUTO_TEST_CASE(), GetSimType(), SIM_PANEL_BASE::GetType(), IsSimCommand(), SIM_PLOT_FRAME::NewPlotPanel(), SIM_PLOT_FRAME::onSettings(), SIM_PANEL_BASE::setSimCommand(), and SIM_PLOT_FRAME::StartSimulation().

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

{
 MARKUP::MARKUP_PARSER markupParser( aNetName );
 std::unique_ptr<MARKUP::NODE> root = markupParser.Parse();
 std::string converted;
 
 std::function<void( const std::unique_ptr<MARKUP::NODE>&)> convertMarkup =
 [&]( const std::unique_ptr<MARKUP::NODE>& aNode )
 {
 if( aNode )
 {
 if( !aNode->is_root() )
 {
 if( aNode->isOverbar() )
 {
 // ~{CLK} is a different signal than CLK
 converted += '~';
 }
 else if( aNode->isSubscript() || aNode->isSuperscript() )
 {
 // V_{OUT} is just a pretty-printed version of VOUT
 }
 
 if( aNode->has_content() )
 converted += aNode->string();
 }
 
 for( const std::unique_ptr<MARKUP::NODE>& child : aNode->children )
 convertMarkup( child );
 }
 };
 
 convertMarkup( root );
 
 // Remove ngspice-disallowed chars
 std::replace( converted.begin(), converted.end(), '%', '_' );
 std::replace( converted.begin(), converted.end(), '(', '_' );
 std::replace( converted.begin(), converted.end(), ')', '_' );
 std::replace( converted.begin(), converted.end(), ',', '_' );
 std::replace( converted.begin(), converted.end(), '[', '_' );
 std::replace( converted.begin(), converted.end(), ']', '_' );
 std::replace( converted.begin(), converted.end(), '<', '_' );
 std::replace( converted.begin(), converted.end(), '>', '_' );
 std::replace( converted.begin(), converted.end(), '~', '_' );
 
 aNetName = converted;
}

References MARKUP::MARKUP_PARSER::Parse().

Referenced by NETLIST_EXPORTER_SPICE::GenerateItemPinNetName().

CreatePinList()

void 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 in m_sortedSymbolPinList.

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 ) );
 
 // 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;
 
 // 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;
 
 m_sortedSymbolPinList.clear();
 
 // 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, 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->m_no_connect || sg->m_items.size() < 2 )
 continue;
 }
 
 m_sortedSymbolPinList.emplace_back( pin->GetShownNumber(), netName );
 }
 }
 }
 
 // Sort pins in m_SortedSymbolPinList by pin number
 std::sort( m_sortedSymbolPinList.begin(), m_sortedSymbolPinList.end(),
 []( const PIN_INFO& lhs, const PIN_INFO& rhs )
 {
 return StrNumCmp( lhs.num, rhs.num, true ) < 0;
 } );
 
 // Remove duplicate Pins in m_SortedSymbolPinList
 eraseDuplicatePins();
 
 // record the usage of this library symbol
 m_libParts.insert( aSymbol->GetLibSymbolRef().get() ); // rejects non-unique pointers
}

References SCHEMATIC_IFACE::ConnectionGraph(), NETLIST_EXPORTER_BASE::eraseDuplicatePins(), NETLIST_EXPORTER_BASE::findAllUnitsOfSymbol(), CONNECTION_GRAPH::FindSubgraphByName(), SCH_SYMBOL::GetLibSymbolRef(), SCH_SYMBOL::GetPins(), SCH_SYMBOL::GetRef(), CONNECTION_SUBGRAPH::m_items, NETLIST_EXPORTER_BASE::m_libParts, CONNECTION_SUBGRAPH::m_no_connect, NETLIST_EXPORTER_BASE::m_schematic, NETLIST_EXPORTER_BASE::m_sortedSymbolPinList, and pin.

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

DoWriteNetlist()

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

inherited

Write the netlist in aFormatter.

Definition at line 121 of file netlist_exporter_spice.cpp.

{
 LOCALE_IO dummy;
 
 // Cleanup list to avoid duplicate if the netlist exporter is run more than once.
 m_rawIncludes.clear();
 
 if( !ReadSchematicAndLibraries( aNetlistOptions, aReporter ) )
 return false;
 
 WriteHead( aFormatter, aNetlistOptions );
 
 writeIncludes( aFormatter, aNetlistOptions );
 writeModels( aFormatter );
 
 // Skip this if there is no netlist to avoid an ngspice segfault
 if( !m_items.empty() )
 WriteDirectives( aFormatter, aNetlistOptions );
 
 writeItems( aFormatter );
 
 WriteTail( aFormatter, aNetlistOptions );
 
 return true;
}

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

protectedinherited

Erase duplicate pins from m_sortedSymbolPinList (i.e.

set pointer in this list to NULL).

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

{
 for( unsigned ii = 0; ii < m_sortedSymbolPinList.size(); ii++ )
 {
 if( m_sortedSymbolPinList[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 < m_sortedSymbolPinList.size(); jj++ )
 {
 if( m_sortedSymbolPinList[jj].num.empty() ) // Already removed
 continue;
 
 // if other pin num, stop search,
 // because all pins having the same number are consecutive in list.
 if( m_sortedSymbolPinList[idxref].num != m_sortedSymbolPinList[jj].num )
 break;
 
 m_sortedSymbolPinList[jj].num.clear();
 }
 }
}

References NETLIST_EXPORTER_BASE::m_sortedSymbolPinList.

Referenced by NETLIST_EXPORTER_BASE::CreatePinList().

findAllUnitsOfSymbol()

void NETLIST_EXPORTER_BASE::findAllUnitsOfSymbol ( SCH_SYMBOL *  aSchSymbol, SCH_SHEET_PATH *  aSheetPath, 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 temporary sorted pin list, m_sortedSymbolPinList. if aKeepUnconnectedPins = false, unconnected pins will be removed from list but usually we need all pins in netlists.

Definition at line 217 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->m_no_connect || sg->m_items.size() < 2 )
 continue;
 }
 
 m_sortedSymbolPinList.emplace_back( pin->GetShownNumber(), netName );
 }
 }
 }
 }
}

References SCHEMATIC_IFACE::ConnectionGraph(), CONNECTION_GRAPH::FindSubgraphByName(), SCH_SYMBOL::GetPins(), SCH_SYMBOL::GetRef(), SCHEMATIC_IFACE::GetSheets(), CONNECTION_SUBGRAPH::m_items, CONNECTION_SUBGRAPH::m_no_connect, NETLIST_EXPORTER_BASE::m_schematic, NETLIST_EXPORTER_BASE::m_sortedSymbolPinList, 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 351 of file netlist_exporter_spice.cpp.

{
 const std::list<SPICE_ITEM>& spiceItems = GetItems();
 
 auto it = std::find_if( spiceItems.begin(), spiceItems.end(),
 [aRefName]( const SPICE_ITEM& item )
 {
 return item.refName == aRefName;
 } );
 
 if( it != spiceItems.end() )
 return &*it;
 
 return nullptr;
}

References NETLIST_EXPORTER_SPICE::GetItems().

Referenced by SIM_PLOT_FRAME::AddTuner(), SIM_PLOT_FRAME::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.

{
 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(), NETLIST_EXPORTER_BASE::m_libParts, NETLIST_EXPORTER_BASE::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().

GenerateItemPinNetName()

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

protectedvirtualinherited

Reimplemented in NETLIST_EXPORTER_SPICE_MODEL.

Definition at line 660 of file netlist_exporter_spice.cpp.

{
 std::string netName = aNetName;
 
 ConvertToSpiceMarkup( netName );
 netName = std::string( UnescapeString( netName ).ToUTF8() );
 
 if( netName == "" )
 netName = fmt::format( "NC-{}", aNcCounter++ );
 
 return netName;
}

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 129 of file netlist_exporter_spice.h.

{ return m_directives; }

References NETLIST_EXPORTER_SPICE::m_directives.

Referenced by GetSheetSimCommand().

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

{
 const SPICE_ITEM* item = FindItem( aRefName );
 
 if( !item )
 return "";
 
 return item->model->SpiceGenerator().ItemName( *item );
}

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 122 of file netlist_exporter_spice.h.

{ return m_items; }

References NETLIST_EXPORTER_SPICE::m_items.

Referenced by NETLIST_EXPORTER_SPICE::FindItem(), and DIALOG_SIGNAL_LIST::TransferDataToWindow().

GetLastSheetSimCommand()

wxString NGSPICE_CIRCUIT_MODEL::GetLastSheetSimCommand ( ) const

inline

Return the sim command present as a sheet directive when the sim command override was last updated.

Returns

Definition at line 119 of file ngspice_circuit_model.h.

{ return m_lastSheetSimCommand; }

References m_lastSheetSimCommand.

GetNetlist()

bool NGSPICE_CIRCUIT_MODEL::GetNetlist ( OUTPUTFORMATTER *  aFormatter, REPORTER &  aReporter  )

inline

Definition at line 70 of file ngspice_circuit_model.h.

 {
 return NGSPICE_CIRCUIT_MODEL::DoWriteNetlist( *aFormatter, m_options, aReporter );
 }

References NETLIST_EXPORTER_SPICE::DoWriteNetlist(), and m_options.

Referenced by NGSPICE::Attach().

GetNets()

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

inlineinherited

Return the list of nets.

Definition at line 106 of file netlist_exporter_spice.h.

{ return m_nets; }

References NETLIST_EXPORTER_SPICE::m_nets.

Referenced by DIALOG_SIGNAL_LIST::TransferDataToWindow().

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

{
 if( aNetlistOptions & OPTION_CUR_SHEET_AS_ROOT )
 return SCH_SHEET_LIST( m_schematic->CurrentSheet().Last() );
 else
 return m_schematic->GetSheets();
}

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

GetSheetSimCommand()

wxString NGSPICE_CIRCUIT_MODEL::GetSheetSimCommand

(

)

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

Definition at line 68 of file ngspice_circuit_model.cpp.

{
 wxString simCmd;
 
 ReadDirectives( 0 );
 
 for( const wxString& directive : GetDirectives() )
 {
 if( IsSimCommand( directive ) )
 simCmd += wxString::Format( wxT( "%s\r\n" ), directive );
 }
 
 return simCmd;
}

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

Referenced by GetSimCommand(), and SetSimCommandOverride().

GetSimCommand()

wxString NGSPICE_CIRCUIT_MODEL::GetSimCommand ( )

inline

Return the command directive that is in use (either from the sheet or from m_simCommand)

Returns

Definition at line 91 of file ngspice_circuit_model.h.

 {
 return m_simCommand.IsEmpty() ? GetSheetSimCommand() : m_simCommand;
 }

References GetSheetSimCommand(), and m_simCommand.

Referenced by GetSimType().

GetSimCommandOverride()

wxString NGSPICE_CIRCUIT_MODEL::GetSimCommandOverride ( ) const

inline

Return the simulation command directive if stored separately (not as a sheet directive).

Definition at line 99 of file ngspice_circuit_model.h.

{ return m_simCommand; }

References m_simCommand.

Referenced by WriteDirectives().

GetSimOptions()

int NGSPICE_CIRCUIT_MODEL::GetSimOptions ( ) const

inline

Definition at line 68 of file ngspice_circuit_model.h.

{ return m_options; }

References m_options.

GetSimType()

SIM_TYPE NGSPICE_CIRCUIT_MODEL::GetSimType

(

)

Return simulation type basing on the simulation command directives.

Simulation directives set using SetSimCommandOverride() have priority over the ones placed in schematic sheets.

Definition at line 84 of file ngspice_circuit_model.cpp.

{
 return CommandToSimType( GetSimCommand() );
}

References CommandToSimType(), and GetSimCommand().

Referenced by DIALOG_SIGNAL_LIST::TransferDataToWindow().

IsSimCommand()

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

inlinestatic

Determine if a directive is a simulation command.

Definition at line 133 of file ngspice_circuit_model.h.

 {
 return CommandToSimType( aCmd ) != ST_UNKNOWN;
 }

References CommandToSimType(), and ST_UNKNOWN.

Referenced by GetSheetSimCommand().

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.

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

ParseDCCommand()

bool NGSPICE_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 116 of file ngspice_circuit_model.cpp.

{
 if( !aCmd.Lower().StartsWith( ".dc" ) )
 return false;
 
 wxString cmd = aCmd.Mid( 3 ).Trim().Trim( false );
 
 wxStringTokenizer tokens( cmd );
 
 size_t num = tokens.CountTokens();
 
 if( num != 4 && num != 8 )
 return false;
 
 aSource1->m_source = tokens.GetNextToken();
 aSource1->m_vstart = SPICE_VALUE( tokens.GetNextToken() );
 aSource1->m_vend = SPICE_VALUE( tokens.GetNextToken() );
 aSource1->m_vincrement = SPICE_VALUE( tokens.GetNextToken() );
 
 if( num == 8 )
 {
 aSource2->m_source = tokens.GetNextToken();
 aSource2->m_vstart = SPICE_VALUE( tokens.GetNextToken() );
 aSource2->m_vend = SPICE_VALUE( tokens.GetNextToken() );
 aSource2->m_vincrement = SPICE_VALUE( tokens.GetNextToken() );
 }
 
 return true;
}

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

ReadDirectives()

void NETLIST_EXPORTER_SPICE::ReadDirectives ( unsigned  aNetlistOptions )

protectedinherited

Definition at line 368 of file netlist_exporter_spice.cpp.

{
 wxString msg;
 wxString text;
 
 m_directives.clear();
 
 for( const SCH_SHEET_PATH& sheet : GetSheets( aNetlistOptions ) )
 {
 for( SCH_ITEM* item : sheet.LastScreen()->Items() )
 {
 if( item->Type() == SCH_TEXT_T )
 text = static_cast<SCH_TEXT*>( item )->GetShownText();
 else if( item->Type() == SCH_TEXTBOX_T )
  text = static_cast<SCH_TEXTBOX*>( item )->GetShownText();
 else
 continue;
 
 // Send anything that contains directives to SPICE
 wxStringTokenizer tokenizer( text, wxT( "\r\n" ), wxTOKEN_STRTOK );
 bool foundDirective = false;
 
 while( tokenizer.HasMoreTokens() )
 {
 wxString line = tokenizer.GetNextToken().Upper();
 
 if( line.StartsWith( wxT( "." ) ) )
 {
 if( line.StartsWith( wxT( ".AC" ) )
 || line.StartsWith( wxT( ".CONTROL" ) )
 || line.StartsWith( wxT( ".CSPARAM" ) )
 || line.StartsWith( wxT( ".DISTO" ) )
 || line.StartsWith( wxT( ".ELSE" ) )
 || line.StartsWith( wxT( ".ELSEIF" ) )
 || line.StartsWith( wxT( ".END" ) )
 || line.StartsWith( wxT( ".ENDC" ) )
 || line.StartsWith( wxT( ".ENDIF" ) )
 || line.StartsWith( wxT( ".ENDS" ) )
 || line.StartsWith( wxT( ".FOUR" ) )
 || line.StartsWith( wxT( ".FUNC" ) )
 || line.StartsWith( wxT( ".GLOBAL" ) )
 || line.StartsWith( wxT( ".IC" ) )
 || line.StartsWith( wxT( ".IF" ) )
 || line.StartsWith( wxT( ".INCLUDE" ) )
 || line.StartsWith( wxT( ".LIB" ) )
 || line.StartsWith( wxT( ".MEAS" ) )
 || line.StartsWith( wxT( ".MODEL" ) )
 || line.StartsWith( wxT( ".NODESET" ) )
 || line.StartsWith( wxT( ".NOISE" ) )
 || line.StartsWith( wxT( ".OP" ) )
 || line.StartsWith( wxT( ".OPTIONS" ) )
 || line.StartsWith( wxT( ".PARAM" ) )
 || line.StartsWith( wxT( ".PLOT" ) )
 || line.StartsWith( wxT( ".PRINT" ) )
 || line.StartsWith( wxT( ".PROBE" ) )
 || line.StartsWith( wxT( ".PZ" ) )
 || line.StartsWith( wxT( ".SAVE" ) )
 || line.StartsWith( wxT( ".SENS" ) )
 || line.StartsWith( wxT( ".SP" ) )
 || line.StartsWith( wxT( ".SUBCKT" ) )
 || line.StartsWith( wxT( ".TEMP" ) )
 || line.StartsWith( wxT( ".TF" ) )
 || line.StartsWith( wxT( ".TITLE" ) )
 || line.StartsWith( wxT( ".TRAN" ) )
 || line.StartsWith( wxT( ".WIDTH" ) ) )
  {
 foundDirective = true;
 break;
 }
 }
 else if( line.StartsWith( wxT( "K" ) ) )
 {
 // Check for mutual inductor declaration
 wxStringTokenizer line_t( line, wxT( " \t" ), wxTOKEN_STRTOK );
 
 // Coupling ID
 if( !line_t.HasMoreTokens() || !line_t.GetNextToken().StartsWith( wxT( "K" ) ) )
 continue;
 
 // Inductor 1 ID
 if( !line_t.HasMoreTokens() || !line_t.GetNextToken().StartsWith( wxT( "L" ) ) )
 continue;
 
 // Inductor 2 ID
 if( !line_t.HasMoreTokens() || !line_t.GetNextToken().StartsWith( wxT( "L" ) ) )
 continue;
 
 // That's probably distinctive enough not to bother trying to parse the
 // coupling value. If there's anything else, assume it's the value.
 if( line_t.HasMoreTokens() )
 {
 foundDirective = true;
 break;
 }
 }
 }
 
 if( foundDirective )
 m_directives.emplace_back( text );
 }
 }
}

References NETLIST_EXPORTER_SPICE::GetSheets(), SCH_TEXTBOX::GetShownText(), NETLIST_EXPORTER_SPICE::m_directives, SCH_TEXT_T, SCH_TEXTBOX_T, and text.

Referenced by GetSheetSimCommand(), and NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries().

readModel()

void NETLIST_EXPORTER_SPICE::readModel ( SCH_SHEET_PATH &  aSheet, SCH_SYMBOL &  aSymbol, SPICE_ITEM &  aItem  )

privateinherited

Definition at line 482 of file netlist_exporter_spice.cpp.

{
 SIM_LIBRARY::MODEL libModel = m_libMgr.CreateModel( &aSheet, aSymbol );
 
 aItem.baseModelName = libModel.name;
 aItem.model = &libModel.model;
 
 std::string modelName = aItem.model->SpiceGenerator().ModelName( aItem );
 // Resolve model name collisions.
 aItem.modelName = m_modelNameGenerator.Generate( modelName );
 
 // FIXME: Don't have special cases for raw Spice models and KIBIS.
 if( auto rawSpiceModel = dynamic_cast<const SIM_MODEL_RAW_SPICE*>( aItem.model ) )
 {
 int libParamIndex = static_cast<int>( SIM_MODEL_RAW_SPICE::SPICE_PARAM::LIB );
 wxString path = rawSpiceModel->GetParam( libParamIndex ).value->ToString();
 
 if( !path.IsEmpty() )
 m_rawIncludes.insert( path );
 }
 else if( auto kibisModel = dynamic_cast<const SIM_MODEL_KIBIS*>( aItem.model ) )
 {
 wxFileName cacheFn;
 cacheFn.AssignDir( PATHS::GetUserCachePath() );
 cacheFn.AppendDir( wxT( "ibis" ) );
 cacheFn.SetFullName( aSymbol.GetRef( &aSheet ) + wxT( ".cache" ) );
 
 wxFile cacheFile( cacheFn.GetFullPath(), wxFile::write );
 
 if( !cacheFile.IsOpened() )
 {
 DisplayErrorMessage( m_dialogParent,
 wxString::Format( _( "Could not open file '%s' to write "
  "IBIS model" ),
 cacheFn.GetFullPath() ) );
 }
 
 auto spiceGenerator = static_cast<const SPICE_GENERATOR_KIBIS&>( kibisModel->SpiceGenerator() );
 std::string modelData = spiceGenerator.IbisDevice( aItem, m_schematic->Prj(),
 cacheFn.GetPath( wxPATH_GET_SEPARATOR ) );
 
 cacheFile.Write( wxString( modelData ) );
 m_rawIncludes.insert( cacheFn.GetFullPath() );
 }
}

References _, SPICE_ITEM::baseModelName, SIM_LIB_MGR::CreateModel(), DisplayErrorMessage(), Format(), NAME_GENERATOR::Generate(), SCH_SYMBOL::GetRef(), PATHS::GetUserCachePath(), SPICE_GENERATOR_KIBIS::IbisDevice(), NETLIST_EXPORTER_SPICE::m_dialogParent, NETLIST_EXPORTER_SPICE::m_libMgr, NETLIST_EXPORTER_SPICE::m_modelNameGenerator, NETLIST_EXPORTER_SPICE::m_rawIncludes, NETLIST_EXPORTER_BASE::m_schematic, SIM_LIBRARY::MODEL::model, SPICE_ITEM::model, SPICE_ITEM::modelName, SPICE_GENERATOR::ModelName(), SIM_LIBRARY::MODEL::name, path, SCHEMATIC_IFACE::Prj(), and SIM_MODEL::SpiceGenerator().

Referenced by NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries().

readPinNetNames()

void NETLIST_EXPORTER_SPICE::readPinNetNames ( SCH_SYMBOL &  aSymbol, SPICE_ITEM &  aItem, int &  aNcCounter  )

privateinherited

Definition at line 537 of file netlist_exporter_spice.cpp.

{
 for( const PIN_INFO& pinInfo : m_sortedSymbolPinList )
 {
 std::string netName = GenerateItemPinNetName( std::string( pinInfo.netName.ToUTF8() ),
 aNcCounter );
 
 aItem.pinNetNames.push_back( netName );
 m_nets.insert( netName );
 }
}

References NETLIST_EXPORTER_SPICE::GenerateItemPinNetName(), NETLIST_EXPORTER_SPICE::m_nets, NETLIST_EXPORTER_BASE::m_sortedSymbolPinList, and SPICE_ITEM::pinNetNames.

Referenced by NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries().

readPinNumbers()

void NETLIST_EXPORTER_SPICE::readPinNumbers ( SCH_SYMBOL &  aSymbol, SPICE_ITEM &  aItem  )

privateinherited

Definition at line 530 of file netlist_exporter_spice.cpp.

{
 for( const PIN_INFO& pin : m_sortedSymbolPinList )
 aItem.pinNumbers.emplace_back( std::string( pin.num.ToUTF8() ) );
}

References NETLIST_EXPORTER_BASE::m_sortedSymbolPinList, pin, and SPICE_ITEM::pinNumbers.

Referenced by NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries().

readRefName()

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

privateinherited

Definition at line 472 of file netlist_exporter_spice.cpp.

{
 aItem.refName = aSymbol.GetRef( &aSheet );
 
 if( !aRefNames.insert( aItem.refName ).second )
 wxASSERT( wxT( "Duplicate refdes encountered; what happened to ReadyToNetlist()?" ) );
}

References SCH_SYMBOL::GetRef(), and SPICE_ITEM::refName.

Referenced by NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries().

ReadSchematicAndLibraries()

bool NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries ( unsigned  aNetlistOptions, REPORTER &  aReporter  )

virtualinherited

Process the schematic and Spice libraries to create net mapping and a list of SPICE_ITEMs.

It is automatically called by WriteNetlist(), but might be used separately, if only net mapping and the list of SPICE_ITEMs are required.

Returns

True if successful.

Reimplemented in NETLIST_EXPORTER_SPICE_MODEL.

Definition at line 161 of file netlist_exporter_spice.cpp.

{
 wxString msg;
 std::set<std::string> refNames; // Set of reference names to check for duplication.
 int ncCounter = 1;
 
 ReadDirectives( aNetlistOptions );
 
 m_nets.clear();
 m_items.clear();
 m_referencesAlreadyFound.Clear();
 m_libParts.clear();
 
 wxFileName cacheDir;
 cacheDir.AssignDir( PATHS::GetUserCachePath() );
 cacheDir.AppendDir( wxT( "ibis" ) );
 
 if( !cacheDir.DirExists() )
 {
 cacheDir.Mkdir( wxS_DIR_DEFAULT, wxPATH_MKDIR_FULL );
 
 if( !cacheDir.DirExists() )
 {
 wxLogTrace( wxT( "IBIS_CACHE:" ),
 wxT( "%s:%s:%d\n * failed to create ibis cache directory '%s'" ),
 __FILE__, __FUNCTION__, __LINE__, cacheDir.GetPath() );
 
 return false;
 }
 }
 
 wxDir dir;
 wxString dirName = cacheDir.GetFullPath();
 
 if( !dir.Open( dirName ) )
 return false;
 
 wxFileName thisFile;
 wxArrayString fileList;
 wxString fileSpec = wxT( "*.cache" );
 
 thisFile.SetPath( dirName ); // Set the base path to the cache folder
 
 size_t numFilesFound = wxDir::GetAllFiles( dirName, &fileList, fileSpec );
 
 for( size_t ii = 0; ii < numFilesFound; ii++ )
 {
 // Completes path to specific file so we can get its "last access" date
 thisFile.SetFullName( fileList[ii] );
 wxRemoveFile( thisFile.GetFullPath() );
 }
 
 for( SCH_SHEET_PATH& sheet : GetSheets( aNetlistOptions ) )
 {
 for( SCH_ITEM* item : sheet.LastScreen()->Items().OfType( SCH_SYMBOL_T ) )
 {
 SCH_SYMBOL* symbol = findNextSymbol( item, &sheet );
 
 if( !symbol || symbol->GetFieldText( SIM_ENABLE_FIELD ) == wxT( "0" ) )
 continue;
 
 CreatePinList( symbol, &sheet, true );
 
 SPICE_ITEM spiceItem;
 
 for( int i = 0; i < symbol->GetFieldCount(); ++i )
 {
 spiceItem.fields.emplace_back( VECTOR2I(), i, symbol,
 symbol->GetFields()[ i ].GetName() );
 
 if( i == REFERENCE_FIELD )
 spiceItem.fields.back().SetText( symbol->GetRef( &sheet ) );
 else
 spiceItem.fields.back().SetText( symbol->GetFields()[i].GetShownText( 0, false ) );
 }
 
 wxString deviceType;
 wxString modelType;
 wxString modelParams;
 wxString pinMap;
 
 // JEY TODO: readModel() below will also do the inference, so I don't think this
 // accomplishes anything....
 // Infer RLC and VI models if they aren't specified
 if( SIM_MODEL::InferSimModel( *symbol, &spiceItem.fields, true,
 SIM_VALUE_GRAMMAR::NOTATION::SPICE, &deviceType,
 &modelType, &modelParams, &pinMap ) )
 {
 spiceItem.fields.emplace_back( symbol, -1, SIM_DEVICE_TYPE_FIELD );
 spiceItem.fields.back().SetText( deviceType );
 
 if( !modelType.IsEmpty() )
 {
 spiceItem.fields.emplace_back( symbol, -1, SIM_TYPE_FIELD );
 spiceItem.fields.back().SetText( modelType );
 }
 
 spiceItem.fields.emplace_back( symbol, -1, SIM_PARAMS_FIELD );
 spiceItem.fields.back().SetText( modelParams );
 
 spiceItem.fields.emplace_back( symbol, -1, SIM_PINS_FIELD );
 spiceItem.fields.back().SetText( pinMap );
 }
 
 try
 {
 readRefName( sheet, *symbol, spiceItem, refNames );
 readModel( sheet, *symbol, spiceItem );
 readPinNumbers( *symbol, spiceItem );
 readPinNetNames( *symbol, spiceItem, ncCounter );
 
 // TODO: transmission line handling?
 
 m_items.push_back( std::move( spiceItem ) );
 }
 catch( const IO_ERROR& e )
 {
 msg.Printf( _( "Error reading simulation model from symbol '%s':\n%s" ),
 symbol->GetRef( &sheet ),
 e.Problem() );
 aReporter.Report( msg, RPT_SEVERITY_ERROR );
 }
 }
 }
 
 return !aReporter.HasMessage();
}

References _, UNIQUE_STRINGS::Clear(), NETLIST_EXPORTER_BASE::CreatePinList(), SPICE_ITEM::fields, NETLIST_EXPORTER_BASE::findNextSymbol(), SCH_SYMBOL::GetFieldCount(), SCH_SYMBOL::GetFields(), SCH_SYMBOL::GetFieldText(), SCH_SYMBOL::GetRef(), NETLIST_EXPORTER_SPICE::GetSheets(), PATHS::GetUserCachePath(), REPORTER::HasMessage(), SIM_MODEL::InferSimModel(), NETLIST_EXPORTER_SPICE::m_items, NETLIST_EXPORTER_BASE::m_libParts, NETLIST_EXPORTER_SPICE::m_nets, NETLIST_EXPORTER_BASE::m_referencesAlreadyFound, IO_ERROR::Problem(), NETLIST_EXPORTER_SPICE::ReadDirectives(), NETLIST_EXPORTER_SPICE::readModel(), NETLIST_EXPORTER_SPICE::readPinNetNames(), NETLIST_EXPORTER_SPICE::readPinNumbers(), NETLIST_EXPORTER_SPICE::readRefName(), REFERENCE_FIELD, REPORTER::Report(), RPT_SEVERITY_ERROR, SCH_SYMBOL_T, SIM_DEVICE_TYPE_FIELD, SIM_ENABLE_FIELD, SIM_PARAMS_FIELD, SIM_PINS_FIELD, SIM_TYPE_FIELD, and SIM_VALUE_GRAMMAR::SPICE.

Referenced by NETLIST_EXPORTER_SPICE::DoWriteNetlist(), and NETLIST_EXPORTER_SPICE_MODEL::ReadSchematicAndLibraries().

SetSimCommandOverride()

void NGSPICE_CIRCUIT_MODEL::SetSimCommandOverride ( const wxString &  aCmd )

inline

Override the simulation command directive.

Definition at line 78 of file ngspice_circuit_model.h.

 {
 if( aCmd != m_simCommand )
 {
 m_lastSheetSimCommand = GetSheetSimCommand();
 m_simCommand = aCmd;
 }
 }

References GetSheetSimCommand(), m_lastSheetSimCommand, and m_simCommand.

SetSimOptions()

void NGSPICE_CIRCUIT_MODEL::SetSimOptions ( int  aOptions )

inline

Definition at line 67 of file ngspice_circuit_model.h.

{ m_options = aOptions; }

References m_options.

VectorToSignal()

SIM_PLOT_TYPE NGSPICE_CIRCUIT_MODEL::VectorToSignal	(	const std::string &	aVector,
		wxString &	aSignal
	)		const

Return name of Spice dataset for a specific plot.

Parameters

	aVector	is name of the vector produced by ngspice
[out]	aSignal	is output in form: V(R1), Ib(Q2), I(L8)

Returns

[SPT_VOLTAGE, SPT_CURRENT]. Otherwise SPT_UNKNOWN if vector is of different, unsupported type.

Definition at line 33 of file ngspice_circuit_model.cpp.

{
 using namespace std;
 
 // See ngspice manual chapt. 31.1 "Accessing internal device parameters"
 wxRegEx internalDevParameter( "^@(\\w*[\\.\\w+]*)\\[(\\w*)\\]$", wxRE_ADVANCED );
 wxString vector( aVector );
 
 if( !internalDevParameter.Matches( vector ) )
 {
 // any text is a node name, which returns voltage
 aSignal = wxT( "V(" ) + aVector + wxT( ")" );
 return SPT_VOLTAGE;
 }
 else
 {
 wxString paramType = internalDevParameter.GetMatch( vector, 2 );
 
 if( paramType.Lower()[0] == 'i' )
 {
 // this is a branch current
 paramType[0] = 'I';
 aSignal = paramType + wxT( "(" );
 aSignal += internalDevParameter.GetMatch( vector, 1 ).Upper() + wxT( ")" );
 return SPT_CURRENT;
 }
 else
 {
 return SPT_UNKNOWN;
 }
 }
}

References SPT_CURRENT, SPT_UNKNOWN, and SPT_VOLTAGE.

WriteDirectives()

void NGSPICE_CIRCUIT_MODEL::WriteDirectives ( OUTPUTFORMATTER &  aFormatter, unsigned  aNetlistOptions  ) const

overrideprotectedvirtual

Reimplemented from NETLIST_EXPORTER_SPICE.

Definition at line 148 of file ngspice_circuit_model.cpp.

{
 if( GetSimCommandOverride().IsEmpty() )
 aNetlistOptions |= OPTION_SIM_COMMAND;
 
 NETLIST_EXPORTER_SPICE::WriteDirectives( aFormatter, aNetlistOptions );
 
 if( !GetSimCommandOverride().IsEmpty() )
 aFormatter.Print( 0, "%s\n", TO_UTF8( GetSimCommandOverride() ) );
}

References GetSimCommandOverride(), NETLIST_EXPORTER_SPICE::OPTION_SIM_COMMAND, OUTPUTFORMATTER::Print(), TO_UTF8, and NETLIST_EXPORTER_SPICE::WriteDirectives().

WriteHead()

void NETLIST_EXPORTER_SPICE::WriteHead ( OUTPUTFORMATTER &  aFormatter, unsigned  aNetlistOptions  )

virtualinherited

Write the netlist head (title and so on).

Reimplemented in NETLIST_EXPORTER_SPICE_MODEL.

Definition at line 149 of file netlist_exporter_spice.cpp.

{
 aFormatter.Print( 0, "KiCad schematic\n" );
}

References OUTPUTFORMATTER::Print().

Referenced by NETLIST_EXPORTER_SPICE::DoWriteNetlist().

writeInclude()

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

privateinherited

Definition at line 551 of file netlist_exporter_spice.cpp.

{
 // First, expand env vars, if any.
 wxString expandedPath = ExpandEnvVarSubstitutions( aPath, &m_schematic->Prj() );
 
 // Path may have been authored by someone on a Windows box; convert it to UNIX format
 expandedPath.Replace( '\\', '/' );
 
 wxString fullPath;
 
 if( aNetlistOptions & OPTION_ADJUST_INCLUDE_PATHS )
 {
 // Look for the library in known search locations.
 fullPath = ResolveFile( expandedPath, &Pgm().GetLocalEnvVariables(), &m_schematic->Prj() );
 
 if( fullPath.IsEmpty() )
 {
 DisplayErrorMessage( m_dialogParent,
 wxString::Format( _( "Could not find library file '%s'" ),
 expandedPath ) );
 fullPath = expandedPath;
 }
 else if( wxFileName::GetPathSeparator() == '\\' )
 {
 // Convert it to UNIX format (again) if ResolveFile() returned a Windows style path
 fullPath.Replace( '\\', '/' );
 }
 }
 else
 {
 fullPath = expandedPath;
 }
 
 aFormatter.Print( 0, ".include \"%s\"\n", TO_UTF8( fullPath ) );
}

References _, DisplayErrorMessage(), ExpandEnvVarSubstitutions(), Format(), NETLIST_EXPORTER_SPICE::m_dialogParent, NETLIST_EXPORTER_BASE::m_schematic, NETLIST_EXPORTER_SPICE::OPTION_ADJUST_INCLUDE_PATHS, Pgm(), OUTPUTFORMATTER::Print(), SCHEMATIC_IFACE::Prj(), ResolveFile(), and TO_UTF8.

Referenced by NETLIST_EXPORTER_SPICE::writeIncludes().

writeIncludes()

void NETLIST_EXPORTER_SPICE::writeIncludes ( OUTPUTFORMATTER &  aFormatter, unsigned  aNetlistOptions  )

privateinherited

Definition at line 589 of file netlist_exporter_spice.cpp.

{
 for( auto& [path, library] : m_libMgr.GetLibraries() )
 {
 if( dynamic_cast<const SIM_LIBRARY_SPICE*>( &library.get() ) )
 writeInclude( aFormatter, aNetlistOptions, path );
 }
 
 for( const wxString& path : m_rawIncludes )
 writeInclude( aFormatter, aNetlistOptions, path );
}

References SIM_LIB_MGR::GetLibraries(), library, NETLIST_EXPORTER_SPICE::m_libMgr, NETLIST_EXPORTER_SPICE::m_rawIncludes, path, and NETLIST_EXPORTER_SPICE::writeInclude().

Referenced by NETLIST_EXPORTER_SPICE::DoWriteNetlist().

writeItems()

void NETLIST_EXPORTER_SPICE::writeItems ( OUTPUTFORMATTER &  aFormatter )

privateinherited

Definition at line 614 of file netlist_exporter_spice.cpp.

{
 for( const SPICE_ITEM& item : m_items )
 {
 if( !item.model->IsEnabled() )
 continue;
 
 aFormatter.Print( 0, "%s", item.model->SpiceGenerator().ItemLine( item ).c_str() );
 }
}

References NETLIST_EXPORTER_SPICE::m_items, and OUTPUTFORMATTER::Print().

Referenced by NETLIST_EXPORTER_SPICE::DoWriteNetlist().

writeModels()

void NETLIST_EXPORTER_SPICE::writeModels ( OUTPUTFORMATTER &  aFormatter )

privateinherited

Definition at line 602 of file netlist_exporter_spice.cpp.

{
 for( const SPICE_ITEM& item : m_items )
 {
 if( !item.model->IsEnabled() )
 continue;
 
 aFormatter.Print( 0, "%s", item.model->SpiceGenerator().ModelLine( item ).c_str() );
 }
}

References NETLIST_EXPORTER_SPICE::m_items, and OUTPUTFORMATTER::Print().

Referenced by NETLIST_EXPORTER_SPICE::DoWriteNetlist().

WriteNetlist()

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

overridevirtualinherited

Write to specified output file.

Reimplemented from NETLIST_EXPORTER_BASE.

Definition at line 112 of file netlist_exporter_spice.cpp.

{
 m_libMgr.SetReporter( &aReporter );
 FILE_OUTPUTFORMATTER formatter( aOutFileName, wxT( "wt" ), '\'' );
 return DoWriteNetlist( formatter, aNetlistOptions, aReporter );
}

References NETLIST_EXPORTER_SPICE::DoWriteNetlist(), NETLIST_EXPORTER_SPICE::m_libMgr, and SIM_LIB_MGR::SetReporter().

WriteTail()

void NETLIST_EXPORTER_SPICE::WriteTail ( OUTPUTFORMATTER &  aFormatter, unsigned  aNetlistOptions  )

virtualinherited

Write the tail (.end).

Reimplemented in NETLIST_EXPORTER_SPICE_MODEL.

Definition at line 155 of file netlist_exporter_spice.cpp.

{
 aFormatter.Print( 0, ".end\n" );
}

References OUTPUTFORMATTER::Print().

Referenced by NETLIST_EXPORTER_SPICE::DoWriteNetlist().

Member Data Documentation

m_dialogParent

wxWindow* NETLIST_EXPORTER_SPICE::m_dialogParent

privateinherited

Definition at line 169 of file netlist_exporter_spice.h.

Referenced by NETLIST_EXPORTER_SPICE::readModel(), and NETLIST_EXPORTER_SPICE::writeInclude().

m_directives

std::vector<wxString> NETLIST_EXPORTER_SPICE::m_directives

privateinherited

Spice directives found in the schematic sheet.

Definition at line 162 of file netlist_exporter_spice.h.

Referenced by NETLIST_EXPORTER_SPICE::GetDirectives(), NETLIST_EXPORTER_SPICE::ReadDirectives(), and NETLIST_EXPORTER_SPICE::WriteDirectives().

m_items

std::list<SPICE_ITEM> NETLIST_EXPORTER_SPICE::m_items

privateinherited

Definition at line 167 of file netlist_exporter_spice.h.

Referenced by NETLIST_EXPORTER_SPICE::DoWriteNetlist(), NETLIST_EXPORTER_SPICE::GetItems(), NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries(), NETLIST_EXPORTER_SPICE::writeItems(), and NETLIST_EXPORTER_SPICE::writeModels().

m_lastSheetSimCommand

wxString NGSPICE_CIRCUIT_MODEL::m_lastSheetSimCommand

private

Definition at line 151 of file ngspice_circuit_model.h.

Referenced by GetLastSheetSimCommand(), and SetSimCommandOverride().

m_libMgr

SIM_LIB_MGR NETLIST_EXPORTER_SPICE::m_libMgr

privateinherited

Holds libraries and models.

Definition at line 157 of file netlist_exporter_spice.h.

Referenced by NETLIST_EXPORTER_SPICE::readModel(), NETLIST_EXPORTER_SPICE::writeIncludes(), and NETLIST_EXPORTER_SPICE::WriteNetlist().

m_libParts

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

protectedinherited

unique library symbols used. LIB_SYMBOL items are sorted by names

Definition at line 206 of file netlist_exporter_base.h.

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

m_modelNameGenerator

NAME_GENERATOR NETLIST_EXPORTER_SPICE::m_modelNameGenerator

privateinherited

Generates unique model names.

Generates unique net names (only unique for NC nets for now)

Definition at line 158 of file netlist_exporter_spice.h.

Referenced by NETLIST_EXPORTER_SPICE::readModel().

m_netNameGenerator

NAME_GENERATOR NETLIST_EXPORTER_SPICE::m_netNameGenerator

privateinherited

Definition at line 161 of file netlist_exporter_spice.h.

m_nets

std::set<std::string> NETLIST_EXPORTER_SPICE::m_nets

privateinherited

Items representing schematic symbols in Spice world.

Definition at line 164 of file netlist_exporter_spice.h.

Referenced by NETLIST_EXPORTER_SPICE::GetNets(), NETLIST_EXPORTER_SPICE::readPinNetNames(), and NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries().

m_options

int NGSPICE_CIRCUIT_MODEL::m_options

private

Definition at line 153 of file ngspice_circuit_model.h.

Referenced by GetNetlist(), GetSimOptions(), and SetSimOptions().

m_rawIncludes

std::set<wxString> NETLIST_EXPORTER_SPICE::m_rawIncludes

privateinherited

include directives found in symbols

Definition at line 163 of file netlist_exporter_spice.h.

Referenced by NETLIST_EXPORTER_SPICE::DoWriteNetlist(), NETLIST_EXPORTER_SPICE::readModel(), and NETLIST_EXPORTER_SPICE::writeIncludes().

m_referencesAlreadyFound

UNIQUE_STRINGS NETLIST_EXPORTER_BASE::m_referencesAlreadyFound

protectedinherited

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

Definition at line 203 of file netlist_exporter_base.h.

Referenced by NETLIST_EXPORTER_BASE::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

protectedinherited

The schematic we're generating a netlist for.

Definition at line 209 of file netlist_exporter_base.h.

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), NETLIST_EXPORTER_BASE::CreatePinList(), NETLIST_EXPORTER_BASE::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().

m_simCommand

wxString NGSPICE_CIRCUIT_MODEL::m_simCommand

private

< Custom simulation command (has priority over the schematic sheet simulation commands)

Value of schematic sheet simulation command when override was last updated

Definition at line 148 of file ngspice_circuit_model.h.

Referenced by GetSimCommand(), GetSimCommandOverride(), and SetSimCommandOverride().

m_sortedSymbolPinList

std::vector<PIN_INFO> NETLIST_EXPORTER_BASE::m_sortedSymbolPinList

protectedinherited

Used to temporarily store and filter the list of pins of a schematic symbol when generating schematic symbol data in netlist (comp section).

No ownership of members. TODO(snh): Descope this object

Definition at line 199 of file netlist_exporter_base.h.

Referenced by NETLIST_EXPORTER_BASE::CreatePinList(), NETLIST_EXPORTER_BASE::eraseDuplicatePins(), NETLIST_EXPORTER_BASE::findAllUnitsOfSymbol(), NETLIST_EXPORTER_SPICE::readPinNetNames(), NETLIST_EXPORTER_SPICE::readPinNumbers(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

---

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

• ngspice_circuit_model.h
• ngspice_circuit_model.cpp