NETLIST_EXPORTER_PSPICE Class Reference

Generate a PSPICE compatible netlist. More...

#include <netlist_exporter_pspice.h>

Inheritance diagram for NETLIST_EXPORTER_PSPICE:

Public Types
typedef std::list< SPICE_ITEM >	SPICE_ITEM_LIST
	Net name to circuit node number mapping. More...
typedef std::map< wxString, int >	NET_INDEX_MAP

Public Member Functions
	NETLIST_EXPORTER_PSPICE (SCHEMATIC_IFACE *aSchematic)
virtual	~NETLIST_EXPORTER_PSPICE ()
const SPICE_ITEM_LIST &	GetSpiceItems () const
	Return list of items representing schematic components in the Spice world. More...
wxString	GetSpiceDevice (const wxString &aComponent) const
	Return name of Spice device corresponding to a schematic component. 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 NET_INDEX_MAP &	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 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_COMPONENT *aComponent, unsigned aCtl)
	Retrieve either the requested field value or the default value. More...
static wxString	GetSpiceFieldDefVal (SPICE_FIELD aField, SCH_COMPONENT *aComponent, 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)
	Function MakeCommandLine builds up a string that describes a command line for executing a child process. More...

Protected Member Functions
virtual void	writeDirectives (OUTPUTFORMATTER *aFormatter, unsigned aCtl) const
	Save the Spice directives. More...
void	CreatePinList (SCH_COMPONENT *aSymbol, SCH_SHEET_PATH *aSheetPath)
	Function findNextSymbolAndCreatePinList finds a symbol from the DrawList and builds its pin list in m_sortedSymbolPinList. More...
SCH_COMPONENT *	findNextSymbol (EDA_ITEM *aItem, SCH_SHEET_PATH *aSheetPath)
	Checks if the given symbol should be processed for netlisting. More...
void	eraseDuplicatePins ()
	Function eraseDuplicatePins erase duplicate Pins from m_sortedSymbolPinList (i.e. More...
void	findAllUnitsOfSymbol (SCH_COMPONENT *aSymbol, LIB_PART *aPart, SCH_SHEET_PATH *aSheetPath)
	Function findAllUnitsOfSymbol is used for "multiple parts per package" symbols. 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 parts per package" symbols to avoid processing a lib part more than once. More...
std::set< LIB_PART *, LIB_PART_LESS_THAN >	m_libParts
	unique library parts used. LIB_PART 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_title
	< Spice simulation title found in the processed schematic sheet More...
std::vector< wxString >	m_directives
	Libraries used by the simulated circuit. More...
std::set< wxString >	m_libraries
	Map circuit nodes to net names. More...
NET_INDEX_MAP	m_netMap
	List of items representing schematic components in the Spice world. More...
SPICE_ITEM_LIST	m_spiceItems

Static Private Attributes
static const std::vector< wxString >	m_spiceFields

Detailed Description

Generate a PSPICE compatible netlist.

Definition at line 101 of file netlist_exporter_pspice.h.

Member Typedef Documentation

NET_INDEX_MAP

typedef std::map<wxString, int> NETLIST_EXPORTER_PSPICE::NET_INDEX_MAP

Definition at line 116 of file netlist_exporter_pspice.h.

SPICE_ITEM_LIST

typedef std::list<SPICE_ITEM> NETLIST_EXPORTER_PSPICE::SPICE_ITEM_LIST

Net name to circuit node number mapping.

Definition at line 113 of file netlist_exporter_pspice.h.

Constructor & Destructor Documentation

NETLIST_EXPORTER_PSPICE()

NETLIST_EXPORTER_PSPICE::NETLIST_EXPORTER_PSPICE ( SCHEMATIC_IFACE *  aSchematic )

inline

Definition at line 104 of file netlist_exporter_pspice.h.

                                                           :
            NETLIST_EXPORTER_BASE( aSchematic )
    {
    }

~NETLIST_EXPORTER_PSPICE()

virtual NETLIST_EXPORTER_PSPICE::~NETLIST_EXPORTER_PSPICE ( )

inlinevirtual

Definition at line 109 of file netlist_exporter_pspice.h.

    {
    }

Member Function Documentation

CreatePinList()

void NETLIST_EXPORTER_BASE::CreatePinList ( SCH_COMPONENT *  aSymbol, SCH_SHEET_PATH *  aSheetPath  )

protectedinherited

Function findNextSymbolAndCreatePinList finds a symbol from the DrawList and builds its pin list in m_sortedSymbolPinList.

This list is sorted by pin num. The symbol is the next actual symbol after aSymbol.

Power symbols and virtual symbols that have their reference designators starting with '#' are skipped.

Definition at line 122 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->GetPartRef() )
        return;

    m_sortedSymbolPinList.clear();

    // If symbol is a "multi parts per package" type
    if( aSymbol->GetPartRef()->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->GetPartRef().get(), aSheetPath );
    }

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

                // Skip unconnected pins
                CONNECTION_SUBGRAPH* sg = graph->FindSubgraphByName( netName, *aSheetPath );

                if( !sg || sg->m_no_connect || sg->m_items.size() < 2 )
                    continue;

                m_sortedSymbolPinList.emplace_back( pin->GetNumber(), netName );
            }
        }
    }

    // Sort pins in m_SortedComponentPinList by pin number
    sort( m_sortedSymbolPinList.begin(), m_sortedSymbolPinList.end(), sortPinsByNum );

    // Remove duplicate Pins in m_SortedComponentPinList
    eraseDuplicatePins();

    // record the usage of this library component entry.
    m_libParts.insert( aSymbol->GetPartRef().get() ); // rejects non-unique pointers
}

