KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Friends | List of all members
SIM_MODEL_NGSPICE Class Reference

#include <sim_model_ngspice.h>

Inheritance diagram for SIM_MODEL_NGSPICE:
SIM_MODEL_SPICE SIM_MODEL TEST_SIM_MODEL_NGSPICE_FIXTURE

Public Member Functions

 SIM_MODEL_NGSPICE (TYPE aType)
 
void SetParamFromSpiceCode (const std::string &aParamName, const std::string &aValue, SIM_VALUE_GRAMMAR::NOTATION aNotation) override
 
std::vector< std::string > GetPinNames () const override
 
 DEFINE_ENUM_CLASS_WITH_ITERATOR (DEVICE_T, NONE, R, C, L, K, TLINE, SW, D, NPN, PNP, NJFET, PJFET, NMES, PMES, NMOS, PMOS, V, I, E, F, G, H, SUBCKT, XSPICE, KIBIS, SPICE) struct DEVICE_INFO
 
 DEFINE_ENUM_CLASS_WITH_ITERATOR (TYPE, NONE, R, R_POT, R_BEHAVIORAL, C, C_BEHAVIORAL, L, L_BEHAVIORAL, K, TLINE_Z0, TLINE_RLGC, SW_V, SW_I, D, NPN_VBIC, PNP_VBIC, NPN_GUMMELPOON, PNP_GUMMELPOON, NPN_HICUM2, PNP_HICUM2, NJFET_SHICHMANHODGES, PJFET_SHICHMANHODGES, NJFET_PARKERSKELLERN, PJFET_PARKERSKELLERN, NMES_STATZ, PMES_STATZ, NMES_YTTERDAL, PMES_YTTERDAL, NMES_HFET1, PMES_HFET1, NMES_HFET2, PMES_HFET2, NMOS_VDMOS, PMOS_VDMOS, NMOS_MOS1, PMOS_MOS1, NMOS_MOS2, PMOS_MOS2, NMOS_MOS3, PMOS_MOS3, NMOS_BSIM1, PMOS_BSIM1, NMOS_BSIM2, PMOS_BSIM2, NMOS_MOS6, PMOS_MOS6, NMOS_MOS9, PMOS_MOS9, NMOS_BSIM3, PMOS_BSIM3, NMOS_B4SOI, PMOS_B4SOI, NMOS_BSIM4, PMOS_BSIM4, NMOS_B3SOIFD, PMOS_B3SOIFD, NMOS_B3SOIDD, PMOS_B3SOIDD, NMOS_B3SOIPD, PMOS_B3SOIPD, NMOS_HISIM2, PMOS_HISIM2, NMOS_HISIMHV1, PMOS_HISIMHV1, NMOS_HISIMHV2, PMOS_HISIMHV2, V, V_SIN, V_PULSE, V_EXP, V_AM, V_SFFM, V_VCL, V_CCL, V_PWL, V_WHITENOISE, V_PINKNOISE, V_BURSTNOISE, V_RANDUNIFORM, V_RANDGAUSSIAN, V_RANDEXP, V_RANDPOISSON, V_BEHAVIORAL, I, I_SIN, I_PULSE, I_EXP, I_AM, I_SFFM, I_VCL, I_CCL, I_PWL, I_WHITENOISE, I_PINKNOISE, I_BURSTNOISE, I_RANDUNIFORM, I_RANDGAUSSIAN, I_RANDEXP, I_RANDPOISSON, I_BEHAVIORAL, SUBCKT, XSPICE, KIBIS_DEVICE, KIBIS_DRIVER_DC, KIBIS_DRIVER_RECT, KIBIS_DRIVER_PRBS, RAWSPICE) struct INFO
 
const SPICE_GENERATOR & SpiceGenerator () const
 
const SIM_MODEL_SERIALIZER & Serializer () const
 
void ReadDataFields (const std::vector< SCH_FIELD > *aFields, bool aResolve, int aDepth, const std::vector< SCH_PIN * > &aPins)
 
void WriteFields (std::vector< SCH_FIELD > &aFields) const
 
SPICE_INFO GetSpiceInfo () const
 
void AddPin (const SIM_MODEL_PIN &aPin)
 
void ClearPins ()
 
int FindModelPinIndex (const std::string &aSymbolPinNumber)
 
void AddParam (const PARAM::INFO &aInfo)
 
DEVICE_INFO GetDeviceInfo () const
 
INFO GetTypeInfo () const
 
DEVICE_T GetDeviceType () const
 
TYPE GetType () const
 
const SIM_MODEL * GetBaseModel () const
 
virtual void SetBaseModel (const SIM_MODEL &aBaseModel)
 
int GetPinCount () const
 
const SIM_MODEL_PIN & GetPin (unsigned aIndex) const
 
std::vector< std::reference_wrapper< const SIM_MODEL_PIN > > GetPins () const
 
void AssignSymbolPinNumberToModelPin (int aPinIndex, const wxString &aSymbolPinNumber)
 
virtual void AssignSymbolPinNumberToModelPin (const std::string &aPinName, const wxString &aSymbolPinNumber)
 
int GetParamCount () const
 
virtual const PARAM & GetParam (unsigned aParamIndex) const
 
virtual const PARAM * GetTunerParam () const
 
const PARAM * FindParam (const std::string &aParamName) const
 
const PARAM & GetParamOverride (unsigned aParamIndex) const
 
const PARAM & GetBaseParam (unsigned aParamIndex) const
 
void SetParamValue (int aParamIndex, const std::string &aValue, SIM_VALUE::NOTATION aNotation=SIM_VALUE::NOTATION::SI)
 
void SetParamValue (const std::string &aParamName, const std::string &aValue, SIM_VALUE::NOTATION aNotation=SIM_VALUE::NOTATION::SI)
 
virtual bool HasAutofill () const
 
virtual bool HasPrimaryValue () const
 
void SetIsEnabled (bool aIsEnabled)
 
bool IsEnabled () const
 
void SetIsStoredInValue (bool aIsStoredInValue)
 
bool IsStoredInValue () const
 
virtual void SwitchSingleEndedDiff (bool aDiff)
 

Static Public Member Functions

static std::unique_ptr< SIM_MODEL_SPICE > Create (const SIM_LIBRARY_SPICE &aLibrary, const std::string &aSpiceCode, bool aFirstPass, REPORTER &aReporter)
 
