NETLIST_EXPORTER_PSPICE_SIM Class Reference

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

#include <netlist_exporter_pspice_sim.h>

Inheritance diagram for NETLIST_EXPORTER_PSPICE_SIM:

Public Member Functions
	NETLIST_EXPORTER_PSPICE_SIM (SCHEMATIC_IFACE *aSchematic)
virtual	~NETLIST_EXPORTER_PSPICE_SIM ()
wxString	ComponentToVector (const wxString &aName, SIM_PLOT_TYPE aType, const wxString &aParam=wxEmptyString) const
	Return name of Spice dataset for a specific plot. More...
SIM_PLOT_TYPE	VectorToSignal (const std::string &aVector, wxString &aSignal) const
	Return name of Spice dataset for a specific plot. More...
void	SetSimCommand (const wxString &aCmd)
	Override the simulation command directive. More...
const wxString &	GetSimCommand () const
	Return the simulation command directive. More...
void	ClearSimCommand ()
	Clear the simulation command directive. More...
wxString	GetUsedSimCommand ()
	Return the command directive that is in use (either from the sheet or from m_simCommand. 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...
bool	ParseDCCommand (const wxString &aCmd, SPICE_DC_PARAMS *aSource1, SPICE_DC_PARAMS *aSource2)
	Parse a two-source .dc command directive into its symbols. More...
const std::list< SPICE_ITEM > &	GetSpiceItems () const
	Return list of items representing schematic components in the Spice world. More...
wxString	GetSpiceDevice (const wxString &aSymbol) const
	Return name of Spice device corresponding to a schematic symbol. More...
bool	WriteNetlist (const wxString &aOutFileName, unsigned aNetlistOptions) override
	Write to specified output file. More...
bool	Format (OUTPUTFORMATTER *aFormatter, unsigned aCtl)
bool	ProcessNetlist (unsigned aCtl)
	Process the netlist to create net mapping and a list of SPICE_ITEMs. More...
const std::map< wxString, int > &	GetNetIndexMap () const
	Return a map of circuit nodes to net names. More...
void	UpdateDirectives (unsigned aCtl)
	Update the vector of Spice directives placed in the schematics. More...
const std::vector< wxString >	GetDirectives () const
	Return a vector of Spice directives found in the schematics. More...

Static Public Member Functions
static const std::vector< wxString > &	GetCurrents (SPICE_PRIMITIVE aPrimitive)
	Return a list of currents that can be probed in a Spice primitive. More...
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	ReplaceForbiddenChars (wxString &aNetName)
	Replace illegal spice net name characters with an underscore. More...
static const std::vector< wxString > &	GetSpiceFields ()
	Return a vector of component field names related to Spice simulation. More...
static const wxString &	GetSpiceFieldName (SPICE_FIELD aField)
	Return a string used for a particular component field related to Spice simulation. More...
static wxString	GetSpiceField (SPICE_FIELD aField, SCH_SYMBOL *aSymbol, unsigned aCtl)
	Retrieve either the requested field value or the default value. More...
static wxString	GetSpiceFieldDefVal (SPICE_FIELD aField, SCH_SYMBOL *aSymbol, unsigned aCtl)
	Retrieve the default value for a given field. More...
static bool	StringToBool (const wxString &aStr)
	Convert typical boolean string values (no/yes, true/false, 1/0) to a boolean value. 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 aCtl) const override
	Save the Spice directives. 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, LIB_SYMBOL *aLibSymbol, 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...
SCH_SHEET_PATH	m_savedCurrentSheet
	The schematic's CurrentSheet when we entered. Restore on exiting. More...

Private Attributes
wxString	m_simCommand
	< Custom simulation command (has priority over the schematic sheet simulation commands) More...

Detailed Description

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

Definition at line 46 of file netlist_exporter_pspice_sim.h.

Constructor & Destructor Documentation

NETLIST_EXPORTER_PSPICE_SIM()

NETLIST_EXPORTER_PSPICE_SIM::NETLIST_EXPORTER_PSPICE_SIM ( SCHEMATIC_IFACE *  aSchematic )

inline

Definition at line 49 of file netlist_exporter_pspice_sim.h.

                                                               :
            NETLIST_EXPORTER_PSPICE( aSchematic )
    {
    }

~NETLIST_EXPORTER_PSPICE_SIM()

virtual NETLIST_EXPORTER_PSPICE_SIM::~NETLIST_EXPORTER_PSPICE_SIM ( )

inlinevirtual

Definition at line 53 of file netlist_exporter_pspice_sim.h.

{}

Member Function Documentation

ClearSimCommand()

void NETLIST_EXPORTER_PSPICE_SIM::ClearSimCommand ( )

inline

Clear the simulation command directive.

Definition at line 102 of file netlist_exporter_pspice_sim.h.

    {
        m_simCommand.Clear();
    }

References m_simCommand.

CommandToSimType()

SIM_TYPE NETLIST_EXPORTER_PSPICE_SIM::CommandToSimType ( const wxString &  aCmd )

static

Return simulation type basing on a simulation command directive.

Definition at line 170 of file netlist_exporter_pspice_sim.cpp.