References SCHEMATIC_IFACE::ConnectionGraph(), NETLIST_EXPORTER_BASE::eraseDuplicatePins(), NETLIST_EXPORTER_BASE::findAllUnitsOfSymbol(), CONNECTION_GRAPH::FindSubgraphByName(), SCH_COMPONENT::GetPartRef(), SCH_COMPONENT::GetPins(), SCH_COMPONENT::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 sortPinsByNum().

Referenced by ProcessNetlist(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

eraseDuplicatePins()

void NETLIST_EXPORTER_BASE::eraseDuplicatePins ( )

protectedinherited

Function eraseDuplicatePins 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 parts per package" symbols. For instance, a 74ls00 has 4 parts, 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 183 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_COMPONENT *  aSymbol, LIB_PART *  aPart, SCH_SHEET_PATH *  aSheetPath  )

protectedinherited

Function findAllUnitsOfSymbol is used for "multiple parts per package" symbols.

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.

Definition at line 216 of file netlist_exporter_base.cpp.

{
    wxString    ref = aSymbol->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_COMPONENT_T ) )
        {
            SCH_COMPONENT* comp2 = static_cast<SCH_COMPONENT*>( 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();

                    // Skip unconnected pins
                    CONNECTION_SUBGRAPH* sg = graph->FindSubgraphByName( netName, sheet );

                    if( !sg || sg->m_no_connect || sg->m_items.size() < 2 )
                        continue;

                    m_sortedSymbolPinList.emplace_back( pin->GetNumber(), netName );
                }
            }
        }
    }
}

References SCHEMATIC_IFACE::ConnectionGraph(), CONNECTION_GRAPH::FindSubgraphByName(), SCH_COMPONENT::GetPins(), SCH_COMPONENT::GetRef(), SCHEMATIC_IFACE::GetSheets(), CONNECTION_SUBGRAPH::m_items, CONNECTION_SUBGRAPH::m_no_connect, NETLIST_EXPORTER_BASE::m_schematic, NETLIST_EXPORTER_BASE::m_sortedSymbolPinList, and SCH_COMPONENT_T.

Referenced by NETLIST_EXPORTER_BASE::CreatePinList().

findNextSymbol()

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

protectedinherited

Checks if the given symbol should be processed for netlisting.

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

{
    wxString    ref;

    if( aItem->Type() != SCH_COMPONENT_T )
        return nullptr;

    // found next component
    SCH_COMPONENT* symbol = (SCH_COMPONENT*) 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;

    // if( symbol->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( !symbol->GetPartRef() )
        return nullptr;

    // If component is a "multi parts per package" type
    if( symbol->GetPartRef()->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 component entry.
    m_libParts.insert( symbol->GetPartRef().get() ); // rejects non-unique pointers

    return symbol;
}

References SCH_COMPONENT::GetPartRef(), SCH_COMPONENT::GetRef(), UNIQUE_STRINGS::Lookup(), NETLIST_EXPORTER_BASE::m_libParts, NETLIST_EXPORTER_BASE::m_referencesAlreadyFound, SCH_COMPONENT_T, and EDA_ITEM::Type().

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

Format()

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

Definition at line 79 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", (const char*) m_title.c_str() );

    // Write .include directives
    for( const auto& lib : m_libraries )
    {
        wxString full_path;

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

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

        aFormatter->Print( 0, ".include \"%s\"\n", (const char*) full_path.c_str() );
    }

    unsigned int NC_counter = 1;

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

        wxString device = GetSpiceDevice( item.m_refName );
        aFormatter->Print( 0, "%s ", (const char*) device.c_str() );

        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 compon
            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", (const char*) item.m_model.c_str() );
    }

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

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

    return true;
}

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

Referenced by WriteNetlist().

GetDirectives()

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

inline

Return a vector of Spice directives found in the schematics.

Definition at line 204 of file netlist_exporter_pspice.h.

    {
        return m_directives;
    }

References m_directives.

