KiCad PCB EDA Suite
Loading...
Searching...
No Matches
SIM_MODEL_IDEAL Class Reference

#include <sim_model_ideal.h>

Inheritance diagram for SIM_MODEL_IDEAL:
SIM_MODEL

Public Member Functions

 SIM_MODEL_IDEAL (TYPE aType)
 
const PARAMGetTunerParam () const override
 
bool HasPrimaryValue () const 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_GENERATORSpiceGenerator () const
 
const SIM_MODEL_SERIALIZERSerializer () const
 
void ReadDataFields (const std::vector< SCH_FIELD > *aFields, const std::vector< SCH_PIN * > &aPins)
 
void WriteFields (std::vector< SCH_FIELD > &aFields) const
 
SPICE_INFO GetSpiceInfo () const
 
void AddPin (const 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_MODELGetBaseModel () const
 
virtual void SetBaseModel (const SIM_MODEL &aBaseModel)
 
int GetPinCount () const
 
const PINGetPin (unsigned aIndex) const
 
std::vector< std::reference_wrapper< const PIN > > GetPins () const
 
void SetPinSymbolPinNumber (int aPinIndex, const std::string &aSymbolPinNumber)
 
virtual void SetPinSymbolPinNumber (const std::string &aPinName, const std::string &aSymbolPinNumber)
 
int GetParamCount () const
 
virtual const PARAMGetParam (unsigned aParamIndex) const
 
const PARAMFindParam (const std::string &aParamName) const
 
std::vector< std::reference_wrapper< const PARAM > > GetParams () const
 
const PARAMGetParamOverride (unsigned aParamIndex) const
 
const PARAMGetBaseParam (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
 
void SetIsEnabled (bool aIsEnabled)
 
bool IsEnabled () const
 
void SetIsStoredInValue (bool aIsStoredInValue)
 
bool IsStoredInValue () const
 
virtual void SwitchSingleEndedDiff (bool aDiff)
 

Static Public Member Functions

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, REPORTER &aReporter)
 
static std::unique_ptr< SIM_MODELCreate (TYPE aType, const std::vector< SCH_PIN * > &aPins, REPORTER &aReporter)
 
static std::unique_ptr< SIM_MODELCreate (const SIM_MODEL *aBaseModel, const std::vector< SCH_PIN * > &aPins, REPORTER &aReporter)
 
static std::unique_ptr< SIM_MODELCreate (const SIM_MODEL *aBaseModel, const std::vector< SCH_PIN * > &aPins, const std::vector< SCH_FIELD > &aFields, REPORTER &aReporter)
 
static std::unique_ptr< SIM_MODELCreate (const std::vector< SCH_FIELD > &aFields, const std::vector< SCH_PIN * > &aPins, bool aResolved, REPORTER &aReporter)
 
static std::string GetFieldValue (const std::vector< SCH_FIELD > *aFields, const wxString &aFieldName, bool aResolve=true)
 
static void SetFieldValue (std::vector< SCH_FIELD > &aFields, const wxString &aFieldName, const std::string &aValue)
 
template<class T >
static bool InferSimModel (T &aSymbol, std::vector< SCH_FIELD > *aFields, bool aResolve, 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

void createPins (const std::vector< SCH_PIN * > &aSymbolPins)
 
virtual int doFindParam (const std::string &aParamName) const
 
virtual void doSetParamValue (int aParamIndex, const std::string &aValue)
 

Static Protected Member Functions

static std::unique_ptr< SIM_MODELCreate (TYPE aType)
 

Protected Attributes

std::vector< PARAMm_params
 
std::vector< PINm_pins
 
const SIM_MODELm_baseModel
 
std::unique_ptr< SIM_MODEL_SERIALIZERm_serializer
 

Private Member Functions

virtual bool requiresSpiceModelLine (const SPICE_ITEM &aItem) const
 

Static Private Member Functions

static PARAM::INFO makeParamInfo (const std::string &aName, const std::string &aDescription, const std::string &aUnit)
 

Private Attributes

std::unique_ptr< SPICE_GENERATORm_spiceGenerator
 
const TYPE m_type
 
bool m_isEnabled
 
bool m_isStoredInValue
 

Detailed Description

Definition at line 44 of file sim_model_ideal.h.

Constructor & Destructor Documentation

◆ SIM_MODEL_IDEAL()

SIM_MODEL_IDEAL::SIM_MODEL_IDEAL ( TYPE  aType)

Definition at line 57 of file sim_model_ideal.cpp.

References SIM_MODEL::AddParam(), and makeParamInfo().

Member Function Documentation

◆ AddParam()

◆ AddPin()

void SIM_MODEL::AddPin ( const PIN aPin)
inherited

◆ ClearPins()

void SIM_MODEL::ClearPins ( )
inherited

Definition at line 702 of file sim_model.cpp.

References SIM_MODEL::m_pins.

Referenced by SIM_MODEL_KIBIS::SwitchSingleEndedDiff().

◆ Create() [1/5]

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

◆ Create() [2/5]

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

Definition at line 511 of file sim_model.cpp.

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

◆ Create() [3/5]

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

◆ Create() [4/5]

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

Definition at line 872 of file sim_model.cpp.

◆ Create() [5/5]

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

◆ createPins()

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

Definition at line 983 of file sim_model.cpp.

References SIM_MODEL::AddPin(), and SIM_MODEL::GetPinNames().

Referenced by SIM_MODEL::ReadDataFields().

◆ DEFINE_ENUM_CLASS_WITH_ITERATOR() [1/2]

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

Definition at line 78 of file sim_model.h.

◆ DEFINE_ENUM_CLASS_WITH_ITERATOR() [2/2]

SIM_MODEL::DEFINE_ENUM_CLASS_WITH_ITERATOR ( TYPE  ,
NONE  ,
,
R_POT  ,
R_BEHAVIORAL  ,
C  ,
C_BEHAVIORAL  ,
,
L_BEHAVIORAL  ,
,
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_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 124 of file sim_model.h.

◆ DeviceInfo()

◆ doFindParam()

int SIM_MODEL::doFindParam ( const std::string &  aParamName) const
protectedvirtualinherited

Reimplemented in SIM_MODEL_NGSPICE, and SIM_MODEL_SPICE_FALLBACK.

Definition at line 794 of file sim_model.cpp.

References SIM_MODEL::GetParams().

Referenced by SIM_MODEL::FindParam(), and SIM_MODEL::SetParamValue().

◆ doSetParamValue()

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

Reimplemented in SIM_MODEL_SOURCE.

Definition at line 842 of file sim_model.cpp.

References SIM_MODEL::m_params.

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

◆ FindModelPinIndex()

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

◆ FindParam()

◆ GetBaseModel()

const SIM_MODEL * SIM_MODEL::GetBaseModel ( ) const
inlineinherited

◆ GetBaseParam()

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

Definition at line 833 of file sim_model.cpp.

References SIM_MODEL::GetParam(), SIM_MODEL::m_baseModel, and SIM_MODEL::m_params.

◆ GetDeviceInfo()

◆ GetDeviceType()

◆ GetFieldValue()

◆ GetParam()

◆ GetParamCount()

◆ GetParamOverride()

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

◆ GetParams()

◆ GetPin()

◆ GetPinCount()

◆ GetPinNames()

std::vector< std::string > SIM_MODEL_IDEAL::GetPinNames ( ) const
inlineoverridevirtual

Reimplemented from SIM_MODEL.

Definition at line 52 of file sim_model_ideal.h.

◆ GetPins()

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

◆ GetSpiceInfo()

◆ GetTunerParam()

const PARAM * SIM_MODEL_IDEAL::GetTunerParam ( ) const
inlineoverridevirtual

Reimplemented from SIM_MODEL.

Definition at line 49 of file sim_model_ideal.h.

References SIM_MODEL::GetParam().

◆ GetType()

◆ GetTypeInfo()

◆ HasAutofill()

virtual bool SIM_MODEL::HasAutofill ( ) const
inlinevirtualinherited

◆ HasPrimaryValue()

bool SIM_MODEL_IDEAL::HasPrimaryValue ( ) const
inlineoverridevirtual

Reimplemented from SIM_MODEL.

Definition at line 50 of file sim_model_ideal.h.

◆ InferSimModel()

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

◆ IsEnabled()

bool SIM_MODEL::IsEnabled ( ) const
inlineinherited

Definition at line 505 of file sim_model.h.

References SIM_MODEL::m_isEnabled.

Referenced by SIM_MODEL_SERIALIZER::GenerateEnable().

◆ IsStoredInValue()

bool SIM_MODEL::IsStoredInValue ( ) const
inlineinherited

◆ makeParamInfo()

SIM_MODEL::PARAM::INFO SIM_MODEL_IDEAL::makeParamInfo ( const std::string &  aName,
const std::string &  aDescription,
const std::string &  aUnit 
)
staticprivate

◆ MigrateSimModel()

◆ ReadDataFields()

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

◆ ReadTypeFromFields()

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

◆ requiresSpiceModelLine()

◆ Serializer()

const SIM_MODEL_SERIALIZER & SIM_MODEL::Serializer ( ) const
inlineinherited

Definition at line 437 of file sim_model.h.

References SIM_MODEL::m_serializer.

Referenced by SIM_MODEL::MigrateSimModel().

◆ SetBaseModel()

void SIM_MODEL::SetBaseModel ( const SIM_MODEL aBaseModel)
virtualinherited

Reimplemented in SIM_MODEL_KIBIS, and SIM_MODEL_SUBCKT.

Definition at line 730 of file sim_model.cpp.

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

Referenced by SIM_MODEL_SUBCKT::SetBaseModel().

◆ SetFieldValue()

void SIM_MODEL::SetFieldValue ( std::vector< SCH_FIELD > &  aFields,
const wxString &  aFieldName,
const std::string &  aValue 
)
staticinherited

◆ SetIsEnabled()

void SIM_MODEL::SetIsEnabled ( bool  aIsEnabled)
inlineinherited

Definition at line 504 of file sim_model.h.

References SIM_MODEL::m_isEnabled.

Referenced by SIM_MODEL_SERIALIZER::ParseEnable().

◆ SetIsStoredInValue()

void SIM_MODEL::SetIsStoredInValue ( bool  aIsStoredInValue)
inlineinherited

◆ SetParamValue() [1/2]

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

◆ SetParamValue() [2/2]

◆ SetPinSymbolPinNumber() [1/2]

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

Reimplemented in SIM_MODEL_RAW_SPICE, and SIM_MODEL_SPICE_FALLBACK.

Definition at line 756 of file sim_model.cpp.

References _, SIM_MODEL::m_pins, pin, and THROW_IO_ERROR.

◆ SetPinSymbolPinNumber() [2/2]

void SIM_MODEL::SetPinSymbolPinNumber ( int  aPinIndex,
const std::string &  aSymbolPinNumber 
)
inherited

◆ SpiceGenerator()

◆ SpiceInfo()

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

◆ SwitchSingleEndedDiff()

virtual void SIM_MODEL::SwitchSingleEndedDiff ( bool  aDiff)
inlinevirtualinherited

Reimplemented in SIM_MODEL_KIBIS.

Definition at line 514 of file sim_model.h.

Referenced by SIM_MODEL::ReadDataFields().

◆ TypeInfo()

◆ WriteFields()

Member Data Documentation

◆ m_baseModel

◆ m_isEnabled

bool SIM_MODEL::m_isEnabled
privateinherited

Definition at line 550 of file sim_model.h.

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

◆ m_isStoredInValue

bool SIM_MODEL::m_isStoredInValue
privateinherited

Definition at line 551 of file sim_model.h.

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

◆ m_params

◆ m_pins

◆ m_serializer

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

◆ m_spiceGenerator

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

Definition at line 547 of file sim_model.h.

Referenced by SIM_MODEL::SpiceGenerator().

◆ m_type

const TYPE SIM_MODEL::m_type
privateinherited

Definition at line 549 of file sim_model.h.

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


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