static std::unique_ptr< SIM_MODEL > Create (TYPE aType, const std::vector< SCH_PIN * > &aPins, REPORTER &aReporter)
 
static std::unique_ptr< SIM_MODEL > Create (const SIM_MODEL *aBaseModel, const std::vector< SCH_PIN * > &aPins, REPORTER &aReporter)
 
static std::unique_ptr< SIM_MODEL > Create (const SIM_MODEL *aBaseModel, const std::vector< SCH_PIN * > &aPins, const std::vector< SCH_FIELD > &aFields, bool aResolve, int aDepth, REPORTER &aReporter)
 
static std::unique_ptr< SIM_MODEL > Create (const std::vector< SCH_FIELD > &aFields, bool aResolve, int aDepth, const std::vector< SCH_PIN * > &aPins, REPORTER &aReporter)
 
static DEVICE_INFO DeviceInfo (DEVICE_T aDeviceType)
 
static INFO TypeInfo (TYPE aType)
 
static SPICE_INFO SpiceInfo (TYPE aType)
 
static TYPE ReadTypeFromFields (const std::vector< SCH_FIELD > &aFields, bool aResolve, int aDepth, REPORTER &aReporter)
 
template<class T>
static bool InferSimModel (T &aSymbol, std::vector< SCH_FIELD > *aFields, bool aResolve, int aDepth, SIM_VALUE_GRAMMAR::NOTATION aNotation, wxString *aDeviceType, wxString *aModelType, wxString *aModelParams, wxString *aPinMap)
 
template<class T>
static void MigrateSimModel (T &aSymbol, const PROJECT *aProject)
 

Protected Member Functions

 DEFINE_ENUM_CLASS_WITH_ITERATOR (MODEL_TYPE, NONE, DIODE, BJT, VBIC, HICUM2, JFET, JFET2, MES, MESA, HFET1, HFET2, VDMOS, MOS1, MOS2, MOS3, BSIM1, BSIM2, MOS6, BSIM3, MOS9, B4SOI, BSIM4, B3SOIFD, B3SOIDD, B3SOIPD, HISIM2, HISIMHV1, HISIMHV2) struct MODEL_INFO
 
int doFindParam (const std::string &aParamName) const override
 
void createPins (const std::vector< SCH_PIN * > &aSymbolPins)
 
virtual void doSetParamValue (int aParamIndex, const std::string &aValue)
 

Static Protected Member Functions

static const MODEL_INFO & ModelInfo (MODEL_TYPE aType)
 
static std::unique_ptr< SIM_MODEL > Create (TYPE aType)
 

Protected Attributes

std::string m_spiceCode
 
std::vector< PARAM > m_params
 
std::vector< SIM_MODEL_PIN > m_modelPins
 
const SIM_MODEL * m_baseModel
 
std::unique_ptr< SIM_MODEL_SERIALIZER > m_serializer
 

Private Member Functions

bool canSilentlyIgnoreParam (const std::string &aParamName)
 
MODEL_TYPE getModelType () const
 
virtual bool requiresSpiceModelLine (const SPICE_ITEM &aItem) const
 

Private Attributes

std::unique_ptr< SPICE_MODEL_PARSER > m_spiceModelParser
 
std::unique_ptr< SPICE_GENERATOR > m_spiceGenerator
 
const TYPE m_type
 
bool m_isEnabled
 
bool m_isStoredInValue
 

Friends

struct NGSPICE_MODEL_INFO_MAP
 

Detailed Description

Definition at line 41 of file sim_model_ngspice.h.

Constructor & Destructor Documentation

◆ SIM_MODEL_NGSPICE()

SIM_MODEL_NGSPICE::SIM_MODEL_NGSPICE ( TYPE aType)

Definition at line 64 of file sim_model_ngspice.cpp.

References SIM_MODEL::AddParam(), SIM_MODEL::PARAM::INFO::category, getModelType(), ModelInfo(), and SIM_MODEL_SPICE::SIM_MODEL_SPICE().

Referenced by TEST_SIM_MODEL_NGSPICE_FIXTURE::TEST_SIM_MODEL_NGSPICE_FIXTURE().

Member Function Documentation

◆ AddParam()

void SIM_MODEL::AddParam ( const PARAM::INFO & aInfo)
inherited

Definition at line 667 of file sim_model.cpp.

References SIM_MODEL::PARAM::INFO::defaultValue, SIM_MODEL::PARAM::INFO::enumValues, and m_params.

Referenced by SPICE_MODEL_PARSER_SUBCKT::ReadModel(), SIM_MODEL_SUBCKT::SetBaseModel(), SIM_MODEL_BEHAVIORAL::SIM_MODEL_BEHAVIORAL(), SIM_MODEL_IBIS::SIM_MODEL_IBIS(), SIM_MODEL_IDEAL::SIM_MODEL_IDEAL(), SIM_MODEL_L_MUTUAL::SIM_MODEL_L_MUTUAL(), SIM_MODEL_NGSPICE::SIM_MODEL_NGSPICE(), SIM_MODEL_R_POT::SIM_MODEL_R_POT(), SIM_MODEL_SOURCE::SIM_MODEL_SOURCE(), SIM_MODEL_SPICE_FALLBACK::SIM_MODEL_SPICE_FALLBACK(), SIM_MODEL_SWITCH::SIM_MODEL_SWITCH(), and SIM_MODEL_TLINE::SIM_MODEL_TLINE().

◆ AddPin()

void SIM_MODEL::AddPin ( const SIM_MODEL_PIN & aPin)
inherited

Definition at line 643 of file sim_model.cpp.

References m_modelPins.

Referenced by createPins(), SPICE_MODEL_PARSER_SUBCKT::ReadModel(), SIM_MODEL_SUBCKT::SetBaseModel(), and SIM_MODEL_IBIS::SwitchSingleEndedDiff().

◆ AssignSymbolPinNumberToModelPin() [1/2]

void SIM_MODEL::AssignSymbolPinNumberToModelPin ( const std::string & aPinName,
const wxString & aSymbolPinNumber )
virtualinherited

Reimplemented in SIM_MODEL_RAW_SPICE, and SIM_MODEL_SPICE_FALLBACK.

Definition at line 704 of file sim_model.cpp.

