SIM_MODEL Class Reference

#include <sim_model.h>

Inheritance diagram for SIM_MODEL:

Classes
struct	PARAM
struct	SPICE_INFO

Public Member Functions
	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
virtual	~SIM_MODEL ()
	SIM_MODEL ()=delete
	SIM_MODEL (const SIM_MODEL &aOther)=delete
	SIM_MODEL (SIM_MODEL &&aOther)=default
SIM_MODEL &	operator= (SIM_MODEL &&aOther)=delete
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 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)
virtual std::vector< std::string >	GetPinNames () const
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 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_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, REPORTER &aReporter)
static std::unique_ptr< SIM_MODEL >	Create (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
	SIM_MODEL (TYPE aType)
	SIM_MODEL (TYPE aType, std::unique_ptr< SPICE_GENERATOR > aSpiceGenerator)
	SIM_MODEL (TYPE aType, std::unique_ptr< SPICE_GENERATOR > aSpiceGenerator, std::unique_ptr< SIM_MODEL_SERIALIZER > aSerializer)
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_MODEL >	Create (TYPE aType)

Protected Attributes
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
virtual bool	requiresSpiceModelLine (const SPICE_ITEM &aItem) const

Private Attributes
std::unique_ptr< SPICE_GENERATOR >	m_spiceGenerator
const TYPE	m_type
bool	m_isEnabled
bool	m_isStoredInValue

Friends
class	SPICE_GENERATOR
class	NETLIST_EXPORTER_SPICE

Detailed Description

Definition at line 77 of file sim_model.h.

Constructor & Destructor Documentation

~SIM_MODEL()

SIM_MODEL::~SIM_MODEL ( )

virtualdefault

SIM_MODEL() [1/6]

SIM_MODEL::SIM_MODEL ( )

delete

SIM_MODEL() [2/6]

SIM_MODEL::SIM_MODEL ( const SIM_MODEL &  aOther )

delete

SIM_MODEL() [3/6]

SIM_MODEL::SIM_MODEL ( SIM_MODEL &&  aOther )

default

SIM_MODEL() [4/6]

SIM_MODEL::SIM_MODEL ( TYPE  aType )

protected

Definition at line 977 of file sim_model.cpp.

SIM_MODEL() [5/6]

SIM_MODEL::SIM_MODEL ( TYPE  aType, std::unique_ptr< SPICE_GENERATOR >  aSpiceGenerator  )

protected

Definition at line 984 of file sim_model.cpp.

SIM_MODEL() [6/6]

SIM_MODEL::SIM_MODEL ( TYPE  aType, std::unique_ptr< SPICE_GENERATOR >  aSpiceGenerator, std::unique_ptr< SIM_MODEL_SERIALIZER >  aSerializer  )

protected

Definition at line 991 of file sim_model.cpp.

Member Function Documentation

AddParam()

void SIM_MODEL::AddParam

(

const PARAM::INFO &

aInfo

)

Definition at line 729 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

)

Definition at line 705 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  )

virtual

Reimplemented in SIM_MODEL_RAW_SPICE, and SIM_MODEL_SPICE_FALLBACK.

Definition at line 766 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
	)

Definition at line 758 of file sim_model.cpp.

References m_modelPins.

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

ClearPins()

void SIM_MODEL::ClearPins

(

)

Definition at line 711 of file sim_model.cpp.

References m_modelPins.

Referenced by SIM_MODEL_IBIS::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  )

static

Definition at line 552 of file sim_model.cpp.

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

Create() [2/5]

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

static

Definition at line 515 of file sim_model.cpp.

References Create(), and 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  )

static

Definition at line 605 of file sim_model.cpp.

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

Create() [4/5]

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

staticprotected

Definition at line 892 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  )

static

Definition at line 496 of file sim_model.cpp.

References Create().

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

createPins()

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

protected

Definition at line 1003 of file sim_model.cpp.

References AddPin(), and GetPinNames().

Referenced by ReadDataFields().

DEFINE_ENUM_CLASS_WITH_ITERATOR() [1/2]

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    )

inline

Definition at line 86 of file sim_model.h.

DEFINE_ENUM_CLASS_WITH_ITERATOR() [2/2]

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    )

inline

Definition at line 132 of file sim_model.h.