{
    const std::vector<std::pair<wxString, SIM_TYPE>> simCmds = {
        { "^.ac\\M.*", ST_AC },
        { "^.dc\\M.*", ST_DC },
        { "^.tran\\M.*", ST_TRANSIENT },
        { "^.op\\M.*", ST_OP },
        { "^.disto\\M.*", ST_DISTORTION },
        { "^.noise\\M.*", ST_NOISE },
        { "^.pz\\M.*", ST_POLE_ZERO },
        { "^.sens\\M.*", ST_SENSITIVITY },
        { "^.tf\\M.*", ST_TRANS_FUNC } };
    wxRegEx simCmd;

    for( const auto& 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(), and SIM_PANEL_BASE::setSimCommand().

ComponentToVector()

wxString NETLIST_EXPORTER_PSPICE_SIM::ComponentToVector	(	const wxString &	aName,
		SIM_PLOT_TYPE	aType,
		const wxString &	aParam = wxEmptyString
	)		const

Return name of Spice dataset for a specific plot.

Parameters

aName	is name of the measured net or device
aType	describes the type of expected plot
aParam	is an optional parameter for devices, if absent it will return current (only for passive devices).

Returns

Empty string if query is invalid, otherwise a plot name that can be requested from the simulator.

Definition at line 33 of file netlist_exporter_pspice_sim.cpp.

{
    wxString res;

    // Some of the flags should exclude mutually
    wxASSERT( ( ( aType & SPT_VOLTAGE ) == 0 ) != ( ( aType & SPT_CURRENT ) == 0 ) );
    wxASSERT( ( ( aType & SPT_AC_PHASE ) == 0 ) || ( ( aType & SPT_AC_MAG ) == 0 ) );

    if( aType & SPT_VOLTAGE )
    {
        // netnames are escaped (can contain "{slash}" for '/') Unscape them:
        wxString spicenet = UnescapeString( aName );

        // Spice netlist netnames does not accept some chars, which are replaced
        // by eeschema netlist generator.
        // Replace these forbidden chars to find the actual spice net name
        NETLIST_EXPORTER_PSPICE::ReplaceForbiddenChars( spicenet );

        return wxString::Format( "V(%s)", spicenet );
    }

    else if( aType & SPT_CURRENT )
    {
        wxString device = GetSpiceDevice( aName ).Lower();
        wxString param = aParam.Lower();

        if( device.length() > 0 && device[0] == 'x' )
        {
            return "current probe of .subckt not yet implemented";
        }
        else
        {
            return wxString::Format( "@%s[%s]",
                                     device,
                                     param.IsEmpty() ? "i" : param );
        }
    }

    return res;
}

References Format(), NETLIST_EXPORTER_PSPICE::GetSpiceDevice(), NETLIST_EXPORTER_PSPICE::ReplaceForbiddenChars(), SPT_AC_MAG, SPT_AC_PHASE, SPT_CURRENT, SPT_VOLTAGE, and UnescapeString().

Referenced by writeDirectives().

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 124 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, aSymbol->GetLibSymbolRef().get(),
                              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
    sort( m_sortedSymbolPinList.begin(), m_sortedSymbolPinList.end(), sortPinsByNum );

    // 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, pin, and sortPinsByNum().

Referenced by NETLIST_EXPORTER_PSPICE::ProcessNetlist(), and NETLIST_EXPORTER_ORCADPCB2::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 190 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, LIB_SYMBOL *  aLibSymbol, 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 223 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().

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

Format()

bool NETLIST_EXPORTER_PSPICE::Format ( OUTPUTFORMATTER *  aFormatter, unsigned  aCtl  )

inherited

Definition at line 84 of file netlist_exporter_pspice.cpp.

{
    // Netlist options
    const bool useNetcodeAsNetName = false;//aCtl & NET_USE_NETCODES_AS_NETNAMES;

    // default title
    m_title = "KiCad schematic";

    if( !ProcessNetlist( aCtl ) )
        return false;

    aFormatter->Print( 0, ".title %s\n", TO_UTF8( m_title ) );

    // Write .include directives
    for( const wxString& curr_lib : m_libraries )
    {
        // First, expand env vars, if any
        wxString libname = ExpandEnvVarSubstitutions( curr_lib, &m_schematic->Prj() );
        wxString full_path;

        if( ( aCtl & NET_ADJUST_INCLUDE_PATHS ) )
        {
            // Look for the library in known search locations
            full_path = ResolveFile( libname, &Pgm().GetLocalEnvVariables(), &m_schematic->Prj() );

            if( full_path.IsEmpty() )
            {
                DisplayError( nullptr, wxString::Format( _( "Could not find library file %s." ),
                                                         libname ) );
                full_path = libname;
            }
        }
        else
        {
            full_path = libname;    // just use the unaltered path
        }

        aFormatter->Print( 0, ".include \"%s\"\n", TO_UTF8( full_path ) );
    }

    unsigned int NC_counter = 1;

    for( const SPICE_ITEM& item : m_spiceItems )
    {
        if( !item.m_enabled )
            continue;

        wxString device = GetSpiceDevice( item.m_refName );
        aFormatter->Print( 0, "%s ", TO_UTF8( device ) );

        size_t pspiceNodes =
                item.m_pinSequence.empty() ? item.m_pins.size() : item.m_pinSequence.size();

        for( size_t ii = 0; ii < pspiceNodes; ii++ )
        {
            // Use the custom order if defined, otherwise use the standard pin order as defined
            // in the symbol.
            size_t activePinIndex = item.m_pinSequence.empty() ? ii : item.m_pinSequence[ii];

            // Valid used Node Indexes are in the set
            // {0,1,2,...m_item.m_pin.size()-1}
            if( activePinIndex >= item.m_pins.size() )
            {
                wxASSERT_MSG( false, "Used an invalid pin number in node sequence" );
                continue;
            }

            wxString netName = item.m_pins[activePinIndex];

            wxASSERT( m_netMap.count( netName ) );

            if( useNetcodeAsNetName )
            {
                aFormatter->Print( 0, "%d ", m_netMap[netName] );
            }
            else
            {
                // Replace parenthesis with underscore to prevent parse issues with simulators
                ReplaceForbiddenChars( netName );

                // unescape net names that contain a escaped sequence ("{slash}"):
                netName = UnescapeString( netName );

                // Borrow LTSpice's nomenclature for unconnected nets
                if( netName.IsEmpty() )
                    netName = wxString::Format( wxT( "NC_%.2u" ), NC_counter++ );

                aFormatter->Print( 0, "%s ", TO_UTF8( netName ) );
            }
        }

        aFormatter->Print( 0, "%s\n", TO_UTF8( item.m_model ) );
    }

    // Print out all directives found in the text fields on the schematics
    writeDirectives( aFormatter, aCtl );

    aFormatter->Print( 0, ".end\n" );

    return true;
}

References _, DisplayError(), ExpandEnvVarSubstitutions(), Format(), NETLIST_EXPORTER_PSPICE::GetSpiceDevice(), NETLIST_EXPORTER_PSPICE::m_libraries, NETLIST_EXPORTER_PSPICE::m_netMap, NETLIST_EXPORTER_BASE::m_schematic, NETLIST_EXPORTER_PSPICE::m_spiceItems, NETLIST_EXPORTER_PSPICE::m_title, NET_ADJUST_INCLUDE_PATHS, Pgm(), OUTPUTFORMATTER::Print(), SCHEMATIC_IFACE::Prj(), NETLIST_EXPORTER_PSPICE::ProcessNetlist(), NETLIST_EXPORTER_PSPICE::ReplaceForbiddenChars(), ResolveFile(), TO_UTF8, UnescapeString(), and NETLIST_EXPORTER_PSPICE::writeDirectives().

Referenced by NETLIST_EXPORTER_PSPICE::WriteNetlist().

GetCurrents()

const std::vector< wxString > & NETLIST_EXPORTER_PSPICE_SIM::GetCurrents ( SPICE_PRIMITIVE  aPrimitive )

static

Return a list of currents that can be probed in a Spice primitive.

Definition at line 111 of file netlist_exporter_pspice_sim.cpp.

{
    static const std::vector<wxString> passive = { "I" };
    static const std::vector<wxString> diode = { "Id" };
    static const std::vector<wxString> bjt = { "Ib", "Ic", "Ie" };
    static const std::vector<wxString> mos = { "Ig", "Id", "Is" };
    static const std::vector<wxString> empty;

    switch( aPrimitive )
    {
        case SP_RESISTOR:
        case SP_CAPACITOR:
        case SP_INDUCTOR:
        case SP_VSOURCE:
            return passive;

        case SP_DIODE:
            return diode;

        case SP_BJT:
            return bjt;

        case SP_MOSFET:
            return mos;

        default:
            return empty;
    }
}

References empty(), SP_BJT, SP_CAPACITOR, SP_DIODE, SP_INDUCTOR, SP_MOSFET, SP_RESISTOR, and SP_VSOURCE.

Referenced by DIALOG_SIGNAL_LIST::TransferDataToWindow(), and writeDirectives().

GetDirectives()

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

inlineinherited

Return a vector of Spice directives found in the schematics.

Definition at line 185 of file netlist_exporter_pspice.h.

    {
        return m_directives;
    }

References NETLIST_EXPORTER_PSPICE::m_directives.

Referenced by GetSheetSimCommand(), and writeDirectives().

GetNetIndexMap()

const std::map<wxString, int>& NETLIST_EXPORTER_PSPICE::GetNetIndexMap ( ) const

inlineinherited

Return a map of circuit nodes to net names.

Definition at line 146 of file netlist_exporter_pspice.h.

    {
        return m_netMap;
    }

References NETLIST_EXPORTER_PSPICE::m_netMap.

Referenced by DIALOG_SIM_SETTINGS::ShowModal(), DIALOG_SIM_SETTINGS::TransferDataFromWindow(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), and writeDirectives().

GetSheetSimCommand()

wxString NETLIST_EXPORTER_PSPICE_SIM::GetSheetSimCommand

(

)

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

Definition at line 142 of file netlist_exporter_pspice_sim.cpp.

{
    wxString simCmd;

    UpdateDirectives( NET_ALL_FLAGS );

    for( const auto& dir : GetDirectives() )
    {
        if( IsSimCommand( dir ) )
            simCmd += wxString::Format( "%s\r\n", dir );
    }

    return simCmd;
}

References Format(), NETLIST_EXPORTER_PSPICE::GetDirectives(), IsSimCommand(), NET_ALL_FLAGS, and NETLIST_EXPORTER_PSPICE::UpdateDirectives().

Referenced by GetUsedSimCommand(), and DIALOG_SIM_SETTINGS::loadDirectives().

GetSimCommand()

const wxString& NETLIST_EXPORTER_PSPICE_SIM::GetSimCommand ( ) const

inline

Return the simulation command directive.

Definition at line 94 of file netlist_exporter_pspice_sim.h.

    {
        return m_simCommand;
    }

References m_simCommand.

GetSimType()

SIM_TYPE NETLIST_EXPORTER_PSPICE_SIM::GetSimType

(

)

Return simulation type basing on the simulation command directives.

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

Definition at line 164 of file netlist_exporter_pspice_sim.cpp.

{
    return CommandToSimType( GetUsedSimCommand() );
}

References CommandToSimType(), and GetUsedSimCommand().

Referenced by DIALOG_SIGNAL_LIST::TransferDataToWindow().

GetSpiceDevice()

wxString NETLIST_EXPORTER_PSPICE::GetSpiceDevice ( const wxString &  aSymbol ) const

inherited

Return name of Spice device corresponding to a schematic symbol.

Parameters

aSymbol

is the component reference.

Returns

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

Definition at line 45 of file netlist_exporter_pspice.cpp.

{
    const std::list<SPICE_ITEM>& spiceItems = GetSpiceItems();

    auto it = std::find_if( spiceItems.begin(), spiceItems.end(),
                            [&]( const SPICE_ITEM& item )
                            {
                                return item.m_refName == aSymbol;
                            } );

    if( it == spiceItems.end() )
        return wxEmptyString;

    // Prefix the device type if plain reference would result in a different device type
    return it->m_primitive != it->m_refName[0] ? wxString( it->m_primitive + it->m_refName )
                                               : it->m_refName;
}

References NETLIST_EXPORTER_PSPICE::GetSpiceItems().

Referenced by ComponentToVector(), DIALOG_SIM_SETTINGS::evaluateDCControls(), NETLIST_EXPORTER_PSPICE::Format(), DIALOG_SIM_SETTINGS::TransferDataFromWindow(), and TUNER_SLIDER::TUNER_SLIDER().

GetSpiceField()

wxString NETLIST_EXPORTER_PSPICE::GetSpiceField ( SPICE_FIELD  aField, SCH_SYMBOL *  aSymbol, unsigned  aCtl  )

staticinherited

Retrieve either the requested field value or the default value.

Definition at line 187 of file netlist_exporter_pspice.cpp.

{
    SCH_FIELD* field = aSymbol->FindField( GetSpiceFieldName( aField ) );
    return field ? field->GetShownText() : GetSpiceFieldDefVal( aField, aSymbol, aCtl );
}

References SCH_SYMBOL::FindField(), SCH_FIELD::GetShownText(), NETLIST_EXPORTER_PSPICE::GetSpiceFieldDefVal(), and NETLIST_EXPORTER_PSPICE::GetSpiceFieldName().

Referenced by SIM_PLOT_FRAME::AddTuner(), and NETLIST_EXPORTER_PSPICE::ProcessNetlist().

GetSpiceFieldDefVal()

wxString NETLIST_EXPORTER_PSPICE::GetSpiceFieldDefVal ( SPICE_FIELD  aField, SCH_SYMBOL *  aSymbol, unsigned  aCtl  )

staticinherited

Retrieve the default value for a given field.

Definition at line 195 of file netlist_exporter_pspice.cpp.

{
    switch( aField )
    {
    case SF_PRIMITIVE:
    {
        const wxString refName = aSymbol->GetField( REFERENCE_FIELD )->GetShownText();
        return refName.GetChar( 0 );
    }

    case SF_MODEL:
    {
        wxChar prim = aSymbol->GetField( REFERENCE_FIELD )->GetShownText().GetChar( 0 );
        wxString value = aSymbol->GetField( VALUE_FIELD )->GetShownText();

        // Is it a passive component?
        if( aCtl & NET_ADJUST_PASSIVE_VALS && ( prim == 'C' || prim == 'L' || prim == 'R' ) )
        {
            // Regular expression to match common formats used for passive parts description
            // (e.g. 100k, 2k3, 1 uF)
            wxRegEx passiveVal(
                    "^([0-9\\. ]+)([fFpPnNuUmMkKgGtT]|M(e|E)(g|G))?([fFhH]|ohm)?([-1-9 ]*)$" );

            if( passiveVal.Matches( value ) )
            {
                wxString prefix( passiveVal.GetMatch( value, 1 ) );
                wxString unit( passiveVal.GetMatch( value, 2 ) );
                wxString suffix( passiveVal.GetMatch( value, 6 ) );

                prefix.Trim(); prefix.Trim( false );
                unit.Trim(); unit.Trim( false );
                suffix.Trim(); suffix.Trim( false );

                // Make 'mega' units comply with the Spice expectations
                if( unit == "M" )
                    unit = "Meg";

                value = prefix + unit + suffix;
            }
        }

        return value;
    }

    case SF_ENABLED:
        return wxString( "Y" );

    case SF_NODE_SEQUENCE:
    {
        wxString nodeSeq;
        std::vector<LIB_PIN*> pins;

        wxCHECK( aSymbol->GetLibSymbolRef(), wxString() );
        aSymbol->GetLibSymbolRef()->GetPins( pins );

        for( LIB_PIN* pin : pins )
            nodeSeq += pin->GetNumber() + " ";

        nodeSeq.Trim();

        return nodeSeq;
    }

    case SF_LIB_FILE:
        // There is no default Spice library
        return wxEmptyString;

    default:
        wxASSERT_MSG( false, "Missing default value definition for a Spice field." );
        return wxString( "<unknown>" );
    }
}

References SCH_SYMBOL::GetField(), SCH_SYMBOL::GetLibSymbolRef(), SCH_FIELD::GetShownText(), NET_ADJUST_PASSIVE_VALS, pin, REFERENCE_FIELD, SF_ENABLED, SF_LIB_FILE, SF_MODEL, SF_NODE_SEQUENCE, SF_PRIMITIVE, and VALUE_FIELD.

Referenced by NETLIST_EXPORTER_PSPICE::GetSpiceField(), and DIALOG_SPICE_MODEL::TransferDataToWindow().

GetSpiceFieldName()

static const wxString& NETLIST_EXPORTER_PSPICE::GetSpiceFieldName ( SPICE_FIELD  aField )

inlinestaticinherited

Return a string used for a particular component field related to Spice simulation.

Definition at line 162 of file netlist_exporter_pspice.h.

    {
        return m_spiceFields[(int) aField];
    }

References NETLIST_EXPORTER_PSPICE::m_spiceFields.

Referenced by DIALOG_SPICE_MODEL::getLibField(), DIALOG_SPICE_MODEL::getSchField(), NETLIST_EXPORTER_PSPICE::GetSpiceField(), NETLIST_EXPORTER_PSPICE::ProcessNetlist(), and DIALOG_SPICE_MODEL::TransferDataFromWindow().

GetSpiceFields()

static const std::vector<wxString>& NETLIST_EXPORTER_PSPICE::GetSpiceFields ( )

inlinestaticinherited

Return a vector of component field names related to Spice simulation.

Definition at line 154 of file netlist_exporter_pspice.h.

    {
        return m_spiceFields;
    }

References NETLIST_EXPORTER_PSPICE::m_spiceFields.

Referenced by DIALOG_SPICE_MODEL::TransferDataToWindow().

GetSpiceItems()

const std::list<SPICE_ITEM>& NETLIST_EXPORTER_PSPICE::GetSpiceItems ( ) const

inlineinherited

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

Definition at line 105 of file netlist_exporter_pspice.h.

    {
        return m_spiceItems;
    }

References NETLIST_EXPORTER_PSPICE::m_spiceItems.

Referenced by NETLIST_EXPORTER_PSPICE::GetSpiceDevice(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_SIM_SETTINGS::updateDCSources(), and writeDirectives().

GetUsedSimCommand()

wxString NETLIST_EXPORTER_PSPICE_SIM::GetUsedSimCommand

(

)

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

Returns

Definition at line 158 of file netlist_exporter_pspice_sim.cpp.

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

References GetSheetSimCommand(), and m_simCommand.

Referenced by GetSimType().

IsSimCommand()

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

inlinestatic

Determine if a directive is a simulation command.

Definition at line 138 of file netlist_exporter_pspice_sim.h.

    {
        return CommandToSimType( aCmd ) != ST_UNKNOWN;
    }

References CommandToSimType(), and ST_UNKNOWN.

Referenced by GetSheetSimCommand(), and writeDirectives().

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 NETLIST_EXPORTER_PSPICE_SIM::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 196 of file netlist_exporter_pspice_sim.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.

Referenced by DIALOG_SIM_SETTINGS::parseCommand().

ProcessNetlist()

bool NETLIST_EXPORTER_PSPICE::ProcessNetlist ( unsigned  aCtl )

inherited

Process the netlist 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.

Definition at line 270 of file netlist_exporter_pspice.cpp.

{
    const wxString     delimiters( "{:,; }" );
    SCH_SHEET_LIST     sheetList = m_schematic->GetSheets();
    std::set<wxString> refNames;       // Set of reference names, to check for duplication

    m_netMap.clear();
    m_netMap["GND"] = 0;        // 0 is reserved for "GND"
    int netIdx = 1;

    m_libraries.clear();
    m_referencesAlreadyFound.Clear();
    m_libParts.clear();

    UpdateDirectives( aCtl );

    for( unsigned sheet_idx = 0; sheet_idx < sheetList.size(); sheet_idx++ )
    {
        SCH_SHEET_PATH sheet = sheetList[sheet_idx];

        // Process symbol attributes to find Spice directives
        for( SCH_ITEM* item : sheet.LastScreen()->Items().OfType( SCH_SYMBOL_T ) )
        {
            SCH_SYMBOL* symbol = findNextSymbol( item, &sheet );

            if( !symbol )
                continue;

            CreatePinList( symbol, &sheet, true );
            SPICE_ITEM spiceItem;
            spiceItem.m_parent = symbol;

            // Obtain Spice fields
            SCH_FIELD* fieldLibFile = symbol->FindField( GetSpiceFieldName( SF_LIB_FILE ) );
            SCH_FIELD* fieldSeq     = symbol->FindField( GetSpiceFieldName( SF_NODE_SEQUENCE ) );

            spiceItem.m_primitive = GetSpiceField( SF_PRIMITIVE, symbol, aCtl )[0];
            spiceItem.m_model     = GetSpiceField( SF_MODEL, symbol, aCtl );
            spiceItem.m_refName   = symbol->GetRef( &sheet );

            // Duplicate references will result in simulation errors
            if( refNames.count( spiceItem.m_refName ) )
            {
                DisplayError( nullptr, _( "Multiple symbols have the same reference designator.\n"
                                          "Annotation must be corrected before simulating." ) );
                return false;
            }

            refNames.insert( spiceItem.m_refName );

            // Check to see if symbol should be removed from Spice netlist
            spiceItem.m_enabled = StringToBool( GetSpiceField( SF_ENABLED, symbol, aCtl ) );

            if( fieldLibFile && !fieldLibFile->GetShownText().IsEmpty() )
                m_libraries.insert( fieldLibFile->GetShownText() );

            wxArrayString pinNames;

            // Store pin information
            for( const PIN_INFO& pin : m_sortedSymbolPinList )
            {
                // Create net mapping
                spiceItem.m_pins.push_back( pin.netName );
                pinNames.Add( pin.num );

                if( m_netMap.count( pin.netName ) == 0 )
                    m_netMap[pin.netName] = netIdx++;
            }

            // Check if an alternative pin sequence is available:
            if( fieldSeq )
            {
                // Get the string containing the sequence of nodes:
                const wxString& nodeSeqIndexLineStr = fieldSeq->GetShownText();

                // Verify field exists and is not empty:
                if( !nodeSeqIndexLineStr.IsEmpty() )
                {
                    // Get Alt Pin Name Array From User:
                    wxStringTokenizer tkz( nodeSeqIndexLineStr, delimiters );

                    while( tkz.HasMoreTokens() )
                    {
                        wxString pinIndex = tkz.GetNextToken();
                        int      seq;

                        // Find PinName In Standard List assign Standard List Index to Name:
                        seq = pinNames.Index( pinIndex );

                        if( seq != wxNOT_FOUND )
                            spiceItem.m_pinSequence.push_back( seq );
                    }
                }
            }

            m_spiceItems.push_back( spiceItem );
        }
    }

    return true;
}

References _, UNIQUE_STRINGS::Clear(), NETLIST_EXPORTER_BASE::CreatePinList(), DisplayError(), SCH_SYMBOL::FindField(), NETLIST_EXPORTER_BASE::findNextSymbol(), SCH_SYMBOL::GetRef(), SCHEMATIC_IFACE::GetSheets(), SCH_FIELD::GetShownText(), NETLIST_EXPORTER_PSPICE::GetSpiceField(), NETLIST_EXPORTER_PSPICE::GetSpiceFieldName(), SCH_SCREEN::Items(), SCH_SHEET_PATH::LastScreen(), SPICE_ITEM::m_enabled, NETLIST_EXPORTER_BASE::m_libParts, NETLIST_EXPORTER_PSPICE::m_libraries, SPICE_ITEM::m_model, NETLIST_EXPORTER_PSPICE::m_netMap, SPICE_ITEM::m_parent, SPICE_ITEM::m_pins, SPICE_ITEM::m_pinSequence, SPICE_ITEM::m_primitive, NETLIST_EXPORTER_BASE::m_referencesAlreadyFound, SPICE_ITEM::m_refName, NETLIST_EXPORTER_BASE::m_schematic, NETLIST_EXPORTER_BASE::m_sortedSymbolPinList, NETLIST_EXPORTER_PSPICE::m_spiceItems, EE_RTREE::OfType(), pin, SCH_SYMBOL_T, SF_ENABLED, SF_LIB_FILE, SF_MODEL, SF_NODE_SEQUENCE, SF_PRIMITIVE, NETLIST_EXPORTER_PSPICE::StringToBool(), and NETLIST_EXPORTER_PSPICE::UpdateDirectives().

Referenced by NETLIST_EXPORTER_PSPICE::Format().

ReplaceForbiddenChars()

void NETLIST_EXPORTER_PSPICE::ReplaceForbiddenChars ( wxString &  aNetName )

staticinherited

Replace illegal spice net name characters with an underscore.

Definition at line 72 of file netlist_exporter_pspice.cpp.

{
    // some chars are not accepted in netnames in spice netlists, because they are separators
    // they are replaced an underscore or some other allowed char.
    // Note: this is a static function

    aNetName.Replace( "(", "_" );
    aNetName.Replace( ")", "_" );
    aNetName.Replace( " ", "_" );
}

Referenced by ComponentToVector(), and NETLIST_EXPORTER_PSPICE::Format().

SetSimCommand()

void NETLIST_EXPORTER_PSPICE_SIM::SetSimCommand ( const wxString &  aCmd )

inline

Override the simulation command directive.

Definition at line 86 of file netlist_exporter_pspice_sim.h.

    {
        m_simCommand = aCmd;
    }

References m_simCommand.

StringToBool()

static bool NETLIST_EXPORTER_PSPICE::StringToBool ( const wxString &  aStr )

inlinestaticinherited

Convert typical boolean string values (no/yes, true/false, 1/0) to a boolean value.

Definition at line 193 of file netlist_exporter_pspice.h.

    {
        if( aStr.IsEmpty() )
            return false;

        char c = tolower( aStr[0] );

        // Different ways of saying false (no/false/0)
        return !( c == 'n' || c == 'f' || c == '0' );
    }

Referenced by NETLIST_EXPORTER_PSPICE::ProcessNetlist(), and DIALOG_SPICE_MODEL::TransferDataToWindow().

UpdateDirectives()

void NETLIST_EXPORTER_PSPICE::UpdateDirectives ( unsigned  aCtl )

inherited

Update the vector of Spice directives placed in the schematics.

Definition at line 373 of file netlist_exporter_pspice.cpp.

{
    const SCH_SHEET_LIST& sheetList = m_schematic->GetSheets();
    wxRegEx couplingK( "^[kK][[:digit:]]*[[:space:]]+[[:alnum:]]+[[:space:]]+[[:alnum:]]+",
                       wxRE_ADVANCED );

    m_directives.clear();
    bool controlBlock = false;
    bool circuitBlock = false;

    for( unsigned i = 0; i < sheetList.size(); i++ )
    {
        for( SCH_ITEM* item : sheetList[i].LastScreen()->Items().OfType( SCH_TEXT_T ) )
        {
            wxString text = static_cast<SCH_TEXT*>( item )->GetShownText();

            if( text.IsEmpty() )
                continue;

            // Analyze each line of a text field
            wxStringTokenizer tokenizer( text, "\r\n" );

            // Flag to follow multiline directives
            bool directiveStarted = false;

            while( tokenizer.HasMoreTokens() )
            {
                wxString line( tokenizer.GetNextToken() );

                // Cleanup: remove preceding and trailing white-space characters
                line.Trim( true ).Trim( false );
                // Convert to lower-case for parsing purposes only
                wxString lowercaseline = line;
                lowercaseline.MakeLower();

                // 'Include' directive stores the library file name, so it
                // can be later resolved using a list of paths
                if( lowercaseline.StartsWith( ".inc" ) )
                {
                    wxString lib = line.AfterFirst( ' ' );

                    if( lib.IsEmpty() )
                        continue;

                    // Strip quotes if present
                    if( ( lib.StartsWith( "\"" ) && lib.EndsWith( "\"" ) )
                        || ( lib.StartsWith( "'" ) && lib.EndsWith( "'" ) ) )
                    {
                        lib = lib.Mid( 1, lib.Length() - 2 );
                    }

                    m_libraries.insert( lib );
                }

                // Store the title to be sure it appears
                // in the first line of output
                else if( lowercaseline.StartsWith( ".title " ) )
                {
                    m_title = line.AfterFirst( ' ' );
                }

                else if( line.StartsWith( '.' )                    // one-line directives
                        || controlBlock                            // .control .. .endc block
                        || circuitBlock                            // .subckt  .. .ends block
                        || couplingK.Matches( line )               // K## L## L## coupling constant
                        || ( directiveStarted && line.StartsWith( '+' ) ) ) // multiline directives
                {
                    m_directives.push_back( line );
                }

                // Handle .control .. .endc blocks
                if( lowercaseline.IsSameAs( ".control" ) && ( !controlBlock ) )
                    controlBlock = true;

                if( lowercaseline.IsSameAs( ".endc" ) && controlBlock )
                    controlBlock = false;

                // Handle .subckt .. .ends blocks
                if( lowercaseline.StartsWith( ".subckt" ) && ( !circuitBlock ) )
                    circuitBlock = true;

                if( lowercaseline.IsSameAs( ".ends" ) && circuitBlock )
                    circuitBlock = false;

                // Mark directive as started or continued in case it is a multi-line one
                directiveStarted = line.StartsWith( '.' )
                                        || ( directiveStarted && line.StartsWith( '+' ) );
            }
        }
    }
}

References SCHEMATIC_IFACE::GetSheets(), NETLIST_EXPORTER_PSPICE::m_directives, NETLIST_EXPORTER_PSPICE::m_libraries, NETLIST_EXPORTER_BASE::m_schematic, NETLIST_EXPORTER_PSPICE::m_title, SCH_TEXT_T, and text.

Referenced by GetSheetSimCommand(), and NETLIST_EXPORTER_PSPICE::ProcessNetlist().

VectorToSignal()

SIM_PLOT_TYPE NETLIST_EXPORTER_PSPICE_SIM::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 76 of file netlist_exporter_pspice_sim.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 = "V(" + aVector + ")";
        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 + "(";
            aSignal += internalDevParameter.GetMatch( vector, 1 ).Upper() + ")";
            return SPT_CURRENT;
        }
        else
        {
            return SPT_UNKNOWN;
        }
    }
}