References _, m_modelPins, pin, and THROW_IO_ERROR.

◆ AssignSymbolPinNumberToModelPin() [2/2]

void SIM_MODEL::AssignSymbolPinNumberToModelPin ( int aPinIndex,
const wxString & aSymbolPinNumber )
inherited

Definition at line 696 of file sim_model.cpp.

References m_modelPins.

Referenced by SIM_MODEL_SPICE_FALLBACK::AssignSymbolPinNumberToModelPin(), DIALOG_SIM_MODEL< T >::removeOrphanedPinAssignments(), and DIALOG_SIM_MODEL< T >::TransferDataFromWindow().

◆ canSilentlyIgnoreParam()

bool SIM_MODEL_NGSPICE::canSilentlyIgnoreParam ( const std::string & aParamName)
private

Definition at line 189 of file sim_model_ngspice.cpp.

References SIM_MODEL::GetDeviceType(), and SIM_MODEL::GetType().

Referenced by SetParamFromSpiceCode().

◆ ClearPins()

void SIM_MODEL::ClearPins ( )
inherited

Definition at line 649 of file sim_model.cpp.

References m_modelPins.

Referenced by SIM_MODEL_IBIS::SwitchSingleEndedDiff().

◆ Create() [1/6]

std::unique_ptr< SIM_MODEL > SIM_MODEL::Create ( const SIM_MODEL * aBaseModel,
const std::vector< SCH_PIN * > & aPins,
const std::vector< SCH_FIELD > & aFields,
bool aResolve,
int aDepth,
REPORTER & aReporter )
staticinherited

Definition at line 540 of file sim_model.cpp.

References _, Create(), GetFieldValue(), GetType(), IO_ERROR::Problem(), ReadTypeFromFields(), REFERENCE, REPORTER::Report(), RPT_SEVERITY_ERROR, and SIM_MODEL().

◆ Create() [2/6]

std::unique_ptr< SIM_MODEL > SIM_MODEL::Create ( const SIM_MODEL * aBaseModel,
const std::vector< SCH_PIN * > & aPins,
REPORTER & aReporter )
staticinherited

Definition at line 502 of file sim_model.cpp.

References Create(), GetType(), and SIM_MODEL().

◆ Create() [3/6]

std::unique_ptr< SIM_MODEL > SIM_MODEL::Create ( const std::vector< SCH_FIELD > & aFields,
bool aResolve,
int aDepth,
const std::vector< SCH_PIN * > & aPins,
REPORTER & aReporter )
staticinherited

Definition at line 592 of file sim_model.cpp.

References _, Create(), GetFieldValue(), IO_ERROR::Problem(), ReadTypeFromFields(), REFERENCE, REPORTER::Report(), RPT_SEVERITY_ERROR, SIM_PARAMS_FIELD, SIM_PINS_FIELD, SIM_VALUE_FIELD, and IO_ERROR::What().

◆ Create() [4/6]

std::unique_ptr< SIM_MODEL > SIM_MODEL::Create ( TYPE aType)
staticprotectedinherited

Definition at line 830 of file sim_model.cpp.

◆ Create() [5/6]

std::unique_ptr< SIM_MODEL > SIM_MODEL::Create ( TYPE aType,
const std::vector< SCH_PIN * > & aPins,
REPORTER & aReporter )
staticinherited

Definition at line 482 of file sim_model.cpp.

References Create().

Referenced by Create(), Create(), Create(), Create(), SIM_MODEL_SPICE::Create(), SIM_LIB_MGR::CreateModel(), SIM_LIB_MGR::CreateModel(), SIM_LIB_MGR::CreateModel(), SIM_LIB_MGR::CreateModel(), SIM_LIB_MGR::CreateModel(), SIM_MODEL_SPICE_FALLBACK::GetPinNames(), MigrateSimModel(), SIM_LIBRARY_IBIS::ReadFile(), and SIM_MODEL_SPICE_FALLBACK::SIM_MODEL_SPICE_FALLBACK().

◆ Create() [6/6]

std::unique_ptr< SIM_MODEL_SPICE > SIM_MODEL_SPICE::Create ( const SIM_LIBRARY_SPICE & aLibrary,
const std::string & aSpiceCode,
bool aFirstPass,
REPORTER & aReporter )
staticinherited

Definition at line 57 of file sim_model_spice.cpp.

References SIM_MODEL::Create(), SPICE_MODEL_PARSER::ReadType(), and SIM_MODEL_SPICE().

Referenced by SPICE_LIBRARY_PARSER::ReadFile().

◆ createPins()

void SIM_MODEL::createPins ( const std::vector< SCH_PIN * > & aSymbolPins)
protectedinherited

Definition at line 941 of file sim_model.cpp.

References AddPin(), and GetPinNames().

Referenced by ReadDataFields().

◆ DEFINE_ENUM_CLASS_WITH_ITERATOR() [1/3]

SIM_MODEL::DEFINE_ENUM_CLASS_WITH_ITERATOR ( DEVICE_T ,
NONE ,
R ,
C ,
L ,
K ,
TLINE ,
SW ,
D ,
NPN ,
PNP ,
NJFET ,
PJFET ,
NMES ,
PMES ,
NMOS ,
PMOS ,
V ,
I ,
E ,
F ,
G ,
H ,
SUBCKT ,
XSPICE ,
KIBIS ,
SPICE  )
inlineinherited

Definition at line 86 of file sim_model.h.

References D, F, G, H, I, and NONE.

◆ DEFINE_ENUM_CLASS_WITH_ITERATOR() [2/3]