DeviceInfo()

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

static

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::doFindParam ( const std::string &  aParamName ) const

protectedvirtual

Reimplemented in SIM_MODEL_NGSPICE, and SIM_MODEL_SPICE_FALLBACK.

Definition at line 804 of file sim_model.cpp.

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

Referenced by FindParam(), and SetParamValue().

doSetParamValue()

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

protectedvirtual

Reimplemented in SIM_MODEL_SOURCE.

Definition at line 839 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

)

Definition at line 717 of file sim_model.cpp.

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

Referenced by SCH_EDITOR_CONTROL::SimProbe().

FindParam()

const SIM_MODEL::PARAM * SIM_MODEL::FindParam

(

const std::string &

aParamName

)

const

Definition at line 816 of file sim_model.cpp.

References doFindParam(), and GetParam().

Referenced by TEST_SIM_LIBRARY_SPICE_FIXTURE::CompareToUsualDiodeModel(), SPICE_GENERATOR_SOURCE::getParamValueString(), SIM_MODEL_R_POT::GetTunerParam(), SPICE_GENERATOR_IBIS::IbisDevice(), SPICE_GENERATOR_SOURCE::ItemLine(), SPICE_GENERATOR_R_POT::ModelLine(), SPICE_GENERATOR_TLINE::ModelLine(), and TEST_SIM_LIBRARY_SPICE_FIXTURE::TestTransistor().

GetBaseModel()

const SIM_MODEL * SIM_MODEL::GetBaseModel ( ) const

inline

Definition at line 466 of file sim_model.h.

References m_baseModel.

Referenced by SIM_MODEL_SERIALIZER::GenerateParams(), SPICE_GENERATOR_SPICE::Preview(), and SIM_MODEL_SUBCKT::SetBaseModel().

GetBaseParam()

const SIM_MODEL::PARAM & SIM_MODEL::GetBaseParam

(

unsigned

aParamIndex

)

const

Definition at line 830 of file sim_model.cpp.

References GetParam(), m_baseModel, and m_params.

GetDeviceInfo()

DEVICE_INFO SIM_MODEL::GetDeviceInfo ( ) const

inline

Definition at line 460 of file sim_model.h.

References DeviceInfo(), and GetDeviceType().

Referenced by SIM_MODEL_SERIALIZER::GenerateDevice(), SIM_MODEL_SERIALIZER::GenerateValue(), 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

inline

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

GetFieldValue()

std::string SIM_MODEL::GetFieldValue ( const std::vector< SCH_FIELD > *  aFields, const wxString &  aFieldName, bool  aResolve = true  )

static

Definition at line 654 of file sim_model.cpp.

Referenced by Create(), SIM_LIB_MGR::CreateModel(), NETLIST_EXPORTER_SPICE::getNodePattern(), SPICE_GENERATOR_IBIS::IbisDevice(), InferSimModel(), DIALOG_SIM_MODEL< T >::loadLibrary(), ReadDataFields(), ReadTypeFromFields(), DIALOG_SIM_MODEL< T >::TransferDataFromWindow(), DIALOG_SIM_MODEL< T >::TransferDataToWindow(), and DIALOG_SIM_MODEL< T >::updateWidgets().

GetParam()

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

virtual

Reimplemented in SIM_MODEL_IBIS.

Definition at line 789 of file sim_model.cpp.

References GetParam(), 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_SERIALIZER::GenerateParams(), GetBaseParam(), SIM_PROPERTY::GetParam(), GetParam(), SIM_MODEL_IDEAL::GetTunerParam(), SIM_MODEL_SOURCE::GetTunerParam(), SPICE_GENERATOR_BEHAVIORAL::ItemLine(), SPICE_GENERATOR_IDEAL::ItemLine(), SPICE_GENERATOR_SOURCE::ItemLine(), SPICE_GENERATOR_RAW_SPICE::ItemName(), SPICE_GENERATOR::ItemParams(), SPICE_GENERATOR_L_MUTUAL::ItemParams(), SPICE_GENERATOR_RAW_SPICE::ItemParams(), SPICE_GENERATOR_SWITCH::ItemParams(), SPICE_GENERATOR::ModelLine(), DIALOG_SIM_MODEL< T >::newParamProperty(), SIM_MODEL_SERIALIZER::ParseParams(), SPICE_MODEL_PARSER::ReadModel(), SIM_MODEL_SUBCKT::SetBaseModel(), SIM_MODEL_NGSPICE::SetParamFromSpiceCode(), SIM_BOOL_PROPERTY::SIM_BOOL_PROPERTY(), SIM_MODEL_SPICE_FALLBACK::SIM_MODEL_SPICE_FALLBACK(), and DIALOG_SIM_MODEL< T >::updateBuiltinModelWidgets().