Referenced by NETLIST_EXPORTER_PSPICE_SIM::GetSheetSimCommand(), and NETLIST_EXPORTER_PSPICE_SIM::writeDirectives().

GetNetIndexMap()

const NET_INDEX_MAP& NETLIST_EXPORTER_PSPICE::GetNetIndexMap ( ) const

inline

Return a map of circuit nodes to net names.

Definition at line 164 of file netlist_exporter_pspice.h.

    {
        return m_netMap;
    }

References m_netMap.

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

GetSpiceDevice()

wxString NETLIST_EXPORTER_PSPICE::GetSpiceDevice

(

const wxString &

aComponent

)

const

Return name of Spice device corresponding to a schematic component.

Parameters

aComponent

is the component reference.

Returns

Spice device name or empty string if there is no such component 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 43 of file netlist_exporter_pspice.cpp.

{
    const auto& spiceItems = GetSpiceItems();

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

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

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

GetSpiceField()

wxString NETLIST_EXPORTER_PSPICE::GetSpiceField ( SPICE_FIELD  aField, SCH_COMPONENT *  aComponent, unsigned  aCtl  )

static

Retrieve either the requested field value or the default value.

Definition at line 174 of file netlist_exporter_pspice.cpp.

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

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

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

GetSpiceFieldDefVal()

wxString NETLIST_EXPORTER_PSPICE::GetSpiceFieldDefVal ( SPICE_FIELD  aField, SCH_COMPONENT *  aComponent, unsigned  aCtl  )

static

Retrieve the default value for a given field.

Definition at line 182 of file netlist_exporter_pspice.cpp.

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

    case SF_MODEL:
    {
        wxChar prim = aComponent->GetField( REFERENCE_FIELD )->GetShownText().GetChar( 0 );
        wxString value = aComponent->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;
        break;
    }

    case SF_ENABLED:
        return wxString( "Y" );
        break;

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

        wxCHECK( aComponent->GetPartRef(), wxString() );
        aComponent->GetPartRef()->GetPins( pins );

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

        nodeSeq.Trim();

        return nodeSeq;
        break;
    }

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

    default:
        wxASSERT_MSG( false, "Missing default value definition for a Spice field" );
        break;
    }


    return wxString( "<unknown>" );
}

References SCH_COMPONENT::GetField(), SCH_COMPONENT::GetPartRef(), SCH_FIELD::GetShownText(), NET_ADJUST_PASSIVE_VALS, REFERENCE_FIELD, SF_ENABLED, SF_LIB_FILE, SF_MODEL, SF_NODE_SEQUENCE, SF_PRIMITIVE, and VALUE_FIELD.

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

GetSpiceFieldName()

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

inlinestatic

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

Definition at line 180 of file netlist_exporter_pspice.h.

    {
        return m_spiceFields[(int) aField];
    }

References m_spiceFields.

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

GetSpiceFields()

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

inlinestatic

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

Definition at line 172 of file netlist_exporter_pspice.h.

    {
        return m_spiceFields;
    }

References m_spiceFields.

Referenced by DIALOG_SPICE_MODEL::TransferDataToWindow().

GetSpiceItems()

const SPICE_ITEM_LIST& NETLIST_EXPORTER_PSPICE::GetSpiceItems ( ) const

inline

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

Definition at line 121 of file netlist_exporter_pspice.h.

    {
        return m_spiceItems;
    }

References m_spiceItems.

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

MakeCommandLine()

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

staticinherited

Function MakeCommandLine builds 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 38 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().

ProcessNetlist()

bool NETLIST_EXPORTER_PSPICE::ProcessNetlist

(

unsigned

aCtl

)

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 264 of file netlist_exporter_pspice.cpp.