SIM_MODEL::DEFINE_ENUM_CLASS_WITH_ITERATOR ( TYPE ,
NONE ,
R ,
R_POT ,
R_BEHAVIORAL ,
C ,
C_BEHAVIORAL ,
L ,
L_BEHAVIORAL ,
K ,
TLINE_Z0 ,
TLINE_RLGC ,
SW_V ,
SW_I ,
D ,
NPN_VBIC ,
PNP_VBIC ,
NPN_GUMMELPOON ,
PNP_GUMMELPOON ,
NPN_HICUM2 ,
PNP_HICUM2 ,
NJFET_SHICHMANHODGES ,
PJFET_SHICHMANHODGES ,
NJFET_PARKERSKELLERN ,
PJFET_PARKERSKELLERN ,
NMES_STATZ ,
PMES_STATZ ,
NMES_YTTERDAL ,
PMES_YTTERDAL ,
NMES_HFET1 ,
PMES_HFET1 ,
NMES_HFET2 ,
PMES_HFET2 ,
NMOS_VDMOS ,
PMOS_VDMOS ,
NMOS_MOS1 ,
PMOS_MOS1 ,
NMOS_MOS2 ,
PMOS_MOS2 ,
NMOS_MOS3 ,
PMOS_MOS3 ,
NMOS_BSIM1 ,
PMOS_BSIM1 ,
NMOS_BSIM2 ,
PMOS_BSIM2 ,
NMOS_MOS6 ,
PMOS_MOS6 ,
NMOS_MOS9 ,
PMOS_MOS9 ,
NMOS_BSIM3 ,
PMOS_BSIM3 ,
NMOS_B4SOI ,
PMOS_B4SOI ,
NMOS_BSIM4 ,
PMOS_BSIM4 ,
NMOS_B3SOIFD ,
PMOS_B3SOIFD ,
NMOS_B3SOIDD ,
PMOS_B3SOIDD ,
NMOS_B3SOIPD ,
PMOS_B3SOIPD ,
NMOS_HISIM2 ,
PMOS_HISIM2 ,
NMOS_HISIMHV1 ,
PMOS_HISIMHV1 ,
NMOS_HISIMHV2 ,
PMOS_HISIMHV2 ,
V ,
V_SIN ,
V_PULSE ,
V_EXP ,
V_AM ,
V_SFFM ,
V_VCL ,
V_CCL ,
V_PWL ,
V_WHITENOISE ,
V_PINKNOISE ,
V_BURSTNOISE ,
V_RANDUNIFORM ,
V_RANDGAUSSIAN ,
V_RANDEXP ,
V_RANDPOISSON ,
V_BEHAVIORAL ,
I ,
I_SIN ,
I_PULSE ,
I_EXP ,
I_AM ,
I_SFFM ,
I_VCL ,
I_CCL ,
I_PWL ,
I_WHITENOISE ,
I_PINKNOISE ,
I_BURSTNOISE ,
I_RANDUNIFORM ,
I_RANDGAUSSIAN ,
I_RANDEXP ,
I_RANDPOISSON ,
I_BEHAVIORAL ,
SUBCKT ,
XSPICE ,
KIBIS_DEVICE ,
KIBIS_DRIVER_DC ,
KIBIS_DRIVER_RECT ,
KIBIS_DRIVER_PRBS ,
RAWSPICE  )
inlineinherited

Definition at line 132 of file sim_model.h.

References D, I, and NONE.

◆ DEFINE_ENUM_CLASS_WITH_ITERATOR() [3/3]

SIM_MODEL_NGSPICE::DEFINE_ENUM_CLASS_WITH_ITERATOR ( MODEL_TYPE ,
NONE ,
DIODE ,
BJT ,
VBIC ,
HICUM2 ,
JFET ,
JFET2 ,
MES ,
MESA ,
HFET1 ,
HFET2 ,
VDMOS ,
MOS1 ,
MOS2 ,
MOS3 ,
BSIM1 ,
BSIM2 ,
MOS6 ,
BSIM3 ,
MOS9 ,
B4SOI ,
BSIM4 ,
B3SOIFD ,
B3SOIDD ,
B3SOIPD ,
HISIM2 ,
HISIMHV1 ,
HISIMHV2  )
inlineprotected

Definition at line 56 of file sim_model_ngspice.h.

References name, and NONE.

◆ DeviceInfo()

SIM_MODEL::DEVICE_INFO SIM_MODEL::DeviceInfo ( DEVICE_T aDeviceType)
staticinherited

Definition at line 60 of file sim_model.cpp.

Referenced by equivalent(), GetDeviceInfo(), MigrateSimModel(), DIALOG_SIM_MODEL< T >::onDeviceTypeChoice(), ReadTypeFromFields(), DIALOG_SIM_MODEL< T >::updateBuiltinModelWidgets(), and DIALOG_SIM_MODEL< T >::updateIbisWidgets().

◆ doFindParam()

int SIM_MODEL_NGSPICE::doFindParam ( const std::string & aParamName) const
overrideprotectedvirtual

Reimplemented from SIM_MODEL.

Definition at line 85 of file sim_model_ngspice.cpp.

References SIM_MODEL::GetParam(), SIM_MODEL::GetParamCount(), SIM_MODEL::PARAM::info, SIM_MODEL::PARAM::Matches(), and SIM_MODEL::PARAM::INFO::name.

◆ doSetParamValue()

void SIM_MODEL::doSetParamValue ( int aParamIndex,
const std::string & aValue )
protectedvirtualinherited

Reimplemented in SIM_MODEL_SOURCE.

Definition at line 777 of file sim_model.cpp.

References m_params.

Referenced by SIM_MODEL_SOURCE::doSetParamValue(), and SetParamValue().

◆ FindModelPinIndex()

int SIM_MODEL::FindModelPinIndex ( const std::string & aSymbolPinNumber)
inherited

Definition at line 655 of file sim_model.cpp.

References GetPin(), GetPinCount(), and SIM_MODEL_PIN::NOT_CONNECTED.

Referenced by SCH_EDITOR_CONTROL::SimProbe().

◆ FindParam()

const SIM_MODEL::PARAM * SIM_MODEL::FindParam ( const std::string & aParamName) const
inherited

Definition at line 754 of file sim_model.cpp.

References doFindParam(), and GetParam().

Referenced by TEST_SIM_LIBRARY_SPICE_FIXTURE::CompareToUsualDiodeModel(), SIM_MODEL_R_POT::GetTunerParam(), and TEST_SIM_LIBRARY_SPICE_FIXTURE::TestTransistor().

◆ GetBaseModel()

const SIM_MODEL * SIM_MODEL::GetBaseModel ( ) const
inlineinherited

Definition at line 462 of file sim_model.h.

References m_baseModel, and SIM_MODEL().

Referenced by SIM_MODEL_SUBCKT::SetBaseModel().

◆ GetBaseParam()

const SIM_MODEL::PARAM & SIM_MODEL::GetBaseParam ( unsigned aParamIndex) const
inherited

Definition at line 768 of file sim_model.cpp.