GetParamCount()

int SIM_MODEL::GetParamCount ( ) const

inline

Definition at line 481 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(), SIM_MODEL_SERIALIZER::GenerateParams(), SPICE_GENERATOR_SOURCE::ItemLine(), SPICE_GENERATOR::ItemParams(), SPICE_GENERATOR_L_MUTUAL::ItemParams(), SPICE_GENERATOR_RAW_SPICE::ItemParams(), SPICE_GENERATOR_SWITCH::ItemParams(), SPICE_GENERATOR::ModelLine(), 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

Definition at line 824 of file sim_model.cpp.

References m_params.

Referenced by TEST_SIM_LIBRARY_SPICE_FIXTURE::CompareToEmptyModel(), SIM_MODEL_SERIALIZER::GenerateParams(), and SIM_MODEL_SERIALIZER::GenerateValue().

GetPin()

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

inline

Definition at line 472 of file sim_model.h.

References m_modelPins.

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

GetPinCount()

int SIM_MODEL::GetPinCount ( ) const

inline

Definition at line 471 of file sim_model.h.

References m_modelPins.

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

GetPinNames()

virtual std::vector< std::string > SIM_MODEL::GetPinNames ( ) const

inlinevirtual

Reimplemented in SIM_MODEL_BEHAVIORAL, SIM_MODEL_IDEAL, SIM_MODEL_NGSPICE, SIM_MODEL_R_POT, SIM_MODEL_SOURCE, SIM_MODEL_SPICE_FALLBACK, SIM_MODEL_SWITCH, and SIM_MODEL_TLINE.

Definition at line 469 of file sim_model.h.

Referenced by createPins(), and SCH_FIELD::OnScintillaCharAdded().

GetPins()

std::vector< std::reference_wrapper< const SIM_MODEL_PIN > > SIM_MODEL::GetPins

(

)

const

Definition at line 748 of file sim_model.cpp.

References GetPin(), and GetPinCount().

Referenced by SIM_MODEL_SERIALIZER::GeneratePins(), SPICE_GENERATOR::GetPins(), SCH_EDIT_FRAME::RefreshOperatingPointDisplay(), SCH_SYMBOL::ResolveTextVar(), and SIM_MODEL_SUBCKT::SetBaseModel().

GetSpiceInfo()

SPICE_INFO SIM_MODEL::GetSpiceInfo ( ) const

inline

Definition at line 452 of file sim_model.h.

References GetType(), and SpiceInfo().

Referenced by TEST_SIM_LIBRARY_SPICE_FIXTURE::CompareToEmptyModel(), TEST_SIM_LIBRARY_SPICE_FIXTURE::CompareToUsualDiodeModel(), SPICE_GENERATOR_SOURCE::ItemLine(), SPICE_GENERATOR::ItemName(), SPICE_GENERATOR::ModelLine(), and TEST_SIM_LIBRARY_SPICE_FIXTURE::TestTransistor().

GetTunerParam()

virtual const PARAM * SIM_MODEL::GetTunerParam ( ) const

inlinevirtual

Reimplemented in SIM_MODEL_IDEAL, SIM_MODEL_R_POT, and SIM_MODEL_SOURCE.

Definition at line 484 of file sim_model.h.

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

GetType()

TYPE SIM_MODEL::GetType ( ) const

inline

Definition at line 464 of file sim_model.h.

References m_type.