{
    const wxString      delimiters( "{:,; }" );

    SCH_SHEET_LIST      sheetList = m_schematic->GetSheets();
    // Set of reference names, to check for duplications
    std::set<wxString>  refNames;

    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 component attributes to find Spice directives
        for( auto item : sheet.LastScreen()->Items().OfType( SCH_COMPONENT_T ) )
        {
            SCH_COMPONENT* symbol = findNextSymbol( item, &sheet );

            if( !symbol )
                continue;

            CreatePinList( symbol, &sheet );
            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( NULL, wxT( "There are duplicate components. "
                                         "You need to annotate schematics first." ) );
                return false;
            }

            refNames.insert( spiceItem.m_refName );

            // Check to see if component 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_COMPONENT::FindField(), NETLIST_EXPORTER_BASE::findNextSymbol(), SCH_COMPONENT::GetRef(), SCHEMATIC_IFACE::GetSheets(), SCH_FIELD::GetShownText(), GetSpiceField(), GetSpiceFieldName(), SCH_SCREEN::Items(), SCH_SHEET_PATH::LastScreen(), SPICE_ITEM::m_enabled, NETLIST_EXPORTER_BASE::m_libParts, m_libraries, SPICE_ITEM::m_model, 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, m_spiceItems, NULL, EE_RTREE::OfType(), SCH_COMPONENT_T, SF_ENABLED, SF_LIB_FILE, SF_MODEL, SF_NODE_SEQUENCE, SF_PRIMITIVE, StringToBool(), and UpdateDirectives().

Referenced by Format().

ReplaceForbiddenChars()

void NETLIST_EXPORTER_PSPICE::ReplaceForbiddenChars ( wxString &  aNetName )

static

Replace illegal spice net name characters with an underscore.

Parameters

aNetName

is the net name to modify.

Definition at line 67 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 NETLIST_EXPORTER_PSPICE_SIM::ComponentToVector(), and Format().

StringToBool()

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

inlinestatic

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

Definition at line 212 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 ProcessNetlist(), and DIALOG_SPICE_MODEL::TransferDataToWindow().

UpdateDirectives()

void NETLIST_EXPORTER_PSPICE::UpdateDirectives

(

unsigned

aCtl

)

Update the vector of Spice directives placed in the schematics.

Definition at line 369 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( auto 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(), m_directives, m_libraries, NETLIST_EXPORTER_BASE::m_schematic, m_title, and SCH_TEXT_T.

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

writeDirectives()

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

protectedvirtual

Save the Spice directives.

Reimplemented in NETLIST_EXPORTER_PSPICE_SIM.

Definition at line 463 of file netlist_exporter_pspice.cpp.

{
    for( auto& dir : m_directives )
    {
        aFormatter->Print( 0, "%s\n", (const char*) dir.c_str() );
    }
}

References m_directives, and OUTPUTFORMATTER::Print().

Referenced by Format(), and NETLIST_EXPORTER_PSPICE_SIM::writeDirectives().

WriteNetlist()

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

overridevirtual

Write to specified output file.

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

Reimplemented from NETLIST_EXPORTER_BASE.

Definition at line 60 of file netlist_exporter_pspice.cpp.

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

    return Format( &outputFile, aNetlistOptions );
}

References Format().

Member Data Documentation

m_directives

std::vector<wxString> NETLIST_EXPORTER_PSPICE::m_directives

private

Libraries used by the simulated circuit.

Definition at line 234 of file netlist_exporter_pspice.h.

Referenced by GetDirectives(), UpdateDirectives(), and writeDirectives().

m_libParts

std::set<LIB_PART*, LIB_PART_LESS_THAN> NETLIST_EXPORTER_BASE::m_libParts

protectedinherited

unique library parts used. LIB_PART items are sorted by names

Definition at line 108 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 ProcessNetlist().

m_libraries

std::set<wxString> NETLIST_EXPORTER_PSPICE::m_libraries

private

Map circuit nodes to net names.

Definition at line 237 of file netlist_exporter_pspice.h.

Referenced by Format(), ProcessNetlist(), and UpdateDirectives().

m_netMap

NET_INDEX_MAP NETLIST_EXPORTER_PSPICE::m_netMap

private

List of items representing schematic components in the Spice world.

Definition at line 240 of file netlist_exporter_pspice.h.

Referenced by Format(), GetNetIndexMap(), and ProcessNetlist().

m_referencesAlreadyFound

UNIQUE_STRINGS NETLIST_EXPORTER_BASE::m_referencesAlreadyFound

protectedinherited

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

Definition at line 105 of file netlist_exporter_base.h.

Referenced by NETLIST_EXPORTER_BASE::findNextSymbol(), NETLIST_EXPORTER_XML::makeSymbols(), 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 114 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 111 of file netlist_exporter_base.h.

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

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

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

m_spiceFields

const std::vector< wxString > NETLIST_EXPORTER_PSPICE::m_spiceFields

staticprivate

Initial value:

= {
    "Spice_Primitive",
    "Spice_Model",
    "Spice_Netlist_Enabled",
    "Spice_Node_Sequence",
    "Spice_Lib_File"
}

Definition at line 246 of file netlist_exporter_pspice.h.

Referenced by GetSpiceFieldName(), and GetSpiceFields().

m_spiceItems

SPICE_ITEM_LIST NETLIST_EXPORTER_PSPICE::m_spiceItems

private

Definition at line 243 of file netlist_exporter_pspice.h.

Referenced by Format(), GetSpiceItems(), and ProcessNetlist().

m_title

wxString NETLIST_EXPORTER_PSPICE::m_title

private

< Spice simulation title found in the processed schematic sheet

Spice directives found in the processed schematic sheet

Definition at line 231 of file netlist_exporter_pspice.h.

Referenced by Format(), and UpdateDirectives().

---

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

• netlist_exporter_pspice.h
• netlist_exporter_pspice.cpp