References m_baseModel, and m_params.

◆ GetDeviceInfo()

DEVICE_INFO SIM_MODEL::GetDeviceInfo ( ) const
inlineinherited

Definition at line 456 of file sim_model.h.

References DeviceInfo(), and GetDeviceType().

Referenced by TEST_SIM_LIBRARY_SPICE_FIXTURE::TestTransistor(), TUNER_SLIDER::TUNER_SLIDER(), DIALOG_SIM_MODEL< T >::updateBuiltinModelWidgets(), and DIALOG_SIM_MODEL< T >::updateIbisWidgets().

◆ GetDeviceType()

DEVICE_T SIM_MODEL::GetDeviceType ( ) const
inlineinherited

Definition at line 459 of file sim_model.h.

References GetTypeInfo().

Referenced by SIM_MODEL_NGSPICE::canSilentlyIgnoreParam(), GetDeviceInfo(), SIM_MODEL_SOURCE::GetPinNames(), DIALOG_SIM_MODEL< T >::updateBuiltinModelWidgets(), and DIALOG_SIM_MODEL< T >::updateIbisWidgets().

◆ getModelType()

SIM_MODEL_NGSPICE::MODEL_TYPE SIM_MODEL_NGSPICE::getModelType ( ) const
private

Definition at line 253 of file sim_model_ngspice.cpp.

References SIM_MODEL::GetType().

Referenced by GetPinNames(), SetParamFromSpiceCode(), and SIM_MODEL_NGSPICE().

◆ GetParam()

const SIM_MODEL::PARAM & SIM_MODEL::GetParam ( unsigned aParamIndex) const
virtualinherited

Reimplemented in SIM_MODEL_IBIS.

Definition at line 727 of file sim_model.cpp.

References m_baseModel, and m_params.

Referenced by DIALOG_SIM_MODEL< T >::addParamPropertyIfRelevant(), TEST_SIM_LIBRARY_SPICE_FIXTURE::CompareToEmptyModel(), doFindParam(), SIM_MODEL_NGSPICE::doFindParam(), SIM_MODEL_SPICE_FALLBACK::doFindParam(), SIM_MODEL_SOURCE::doSetParamValue(), FindParam(), SIM_MODEL_IDEAL::GetTunerParam(), SIM_MODEL_SOURCE::GetTunerParam(), DIALOG_SIM_MODEL< T >::newParamProperty(), SPICE_MODEL_PARSER::ReadModel(), SIM_MODEL_SUBCKT::SetBaseModel(), SIM_MODEL_NGSPICE::SetParamFromSpiceCode(), SIM_MODEL_SPICE_FALLBACK::SIM_MODEL_SPICE_FALLBACK(), and DIALOG_SIM_MODEL< T >::updateBuiltinModelWidgets().

◆ GetParamCount()

int SIM_MODEL::GetParamCount ( ) const
inlineinherited

Definition at line 477 of file sim_model.h.

References m_params.

Referenced by TEST_SIM_LIBRARY_SPICE_FIXTURE::CompareToEmptyModel(), doFindParam(), SIM_MODEL_NGSPICE::doFindParam(), SIM_MODEL_SPICE_FALLBACK::doFindParam(), SIM_MODEL_SOURCE::doSetParamValue(), SPICE_MODEL_PARSER::ReadModel(), requiresSpiceModelLine(), SIM_MODEL_SUBCKT::SetBaseModel(), SIM_MODEL_NGSPICE::SetParamFromSpiceCode(), SIM_MODEL_IBIS::SIM_MODEL_IBIS(), SIM_MODEL_SPICE_FALLBACK::SIM_MODEL_SPICE_FALLBACK(), and DIALOG_SIM_MODEL< T >::updateModelParamsTab().

◆ GetParamOverride()

const SIM_MODEL::PARAM & SIM_MODEL::GetParamOverride ( unsigned aParamIndex) const
inherited

Definition at line 762 of file sim_model.cpp.

References m_params.

Referenced by TEST_SIM_LIBRARY_SPICE_FIXTURE::CompareToEmptyModel().

◆ GetPin()

const SIM_MODEL_PIN & SIM_MODEL::GetPin ( unsigned aIndex) const
inlineinherited

Definition at line 468 of file sim_model.h.

References m_modelPins.

Referenced by FindModelPinIndex(), DIALOG_SIM_MODEL< T >::getModelPinString(), GetPins(), DIALOG_SIM_MODEL< T >::removeOrphanedPinAssignments(), and DIALOG_SIM_MODEL< T >::updatePinAssignments().

◆ GetPinCount()

int SIM_MODEL::GetPinCount ( ) const
inlineinherited

Definition at line 467 of file sim_model.h.

References m_modelPins.

Referenced by FindModelPinIndex(), GetPins(), SPICE_MODEL_PARSER_SUBCKT::ReadModel(), DIALOG_SIM_MODEL< T >::removeOrphanedPinAssignments(), and DIALOG_SIM_MODEL< T >::updatePinAssignments().

◆ GetPinNames()

std::vector< std::string > SIM_MODEL_NGSPICE::GetPinNames ( ) const
overridevirtual

Reimplemented from SIM_MODEL.

Definition at line 247 of file sim_model_ngspice.cpp.

References getModelType(), and ModelInfo().

◆ GetPins()

std::vector< std::reference_wrapper< const SIM_MODEL_PIN > > SIM_MODEL::GetPins ( ) const
inherited

Definition at line 686 of file sim_model.cpp.

References GetPin(), and GetPinCount().

Referenced by SCH_EDIT_FRAME::RefreshOperatingPointDisplay(), SCH_SYMBOL::ResolveTextVar(), and SIM_MODEL_SUBCKT::SetBaseModel().

◆ GetSpiceInfo()

SPICE_INFO SIM_MODEL::GetSpiceInfo ( ) const
inlineinherited

Definition at line 448 of file sim_model.h.

References GetType(), and SpiceInfo().

Referenced by TEST_SIM_LIBRARY_SPICE_FIXTURE::CompareToEmptyModel(), TEST_SIM_LIBRARY_SPICE_FIXTURE::CompareToUsualDiodeModel(), and TEST_SIM_LIBRARY_SPICE_FIXTURE::TestTransistor().

◆ GetTunerParam()