References SPT_CURRENT, SPT_UNKNOWN, and SPT_VOLTAGE.

writeDirectives()

void NETLIST_EXPORTER_PSPICE_SIM::writeDirectives ( OUTPUTFORMATTER *  aFormatter, unsigned  aCtl  ) const

overrideprotectedvirtual

Save the Spice directives.

Todo:

is it required to switch to lowercase

Reimplemented from NETLIST_EXPORTER_PSPICE.

Definition at line 228 of file netlist_exporter_pspice_sim.cpp.

{
    // Add a directive to obtain currents
    //aFormatter->Print( 0, ".options savecurrents\n" );        // does not work :(

    for( const auto& item : GetSpiceItems() )
    {
        for( const auto& current :
                NETLIST_EXPORTER_PSPICE_SIM::GetCurrents( (SPICE_PRIMITIVE) item.m_primitive ) )
        {
            if( !item.m_enabled )
                continue;

            aFormatter->Print( 0, ".save %s\n",
                    TO_UTF8( ComponentToVector( item.m_refName, SPT_CURRENT, current ) ) );
        }
    }

    // If we print out .save directives for currents, then it needs to be done for voltages as well
    for( const auto& netMap : GetNetIndexMap() )
    {
        // the "0" and the "GND" nets are automatically saved internally by ngspice.
        // Skip them
        wxString netname = ComponentToVector( netMap.first, SPT_VOLTAGE );

        if( netname == "V(0)" || netname == "V(GND)" )
            continue;

        aFormatter->Print( 0, ".save %s\n", TO_UTF8( netname ) );
    }

    if( m_simCommand.IsEmpty() )
    {
        // Fallback to the default behavior and just write all directives
        NETLIST_EXPORTER_PSPICE::writeDirectives( aFormatter, aCtl );
    }
    else
    {
        // Dump all directives but simulation commands
        for( const auto& dir : GetDirectives() )
        {
            if( !IsSimCommand( dir ) )
                aFormatter->Print( 0, "%s\n", TO_UTF8( dir ) );
        }

        // Finish with our custom simulation command
        aFormatter->Print( 0, "%s\n", TO_UTF8( m_simCommand ) );
    }
}

