SPICE_GENERATOR Class Reference

#include <spice_generator.h>

Inheritance diagram for SPICE_GENERATOR:

Public Member Functions
	SPICE_GENERATOR (const SIM_MODEL &aModel)
virtual	~SPICE_GENERATOR ()=default
virtual std::string	ModelName (const SPICE_ITEM &aItem) const
virtual std::string	ModelLine (const SPICE_ITEM &aItem) const
virtual std::string	ItemLine (const SPICE_ITEM &aItem) const
virtual std::string	ItemName (const SPICE_ITEM &aItem) const
virtual std::string	ItemPins (const SPICE_ITEM &aItem) const
virtual std::string	ItemModelName (const SPICE_ITEM &aItem) const
virtual std::string	ItemParams () const
virtual std::string	TunerCommand (const SPICE_ITEM &aItem, double aValue) const
virtual std::vector< std::string >	CurrentNames (const SPICE_ITEM &aItem) const
virtual std::string	Preview (const SPICE_ITEM &aItem) const

Protected Member Functions
virtual std::vector< std::reference_wrapper< const SIM_MODEL::PIN > >	GetPins () const
virtual std::vector< std::reference_wrapper< const SIM_MODEL::PARAM > >	GetInstanceParams () const

Protected Attributes
const SIM_MODEL &	m_model

Detailed Description

Definition at line 45 of file spice_generator.h.

Constructor & Destructor Documentation

SPICE_GENERATOR()

SPICE_GENERATOR::SPICE_GENERATOR ( const SIM_MODEL &  aModel )

inline

Definition at line 49 of file spice_generator.h.

: m_model( aModel ) {}

~SPICE_GENERATOR()

virtual SPICE_GENERATOR::~SPICE_GENERATOR ( )

virtualdefault

Member Function Documentation

CurrentNames()

std::vector< std::string > SPICE_GENERATOR::CurrentNames ( const SPICE_ITEM &  aItem ) const

virtual

Reimplemented in SPICE_GENERATOR_KIBIS, SPICE_GENERATOR_NGSPICE, and SPICE_GENERATOR_SUBCKT.

Definition at line 193 of file spice_generator.cpp.

{
 return { fmt::format( "I({})", ItemName( aItem ) ) };
}

References ItemName().

Referenced by SPICE_GENERATOR_NGSPICE::CurrentNames().

GetInstanceParams()

std::vector< std::reference_wrapper< const SIM_MODEL::PARAM > > SPICE_GENERATOR::GetInstanceParams ( ) const

protectedvirtual

Reimplemented in SPICE_GENERATOR_KIBIS.

Definition at line 213 of file spice_generator.cpp.

{
 std::vector<std::reference_wrapper<const SIM_MODEL::PARAM>> instanceParams;
 
 for( const SIM_MODEL::PARAM& param : m_model.GetParams() )
 {
 if( param.info.isSpiceInstanceParam )
 instanceParams.emplace_back( param );
 }
 
 return instanceParams;
}

References SIM_MODEL::GetParams(), and m_model.

Referenced by ItemParams(), SPICE_GENERATOR_L_MUTUAL::ItemParams(), SPICE_GENERATOR_RAW_SPICE::ItemParams(), and SPICE_GENERATOR_SWITCH::ItemParams().

GetPins()

virtual std::vector< std::reference_wrapper< const SIM_MODEL::PIN > > SPICE_GENERATOR::GetPins ( ) const

inlineprotectedvirtual

Reimplemented in SPICE_GENERATOR_SWITCH.

Definition at line 68 of file spice_generator.h.

 {
 return m_model.GetPins();
 }

References SIM_MODEL::GetPins(), and m_model.

Referenced by SPICE_GENERATOR_KIBIS::CurrentNames(), SPICE_GENERATOR_SUBCKT::CurrentNames(), ItemLine(), ItemPins(), and SPICE_GENERATOR_RAW_SPICE::ItemPins().

ItemLine()

std::string SPICE_GENERATOR::ItemLine ( const SPICE_ITEM &  aItem ) const

virtual

Reimplemented in SPICE_GENERATOR_BEHAVIORAL, SPICE_GENERATOR_IDEAL, SPICE_GENERATOR_SOURCE, and SPICE_GENERATOR_SWITCH.

Definition at line 102 of file spice_generator.cpp.

{
 SPICE_ITEM item = aItem;
 
 if( item.pinNumbers.empty() )
 {
 for( int i = 0; i < m_model.GetPinCount(); ++i )
 item.pinNumbers.push_back( fmt::format( "{}", i + 1 ) );
 }
 
 if( item.pinNetNames.empty() )
 {
 for( const SIM_MODEL::PIN& pin : GetPins() )
 item.pinNetNames.push_back( pin.name );
 }
 
 std::string result;
 result.append( ItemName( aItem ) );
 result.append( ItemPins( aItem ) );
 result.append( ItemModelName( aItem ) );
 result.append( ItemParams() );
 result.append( "\n" );
 return result;
}