virtual const PARAM * SIM_MODEL::GetTunerParam ( ) const
inlinevirtualinherited

Reimplemented in SIM_MODEL_IDEAL, SIM_MODEL_R_POT, and SIM_MODEL_SOURCE.

Definition at line 480 of file sim_model.h.

Referenced by SIMULATOR_FRAME_UI::applyTuners(), TUNER_SLIDER::TUNER_SLIDER(), and SIMULATOR_FRAME_UI::UpdateTunerValue().

◆ GetType()

TYPE SIM_MODEL::GetType ( ) const
inlineinherited

Definition at line 460 of file sim_model.h.

References m_type.

Referenced by SIM_MODEL_NGSPICE::canSilentlyIgnoreParam(), TEST_SIM_LIBRARY_SPICE_FIXTURE::CompareToUsualDiodeModel(), Create(), Create(), SIM_MODEL_NGSPICE::getModelType(), SIM_MODEL_SPICE_FALLBACK::GetPinNames(), GetSpiceInfo(), SIM_MODEL_SOURCE::GetTunerParam(), GetTypeInfo(), SIM_MODEL_SOURCE::HasPrimaryValue(), SPICE_MODEL_PARSER::ReadType(), SetBaseModel(), TEST_SIM_LIBRARY_SPICE_FIXTURE::TestTransistor(), DIALOG_SIM_MODEL< T >::TransferDataFromWindow(), TUNER_SLIDER::TUNER_SLIDER(), SPICE_GENERATOR_SOURCE::TunerCommand(), DIALOG_SIM_MODEL< T >::updateBuiltinModelWidgets(), DIALOG_SIM_MODEL< T >::updateIbisWidgets(), and DIALOG_SIM_MODEL< T >::updatePinAssignments().

◆ GetTypeInfo()

INFO SIM_MODEL::GetTypeInfo ( ) const
inlineinherited

Definition at line 457 of file sim_model.h.

References GetType(), and TypeInfo().

Referenced by GetDeviceType(), TEST_SIM_LIBRARY_SPICE_FIXTURE::TestTransistor(), and TUNER_SLIDER::TUNER_SLIDER().

◆ HasAutofill()

virtual bool SIM_MODEL::HasAutofill ( ) const
inlinevirtualinherited

Reimplemented in SIM_MODEL_SOURCE.

Definition at line 494 of file sim_model.h.

Referenced by DIALOG_SIM_MODEL< T >::updateModelParamsTab().

◆ HasPrimaryValue()

virtual bool SIM_MODEL::HasPrimaryValue ( ) const
inlinevirtualinherited

Reimplemented in SIM_MODEL_IDEAL, SIM_MODEL_R_POT, and SIM_MODEL_SOURCE.

Definition at line 495 of file sim_model.h.

Referenced by SetIsStoredInValue(), and DIALOG_SIM_MODEL< T >::updateBuiltinModelWidgets().

◆ InferSimModel()

template<class T>
template bool SIM_MODEL::InferSimModel< LIB_SYMBOL > ( T & aSymbol,
std::vector< SCH_FIELD > * aFields,
bool aResolve,
int aDepth,
SIM_VALUE_GRAMMAR::NOTATION aNotation,
wxString * aDeviceType,
wxString * aModelType,
wxString * aModelParams,
wxString * aPinMap )
staticinherited

KiCad Spice PEGTL only handles ASCII Although these two look the same, they are U+03BC and U+00B5

Definition at line 1020 of file sim_model.cpp.

References convertSeparators(), GetFieldValue(), library, SIM_VALUE_GRAMMAR::SI, SIM_DEVICE_FIELD, SIM_DEVICE_SUBTYPE_FIELD, SIM_LIBRARY_FIELD, SIM_NAME_FIELD, SIM_PARAMS_FIELD, SIM_PINS_FIELD, SIM_VALUE_FIELD, SIM_VALUE_GRAMMAR::SPICE, and T.

Referenced by BOOST_AUTO_TEST_CASE(), SIM_LIB_MGR::CreateModel(), and DIALOG_SIM_MODEL< T >::TransferDataToWindow().

◆ IsEnabled()

bool SIM_MODEL::IsEnabled ( ) const
inlineinherited

Definition at line 498 of file sim_model.h.

References m_isEnabled.

◆ IsStoredInValue()

bool SIM_MODEL::IsStoredInValue ( ) const
inlineinherited

Definition at line 505 of file sim_model.h.

References m_isStoredInValue.

Referenced by WriteFields().

◆ MigrateSimModel()

template<typename T>
template void SIM_MODEL::MigrateSimModel< LIB_SYMBOL > ( T & aSymbol,
const PROJECT * aProject )
staticinherited

Definition at line 1359 of file sim_model.cpp.

References Create(), SIM_LIB_MGR::CreateModel(), DEFAULT_SIZE_TEXT, DeviceInfo(), SIM_MODEL_SERIALIZER::GeneratePins(), EDA_TEXT::GetAttributes(), SCH_FIELD::GetBoundingBox(), SCHEMATIC::GetEmbeddedFiles(), BOX2< Vec >::GetHeight(), EDA_TEXT::GetHorizJustify(), SCH_FIELD::GetPosition(), SCH_FIELD::GetShownText(), EDA_TEXT::GetText(), BOX2< Vec >::GetWidth(), GR_TEXT_H_ALIGN_RIGHT, REPORTER::HasMessage(), EDA_TEXT::IsVisible(), KiROUND(), SIM_LIBRARY::MODEL::model, SCH_ITEM::Schematic(), schIUScale, Serializer(), EDA_TEXT::SetAttributes(), SIM_LIB_MGR::SetFilesStack(), SCH_FIELD::SetPosition(), SCH_FIELD::SetText(), EDA_TEXT::SetVisible(), SIM_DEVICE_FIELD, SIM_DEVICE_SUBTYPE_FIELD, SIM_LEGACY_ENABLE_FIELD, SIM_LEGACY_LIBRARY_FIELD, SIM_LEGACY_MODEL_FIELD, SIM_LEGACY_PINS_FIELD, SIM_LEGACY_PRIMITIVE_FIELD, SIM_LIBRARY_FIELD, SIM_NAME_FIELD, SIM_PARAMS_FIELD, SIM_PINS_FIELD, SIM_VALUE_GRAMMAR::SPICE, SpiceInfo(), T, TypeInfo(), USER, VALUE, and wxStringSplit().