References ComponentToVector(), GetCurrents(), NETLIST_EXPORTER_PSPICE::GetDirectives(), NETLIST_EXPORTER_PSPICE::GetNetIndexMap(), NETLIST_EXPORTER_PSPICE::GetSpiceItems(), IsSimCommand(), m_simCommand, OUTPUTFORMATTER::Print(), SPT_CURRENT, SPT_VOLTAGE, TO_UTF8, and NETLIST_EXPORTER_PSPICE::writeDirectives().

WriteNetlist()

bool NETLIST_EXPORTER_PSPICE::WriteNetlist ( const wxString &  aOutFileName, unsigned  aNetlistOptions  )

overridevirtualinherited

Write to specified output file.

Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.

Reimplemented from NETLIST_EXPORTER_BASE.

Definition at line 64 of file netlist_exporter_pspice.cpp.

{
    FILE_OUTPUTFORMATTER outputFile( aOutFileName, wxT( "wt" ), '\'' );

    return Format( &outputFile, aNetlistOptions );
}

References NETLIST_EXPORTER_PSPICE::Format().

Member Data Documentation

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 209 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_PSPICE::ProcessNetlist().

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 206 of file netlist_exporter_base.h.

Referenced by NETLIST_EXPORTER_BASE::findNextSymbol(), NETLIST_EXPORTER_XML::makeSymbols(), NETLIST_EXPORTER_PSPICE::ProcessNetlist(), NETLIST_EXPORTER_ORCADPCB2::WriteNetlist(), and NETLIST_EXPORTER_CADSTAR::WriteNetlist().