Referenced by SIM_MODEL_NGSPICE::canSilentlyIgnoreParam(), TEST_SIM_LIBRARY_SPICE_FIXTURE::CompareToUsualDiodeModel(), Create(), SIM_MODEL_NGSPICE::getModelType(), SIM_MODEL_SPICE_FALLBACK::GetPinNames(), SPICE_GENERATOR_SWITCH::GetPins(), GetSpiceInfo(), SIM_MODEL_SOURCE::GetTunerParam(), GetTypeInfo(), SIM_MODEL_SOURCE::HasPrimaryValue(), SPICE_GENERATOR_IBIS::IbisDevice(), SPICE_GENERATOR_BEHAVIORAL::ItemLine(), SPICE_GENERATOR_SOURCE::ItemLine(), SPICE_GENERATOR_SWITCH::ItemLine(), SPICE_GENERATOR_TLINE::ModelLine(), 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

inline

Definition at line 461 of file sim_model.h.

References GetType(), and TypeInfo().

Referenced by SPICE_GENERATOR_NGSPICE::CurrentNames(), SIM_MODEL_SERIALIZER::GenerateDeviceSubtype(), GetDeviceType(), TEST_SIM_LIBRARY_SPICE_FIXTURE::TestTransistor(), and TUNER_SLIDER::TUNER_SLIDER().

HasAutofill()

virtual bool SIM_MODEL::HasAutofill ( ) const

inlinevirtual

Reimplemented in SIM_MODEL_SOURCE.

Definition at line 498 of file sim_model.h.

Referenced by SIM_MODEL_SERIALIZER::ParseParams(), and DIALOG_SIM_MODEL< T >::updateModelParamsTab().

HasPrimaryValue()

virtual bool SIM_MODEL::HasPrimaryValue ( ) const

inlinevirtual

Reimplemented in SIM_MODEL_IDEAL, SIM_MODEL_R_POT, and SIM_MODEL_SOURCE.

Definition at line 499 of file sim_model.h.

Referenced by SIM_MODEL_SERIALIZER::GenerateParams(), SIM_MODEL_SERIALIZER::ParseParams(), 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, SIM_VALUE_GRAMMAR::NOTATION  aNotation, wxString *  aDeviceType, wxString *  aModelType, wxString *  aModelParams, wxString *  aPinMap  )

static

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

Definition at line 1082 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, and SIM_VALUE_GRAMMAR::SPICE.

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

IsEnabled()

bool SIM_MODEL::IsEnabled ( ) const

inline

Definition at line 502 of file sim_model.h.

References m_isEnabled.

Referenced by SIM_MODEL_SERIALIZER::GenerateEnable().

IsStoredInValue()

bool SIM_MODEL::IsStoredInValue ( ) const

inline

Definition at line 509 of file sim_model.h.

References m_isStoredInValue.

Referenced by SIM_MODEL_SERIALIZER::GenerateParams(), and WriteFields().

MigrateSimModel()

template<typename T >

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

static

Definition at line 1412 of file sim_model.cpp.

References Create(), SIM_LIB_MGR::CreateModel(), DEFAULT_SIZE_TEXT, DeviceInfo(), SIM_MODEL::SPICE_INFO::functionName, SIM_MODEL_SERIALIZER::GeneratePins(), EDA_TEXT::GetAttributes(), SCH_FIELD::GetBoundingBox(), BOX2< Vec >::GetHeight(), EDA_TEXT::GetHorizJustify(), SCH_FIELD::GetPosition(), SCH_FIELD::GetShownText(), EDA_TEXT::GetText(), BOX2< Vec >::GetWidth(), GR_TEXT_H_ALIGN_RIGHT, WX_STRING_REPORTER::HasMessage(), EDA_IU_SCALE::IU_PER_MILS, KiROUND(), SIM_LIBRARY::MODEL::model, schIUScale, Serializer(), EDA_TEXT::SetAttributes(), SCH_FIELD::SetPosition(), SCH_FIELD::SetText(), 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(), TypeInfo(), and wxStringSplit().

operator=()

SIM_MODEL & SIM_MODEL::operator= ( SIM_MODEL &&  aOther )

delete

ReadDataFields()

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

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

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

ReadTypeFromFields()

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

static

Definition at line 390 of file sim_model.cpp.

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

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

requiresSpiceModelLine()

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

privatevirtual

Reimplemented in SIM_MODEL_IBIS, SIM_MODEL_RAW_SPICE, and SIM_MODEL_SWITCH.

Definition at line 1038 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_VALUE::ToDouble(), and SIM_MODEL::PARAM::value.