Referenced by SYMBOL_LIB::FindSymbol(), SYMBOL_LIB_TABLE::LoadSymbol(), and SCH_SCREEN::MigrateSimModels().

◆ ModelInfo()

const SIM_MODEL_NGSPICE::MODEL_INFO & SIM_MODEL_NGSPICE::ModelInfo ( MODEL_TYPE aType)
staticprotected

Definition at line 326 of file sim_model_ngspice.cpp.

References s_ModelInfoMap, and s_ModelInfoMapMutex.

Referenced by GetPinNames(), SetParamFromSpiceCode(), and SIM_MODEL_NGSPICE().

◆ ReadDataFields()

void SIM_MODEL::ReadDataFields ( const std::vector< SCH_FIELD > * aFields,
bool aResolve,
int aDepth,
const std::vector< SCH_PIN * > & aPins )
inherited

Definition at line 430 of file sim_model.cpp.

References createPins(), SIM_LIBRARY_IBIS::DIFF_FIELD, GetFieldValue(), m_serializer, SIM_LEGACY_ENABLE_FIELD_V7, SIM_PARAMS_FIELD, SIM_PINS_FIELD, SIM_VALUE_FIELD, and SwitchSingleEndedDiff().

◆ ReadTypeFromFields()

TYPE SIM_MODEL::ReadTypeFromFields ( const std::vector< SCH_FIELD > & aFields,
bool aResolve,
int aDepth,
REPORTER & aReporter )
staticinherited

Definition at line 390 of file sim_model.cpp.

References _, DeviceInfo(), GetFieldValue(), REFERENCE, REPORTER::Report(), RPT_SEVERITY_ERROR, SIM_DEVICE_FIELD, SIM_DEVICE_SUBTYPE_FIELD, and TypeInfo().

Referenced by Create(), Create(), and DIALOG_SIM_MODEL< T >::TransferDataToWindow().

◆ requiresSpiceModelLine()

bool SIM_MODEL::requiresSpiceModelLine ( const SPICE_ITEM & aItem) const
privatevirtualinherited

Reimplemented in SIM_MODEL_IBIS, SIM_MODEL_RAW_SPICE, and SIM_MODEL_SWITCH.

Definition at line 976 of file sim_model.cpp.

References SPICE_ITEM::baseModelName, GetParamCount(), SIM_MODEL::PARAM::info, SIM_MODEL::PARAM::INFO::isSpiceInstanceParam, m_baseModel, m_params, m_type, SIM_VALUE::Normalize(), SIM_MODEL(), SIM_VALUE::ToDouble(), and SIM_MODEL::PARAM::value.

◆ Serializer()

const SIM_MODEL_SERIALIZER & SIM_MODEL::Serializer ( ) const
inlineinherited

Definition at line 432 of file sim_model.h.

References m_serializer.

Referenced by MigrateSimModel().

◆ SetBaseModel()

void SIM_MODEL::SetBaseModel ( const SIM_MODEL & aBaseModel)
virtualinherited

Reimplemented in SIM_MODEL_IBIS, and SIM_MODEL_SUBCKT.

Definition at line 677 of file sim_model.cpp.

References GetType(), m_baseModel, and SIM_MODEL().

Referenced by SIM_MODEL_SUBCKT::SetBaseModel().

◆ SetIsEnabled()

void SIM_MODEL::SetIsEnabled ( bool aIsEnabled)
inlineinherited

Definition at line 497 of file sim_model.h.

References m_isEnabled.

◆ SetIsStoredInValue()

void SIM_MODEL::SetIsStoredInValue ( bool aIsStoredInValue)
inlineinherited

Definition at line 500 of file sim_model.h.

References HasPrimaryValue(), and m_isStoredInValue.

Referenced by SIM_LIB_MGR::CreateModel(), and DIALOG_SIM_MODEL< T >::TransferDataFromWindow().

◆ SetParamFromSpiceCode()

void SIM_MODEL_NGSPICE::SetParamFromSpiceCode ( const std::string & aParamName,
const std::string & aValue,
SIM_VALUE_GRAMMAR::NOTATION aNotation )
overridevirtual

Reimplemented from SIM_MODEL_SPICE.

Definition at line 111 of file sim_model_ngspice.cpp.

References canSilentlyIgnoreParam(), SIM_MODEL::PARAM::INFO::category, getModelType(), SIM_MODEL::GetParam(), SIM_MODEL::GetParamCount(), SIM_MODEL::PARAM::info, SIM_MODEL::PARAM::INFO::isSpiceInstanceParam, SIM_MODEL::PARAM::Matches(), ModelInfo(), SIM_MODEL::PARAM::INFO::name, SIM_MODEL::SetParamValue(), and THROW_IO_ERROR.

◆ SetParamValue() [1/2]

void SIM_MODEL::SetParamValue ( const std::string & aParamName,
const std::string & aValue,
SIM_VALUE::NOTATION aNotation = SIM_VALUE::NOTATION::SI )
inherited

Definition at line 818 of file sim_model.cpp.

References doFindParam(), SetParamValue(), and THROW_IO_ERROR.

◆ SetParamValue() [2/2]

void SIM_MODEL::SetParamValue ( int aParamIndex,
const std::string & aValue,
SIM_VALUE::NOTATION aNotation = SIM_VALUE::NOTATION::SI )
inherited

Definition at line 783 of file sim_model.cpp.

References SIM_VALUE::ConvertNotation(), and doSetParamValue().

Referenced by SIM_MODEL_SOURCE::doSetParamValue(), SIM_MODEL_BEHAVIORAL::parseValueField(), SIM_MODEL_NGSPICE::SetParamFromSpiceCode(), SIM_MODEL_SPICE::SetParamFromSpiceCode(), SetParamValue(), DIALOG_SIM_MODEL< T >::TransferDataFromWindow(), and SIMULATOR_FRAME_UI::UpdateTunerValue().

◆ SpiceGenerator()

const SPICE_GENERATOR & SIM_MODEL::SpiceGenerator ( ) const
inlineinherited

Definition at line 431 of file sim_model.h.

References m_spiceGenerator, and SPICE_GENERATOR.