References SIM_MODEL::GetPinCount(), GetPins(), ItemModelName(), ItemName(), ItemParams(), ItemPins(), m_model, pin, SPICE_ITEM::pinNetNames, and SPICE_ITEM::pinNumbers.

Referenced by SPICE_GENERATOR_BEHAVIORAL::ItemLine(), SPICE_GENERATOR_IDEAL::ItemLine(), SPICE_GENERATOR_SOURCE::ItemLine(), SPICE_GENERATOR_SWITCH::ItemLine(), Preview(), SPICE_GENERATOR_RAW_SPICE::Preview(), and SPICE_GENERATOR_SPICE::Preview().

ItemModelName()

std::string SPICE_GENERATOR::ItemModelName ( const SPICE_ITEM &  aItem ) const

virtual

Reimplemented in SPICE_GENERATOR_RAW_SPICE.

Definition at line 162 of file spice_generator.cpp.

{
 return fmt::format( " {}", aItem.modelName );
}

References SPICE_ITEM::modelName.

Referenced by ItemLine().

ItemName()

std::string SPICE_GENERATOR::ItemName ( const SPICE_ITEM &  aItem ) const

virtual

Reimplemented in SPICE_GENERATOR_RAW_SPICE.

Definition at line 128 of file spice_generator.cpp.

{
 if( aItem.refName != "" && boost::starts_with( aItem.refName, m_model.GetSpiceInfo().itemType ) )
 return aItem.refName;
 else
 return fmt::format( "{}{}", m_model.GetSpiceInfo().itemType, aItem.refName );
}

References SIM_MODEL::GetSpiceInfo(), SIM_MODEL::SPICE_INFO::itemType, m_model, and SPICE_ITEM::refName.

Referenced by CurrentNames(), SPICE_GENERATOR_KIBIS::CurrentNames(), SPICE_GENERATOR_NGSPICE::CurrentNames(), SPICE_GENERATOR_SUBCKT::CurrentNames(), NETLIST_EXPORTER_SPICE::GetItemName(), ItemLine(), SCH_EDIT_FRAME::RefreshOperatingPointDisplay(), SPICE_GENERATOR_IDEAL::TunerCommand(), and SPICE_GENERATOR_R_POT::TunerCommand().

ItemParams()

std::string SPICE_GENERATOR::ItemParams ( ) const

virtual

Reimplemented in SPICE_GENERATOR_L_MUTUAL, SPICE_GENERATOR_RAW_SPICE, and SPICE_GENERATOR_SWITCH.

Definition at line 168 of file spice_generator.cpp.

{
 std::string result;
 
 for( const SIM_MODEL::PARAM& param : GetInstanceParams() )
 {
 std::string name = param.info.spiceInstanceName.empty() ? param.info.name
 : param.info.spiceInstanceName;
 std::string value = SIM_VALUE::ToSpice( param.value );
 
 if( value != "" )
 result.append( fmt::format( " {}={}", name, value ) );
 }
 
 return result;
}

References GetInstanceParams(), name, and SIM_VALUE::ToSpice().

Referenced by ItemLine().

ItemPins()

std::string SPICE_GENERATOR::ItemPins ( const SPICE_ITEM &  aItem ) const

virtual

Reimplemented in SPICE_GENERATOR_RAW_SPICE.

Definition at line 137 of file spice_generator.cpp.

{
 std::string result;
 int ncCounter = 0;
 
 for( const SIM_MODEL::PIN& pin : GetPins() )
 {
 auto it = std::find( aItem.pinNumbers.begin(), aItem.pinNumbers.end(),
 pin.symbolPinNumber );
 
 if( it == aItem.pinNumbers.end() )
 {
 result.append( fmt::format( " NC-{}-{}", aItem.refName, ncCounter++ ) );
 }
 else
 {
 long symbolPinIndex = std::distance( aItem.pinNumbers.begin(), it );
 result.append( fmt::format( " {}", aItem.pinNetNames.at( symbolPinIndex ) ) );
 }
 }
 
 return result;
}

References distance(), GetPins(), pin, SPICE_ITEM::pinNetNames, SPICE_ITEM::pinNumbers, and SPICE_ITEM::refName.

Referenced by ItemLine().

ModelLine()

std::string SPICE_GENERATOR::ModelLine ( const SPICE_ITEM &  aItem ) const

virtual

Reimplemented in SPICE_GENERATOR_BEHAVIORAL, SPICE_GENERATOR_IDEAL, SPICE_GENERATOR_KIBIS, SPICE_GENERATOR_R_POT, SPICE_GENERATOR_RAW_SPICE, SPICE_GENERATOR_SOURCE, SPICE_GENERATOR_SUBCKT, and SPICE_GENERATOR_TLINE.

Definition at line 44 of file spice_generator.cpp.