Referenced by SPICE_GENERATOR::ModelLine(), and SPICE_GENERATOR::ModelName().

Serializer()

const SIM_MODEL_SERIALIZER & SIM_MODEL::Serializer ( ) const

inline

Definition at line 436 of file sim_model.h.

References m_serializer.

Referenced by MigrateSimModel().

SetBaseModel()

void SIM_MODEL::SetBaseModel ( const SIM_MODEL &  aBaseModel )

virtual

Reimplemented in SIM_MODEL_IBIS, and SIM_MODEL_SUBCKT.

Definition at line 739 of file sim_model.cpp.

References GetType(), and 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  )

static

Definition at line 673 of file sim_model.cpp.

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

SetIsEnabled()

void SIM_MODEL::SetIsEnabled ( bool  aIsEnabled )

inline

Definition at line 501 of file sim_model.h.

References m_isEnabled.

Referenced by SIM_MODEL_SERIALIZER::ParseEnable().

SetIsStoredInValue()

void SIM_MODEL::SetIsStoredInValue ( bool  aIsStoredInValue )

inline

Definition at line 504 of file sim_model.h.

References HasPrimaryValue(), and m_isStoredInValue.

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

SetParamValue() [1/2]

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

Definition at line 880 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
	)

Definition at line 845 of file sim_model.cpp.

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

Referenced by SIM_MODEL_SOURCE::doSetParamValue(), SIM_BOOL_PROPERTY::OnSetValue(), SIM_MODEL_SERIALIZER::ParseParams(), SIM_MODEL_SERIALIZER::ParseValue(), SIM_MODEL_BEHAVIORAL::parseValueField(), SPICE_MODEL_PARSER::ReadModel(), SIM_MODEL_SPICE::SetParamFromSpiceCode(), SIM_MODEL_NGSPICE::SetParamFromSpiceCode(), SetParamValue(), SIM_STRING_PROPERTY::StringToValue(), DIALOG_SIM_MODEL< T >::TransferDataFromWindow(), and SIMULATOR_FRAME_UI::UpdateTunerValue().

SpiceGenerator()

const SPICE_GENERATOR & SIM_MODEL::SpiceGenerator ( ) const

inline

Definition at line 435 of file sim_model.h.

References m_spiceGenerator.

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 )

static

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 )

inlinevirtual

Reimplemented in SIM_MODEL_IBIS.

Definition at line 511 of file sim_model.h.

Referenced by ReadDataFields().

TypeInfo()

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

static

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

Definition at line 445 of file sim_model.cpp.

References IsStoredInValue(), m_serializer, MANDATORY_FIELDS, 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 Function Documentation

NETLIST_EXPORTER_SPICE

friend class NETLIST_EXPORTER_SPICE

friend

Definition at line 81 of file sim_model.h.

SPICE_GENERATOR

friend class SPICE_GENERATOR

friend

Definition at line 80 of file sim_model.h.

Member Data Documentation

m_baseModel

const SIM_MODEL* SIM_MODEL::m_baseModel

protected

Definition at line 540 of file sim_model.h.

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

m_isEnabled

bool SIM_MODEL::m_isEnabled

private

Definition at line 547 of file sim_model.h.

Referenced by IsEnabled(), and SetIsEnabled().

m_isStoredInValue

bool SIM_MODEL::m_isStoredInValue

private

Definition at line 548 of file sim_model.h.

Referenced by IsStoredInValue(), and SetIsStoredInValue().

m_modelPins

std::vector<SIM_MODEL_PIN> SIM_MODEL::m_modelPins

protected

Definition at line 539 of file sim_model.h.

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

m_params

std::vector<PARAM> SIM_MODEL::m_params

protected

Definition at line 538 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

protected

Definition at line 541 of file sim_model.h.

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

m_spiceGenerator

std::unique_ptr<SPICE_GENERATOR> SIM_MODEL::m_spiceGenerator

private

Definition at line 544 of file sim_model.h.

Referenced by SpiceGenerator().

m_type

const TYPE SIM_MODEL::m_type

private

Definition at line 546 of file sim_model.h.

Referenced by GetType(), and requiresSpiceModelLine().

---

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

• sim_model.h
• sim_model.cpp