Referenced by SIMULATOR_FRAME_UI::applyTuners(), NETLIST_EXPORTER_SPICE::readModel(), SCH_EDIT_FRAME::RefreshOperatingPointDisplay(), SCH_SYMBOL::ResolveTextVar(), SCH_EDITOR_CONTROL::SimProbe(), SPICE_GENERATOR_IDEAL::TunerCommand(), SPICE_GENERATOR_R_POT::TunerCommand(), SPICE_GENERATOR_SOURCE::TunerCommand(), and DIALOG_SIM_MODEL< T >::updateModelCodeTab().

◆ SpiceInfo()

SIM_MODEL::SPICE_INFO SIM_MODEL::SpiceInfo ( TYPE aType)
staticinherited

Definition at line 249 of file sim_model.cpp.

Referenced by GetSpiceInfo(), MigrateSimModel(), and SPICE_MODEL_PARSER::ReadTypeFromSpiceStrings().

◆ SwitchSingleEndedDiff()

virtual void SIM_MODEL::SwitchSingleEndedDiff ( bool aDiff)
inlinevirtualinherited

Reimplemented in SIM_MODEL_IBIS.

Definition at line 507 of file sim_model.h.

Referenced by ReadDataFields().

◆ TypeInfo()

SIM_MODEL::INFO SIM_MODEL::TypeInfo ( TYPE aType)
staticinherited

Definition at line 105 of file sim_model.cpp.

Referenced by GetTypeInfo(), MigrateSimModel(), DIALOG_SIM_MODEL< T >::onTypeChoice(), DIALOG_SIM_MODEL< T >::onWaveformChoice(), ReadTypeFromFields(), DIALOG_SIM_MODEL< T >::TransferDataToWindow(), DIALOG_SIM_MODEL< T >::updateBuiltinModelWidgets(), and DIALOG_SIM_MODEL< T >::updateIbisWidgets().

◆ WriteFields()

void SIM_MODEL::WriteFields ( std::vector< SCH_FIELD > & aFields) const
inherited

Definition at line 448 of file sim_model.cpp.

References IsStoredInValue(), m_serializer, SetFieldValue(), SIM_DEVICE_FIELD, SIM_DEVICE_SUBTYPE_FIELD, SIM_LEGACY_ENABLE_FIELD_V7, SIM_PARAMS_FIELD, SIM_PINS_FIELD, and SIM_VALUE_FIELD.

Referenced by SIMULATOR_FRAME_UI::UpdateTunerValue().

Friends And Related Symbol Documentation

◆ NGSPICE_MODEL_INFO_MAP

friend struct NGSPICE_MODEL_INFO_MAP
friend

Definition at line 44 of file sim_model_ngspice.h.

References NGSPICE_MODEL_INFO_MAP.

Referenced by NGSPICE_MODEL_INFO_MAP.

Member Data Documentation

◆ m_baseModel

const SIM_MODEL* SIM_MODEL::m_baseModel
protectedinherited

Definition at line 536 of file sim_model.h.

Referenced by GetBaseModel(), GetBaseParam(), GetParam(), SIM_MODEL_RAW_SPICE::GetSource(), SIM_MODEL_SUBCKT::GetSpiceCode(), requiresSpiceModelLine(), SetBaseModel(), and SIM_MODEL().

◆ m_isEnabled

bool SIM_MODEL::m_isEnabled
privateinherited

Definition at line 543 of file sim_model.h.

Referenced by IsEnabled(), SetIsEnabled(), and SIM_MODEL().

◆ m_isStoredInValue

bool SIM_MODEL::m_isStoredInValue
privateinherited

Definition at line 544 of file sim_model.h.

Referenced by IsStoredInValue(), SetIsStoredInValue(), and SIM_MODEL().

◆ m_modelPins

std::vector<SIM_MODEL_PIN> SIM_MODEL::m_modelPins
protectedinherited

Definition at line 535 of file sim_model.h.

Referenced by AddPin(), AssignSymbolPinNumberToModelPin(), AssignSymbolPinNumberToModelPin(), SIM_MODEL_RAW_SPICE::AssignSymbolPinNumberToModelPin(), SIM_MODEL_SPICE_FALLBACK::AssignSymbolPinNumberToModelPin(), ClearPins(), GetPin(), and GetPinCount().

◆ m_params

std::vector<PARAM> SIM_MODEL::m_params
protectedinherited

Definition at line 534 of file sim_model.h.

Referenced by AddParam(), doSetParamValue(), SIM_MODEL_SOURCE::doSetParamValue(), GetBaseParam(), GetParam(), SIM_MODEL_IBIS::GetParam(), GetParamCount(), GetParamOverride(), requiresSpiceModelLine(), and SIM_MODEL_IBIS::SIM_MODEL_IBIS().

◆ m_serializer

std::unique_ptr<SIM_MODEL_SERIALIZER> SIM_MODEL::m_serializer
protectedinherited

Definition at line 537 of file sim_model.h.

Referenced by ReadDataFields(), Serializer(), SIM_MODEL(), and WriteFields().

◆ m_spiceCode

std::string SIM_MODEL_SPICE::m_spiceCode
protectedinherited

Definition at line 66 of file sim_model_spice.h.

Referenced by SIM_MODEL_SPICE_FALLBACK::GetSpiceCode(), SIM_MODEL_SUBCKT::GetSpiceCode(), SPICE_GENERATOR_SPICE::Preview(), SPICE_MODEL_PARSER_SUBCKT::ReadModel(), and SIM_MODEL_SPICE_FALLBACK::SIM_MODEL_SPICE_FALLBACK().

◆ m_spiceGenerator

std::unique_ptr<SPICE_GENERATOR> SIM_MODEL::m_spiceGenerator
privateinherited

Definition at line 540 of file sim_model.h.

Referenced by SIM_MODEL(), and SpiceGenerator().

◆ m_spiceModelParser

std::unique_ptr<SPICE_MODEL_PARSER> SIM_MODEL_SPICE::m_spiceModelParser
privateinherited

Definition at line 69 of file sim_model_spice.h.

Referenced by SIM_MODEL_SPICE(), and SIM_MODEL_SPICE().

◆ m_type

const TYPE SIM_MODEL::m_type
privateinherited

Definition at line 542 of file sim_model.h.

Referenced by GetType(), requiresSpiceModelLine(), and SIM_MODEL().

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