{
 if( !m_model.requiresSpiceModelLine( aItem ) )
 return "";
 
 std::string result;
 
 result.append( fmt::format( ".model {} ", aItem.modelName ) );
 size_t indentLength = result.length();
 
 const SIM_MODEL::SPICE_INFO& spiceInfo = m_model.GetSpiceInfo();
 result.append( spiceInfo.modelType );
 
 if ( !spiceInfo.isDefaultLevel && !spiceInfo.level.empty() )
 result.append( fmt::format( " level={}", spiceInfo.level ) );
 
 if ( !spiceInfo.version.empty() )
 result.append( fmt::format( " version={}", spiceInfo.version ) );
 
 result.append( "\n" );
 
 for( const SIM_MODEL::PARAM& param : m_model.GetParams() )
 {
 if( param.info.isSpiceInstanceParam )
 continue;
 
 std::string name;
 std::string value;
 
 if( !param.info.spiceModelName.empty() )
 {
 name = param.info.spiceModelName;
 }
 else
 {
 // Because of collisions with instance parameters, we append some model parameters
 // with "_".
 if( boost::ends_with( param.info.name, "_" ) )
 name = param.info.name.substr( 0, param.info.name.length() - 1 );
 else
 name = param.info.name;
 }
 
 value = SIM_VALUE::ToSpice( param.value );
 
 if( value == "" )
 continue;
 
 result.append( fmt::format( "+{}{}={}\n",
 std::string( indentLength - 1, ' ' ),
 name,
 value ) );
 }
 
 return result;
}

References SIM_MODEL::GetParams(), SIM_MODEL::GetSpiceInfo(), SIM_MODEL::SPICE_INFO::isDefaultLevel, SIM_MODEL::SPICE_INFO::level, m_model, SPICE_ITEM::modelName, SIM_MODEL::SPICE_INFO::modelType, name, SIM_MODEL::requiresSpiceModelLine(), SIM_VALUE::ToSpice(), and SIM_MODEL::SPICE_INFO::version.

Referenced by Preview(), and SPICE_GENERATOR_SPICE::Preview().

ModelName()

std::string SPICE_GENERATOR::ModelName ( const SPICE_ITEM &  aItem ) const

virtual

Reimplemented in SPICE_GENERATOR_KIBIS.

Definition at line 32 of file spice_generator.cpp.

{
 if( aItem.baseModelName == "" )
 return fmt::format( "__{}", aItem.refName );
 
 if( m_model.requiresSpiceModelLine( aItem ) )
 return fmt::format( "{}.{}", aItem.refName, aItem.baseModelName );
 
 return aItem.baseModelName;
}

References SPICE_ITEM::baseModelName, m_model, SPICE_ITEM::refName, and SIM_MODEL::requiresSpiceModelLine().

Referenced by NETLIST_EXPORTER_SPICE::readModel().

Preview()

std::string SPICE_GENERATOR::Preview ( const SPICE_ITEM &  aItem ) const

virtual

Reimplemented in SPICE_GENERATOR_RAW_SPICE, and SPICE_GENERATOR_SPICE.

Definition at line 199 of file spice_generator.cpp.

{
 std::string spiceCode = ModelLine( aItem );
 
 std::string itemLine = ItemLine( aItem );
 
 if( spiceCode != "" )
 spiceCode.append( "\n" );
 
 spiceCode.append( itemLine );
 return boost::trim_copy( spiceCode );
}

References ItemLine(), and ModelLine().

Referenced by DIALOG_SIM_MODEL< T_symbol, T_field >::updateModelCodeTab().

TunerCommand()

std::string SPICE_GENERATOR::TunerCommand ( const SPICE_ITEM &  aItem, double  aValue  ) const

virtual

Reimplemented in SPICE_GENERATOR_IDEAL, and SPICE_GENERATOR_R_POT.

Definition at line 186 of file spice_generator.cpp.

{
 // No tuning available by default.
 return "";
}

Referenced by SIMULATOR_FRAME::applyTuners().

Member Data Documentation

m_model

const SIM_MODEL& SPICE_GENERATOR::m_model

protected

Definition at line 75 of file spice_generator.h.

Referenced by SPICE_GENERATOR_NGSPICE::CurrentNames(), GetInstanceParams(), SPICE_GENERATOR_SOURCE::getParamValueString(), GetPins(), SPICE_GENERATOR_SWITCH::GetPins(), SPICE_GENERATOR_KIBIS::IbisDevice(), ItemLine(), SPICE_GENERATOR_BEHAVIORAL::ItemLine(), SPICE_GENERATOR_IDEAL::ItemLine(), SPICE_GENERATOR_SOURCE::ItemLine(), SPICE_GENERATOR_SWITCH::ItemLine(), ItemName(), SPICE_GENERATOR_RAW_SPICE::ItemName(), ModelLine(), SPICE_GENERATOR_R_POT::ModelLine(), SPICE_GENERATOR_TLINE::ModelLine(), ModelName(), SPICE_GENERATOR_RAW_SPICE::Preview(), and SPICE_GENERATOR_SPICE::Preview().

---

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

• spice_generator.h
• spice_generator.cpp