m_savedCurrentSheet

SCH_SHEET_PATH NETLIST_EXPORTER_BASE::m_savedCurrentSheet

protectedinherited

The schematic's CurrentSheet when we entered. Restore on exiting.

Definition at line 215 of file netlist_exporter_base.h.

Referenced by NETLIST_EXPORTER_BASE::NETLIST_EXPORTER_BASE(), and NETLIST_EXPORTER_BASE::~NETLIST_EXPORTER_BASE().

m_schematic

SCHEMATIC_IFACE* NETLIST_EXPORTER_BASE::m_schematic

protectedinherited

The schematic we're generating a netlist for.

Definition at line 212 of file netlist_exporter_base.h.

Referenced by NETLIST_EXPORTER_XML::addSymbolFields(), NETLIST_EXPORTER_BASE::CreatePinList(), NETLIST_EXPORTER_BASE::findAllUnitsOfSymbol(), NETLIST_EXPORTER_PSPICE::Format(), NETLIST_EXPORTER_XML::makeDesignHeader(), NETLIST_EXPORTER_XML::makeLibraries(), NETLIST_EXPORTER_XML::makeListOfNets(), NETLIST_EXPORTER_XML::makeSymbols(), NETLIST_EXPORTER_BASE::NETLIST_EXPORTER_BASE(), NETLIST_EXPORTER_PSPICE::ProcessNetlist(), NETLIST_EXPORTER_PSPICE::UpdateDirectives(), NETLIST_EXPORTER_CADSTAR::writeListOfNets(), NETLIST_EXPORTER_ORCADPCB2::WriteNetlist(), NETLIST_EXPORTER_CADSTAR::WriteNetlist(), and NETLIST_EXPORTER_BASE::~NETLIST_EXPORTER_BASE().

m_simCommand

wxString NETLIST_EXPORTER_PSPICE_SIM::m_simCommand

private

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

Definition at line 154 of file netlist_exporter_pspice_sim.h.

Referenced by ClearSimCommand(), GetSimCommand(), GetUsedSimCommand(), SetSimCommand(), and writeDirectives().

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 202 of file netlist_exporter_base.h.

Referenced by NETLIST_EXPORTER_BASE::CreatePinList(), NETLIST_EXPORTER_BASE::eraseDuplicatePins(), NETLIST_EXPORTER_BASE::findAllUnitsOfSymbol(), NETLIST_EXPORTER_PSPICE::ProcessNetlist(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

---

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

• netlist_exporter_pspice_sim.h
• netlist_exporter_pspice_sim.cpp