KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
SIM_MODEL::PARAM::INFO Struct Reference

#include <sim_model.h>

Public Member Functions

 INFO (const std::string &aName="", unsigned aId=0, DIR aDir=DIR_INOUT, SIM_VALUE::TYPE aType=SIM_VALUE::TYPE_FLOAT, const std::string &aUnit="", CATEGORY aCategory=CATEGORY::PRINCIPAL, const std::string &aDefaultValue="", const std::string &legacy_unused_value="", const std::string &aDescription="", bool aIsSpiceInstanceParam=false, bool aIsInstanceParam=false, const std::string &aSpiceModelName="", const std::string &aSpiceInstanceName="", std::vector< std::string > aEnumValues={})
 
bool Matches (const std::string &aName) const
 

Public Attributes

std::string name
 
unsigned id
 
DIR dir
 
SIM_VALUE::TYPE type
 
std::string unit
 
CATEGORY category
 
std::string defaultValue
 
std::string description
 
bool isSpiceInstanceParam
 
bool isInstanceParam
 
std::string spiceModelName
 
std::string spiceInstanceName
 
std::vector< std::string > enumValues
 

Detailed Description

Definition at line 343 of file sim_model.h.

Constructor & Destructor Documentation

◆ INFO()

SIM_MODEL::PARAM::INFO::INFO ( const std::string &  aName = "",
unsigned  aId = 0,
DIR  aDir = DIR_INOUT,
SIM_VALUE::TYPE  aType = SIM_VALUE::TYPE_FLOAT,
const std::string &  aUnit = "",
CATEGORY  aCategory = CATEGORY::PRINCIPAL,
const std::string &  aDefaultValue = "",
const std::string &  legacy_unused_value = "",
const std::string &  aDescription = "",
bool  aIsSpiceInstanceParam = false,
bool  aIsInstanceParam = false,
const std::string &  aSpiceModelName = "",
const std::string &  aSpiceInstanceName = "",
std::vector< std::string >  aEnumValues = {} 
)
inline

Definition at line 345 of file sim_model.h.

Member Function Documentation

◆ Matches()

bool SIM_MODEL::PARAM::INFO::Matches ( const std::string &  aName) const

Definition at line 794 of file sim_model.cpp.

References name.

Referenced by SIM_MODEL::PARAM::Matches().

Member Data Documentation

◆ category

CATEGORY SIM_MODEL::PARAM::INFO::category

Definition at line 381 of file sim_model.h.

Referenced by DIALOG_SIM_MODEL< T_symbol, T_field >::addParamPropertyIfRelevant(), SIM_MODEL_SOURCE::appendAcParamInfos(), SIM_MODEL_SOURCE::appendSpParamInfos(), SIM_MODEL_SERIALIZER::generateParamValuePair(), SIM_MODEL_SOURCE::makeBurstNoiseParamInfos(), SIM_MODEL_SOURCE::makeDcParamInfos(), SIM_MODEL_KIBIS::makeDcWaveformParamInfos(), SIM_MODEL_SOURCE::makeExpParamInfos(), SIM_MODEL_L_MUTUAL::makeParamInfos(), SIM_MODEL_R_POT::makeParamInfos(), SIM_MODEL_RAW_SPICE::makeParamInfos(), SIM_MODEL_KIBIS::makeParamInfos(), SIM_MODEL_SOURCE::makePinkNoiseParamInfos(), SIM_MODEL_KIBIS::makePrbsWaveformParamInfos(), SIM_MODEL_SOURCE::makePulseParamInfos(), SIM_MODEL_SOURCE::makePwlParamInfos(), SIM_MODEL_SOURCE::makeRandomExpParamInfos(), SIM_MODEL_SOURCE::makeRandomNormalParamInfos(), SIM_MODEL_SOURCE::makeRandomPoissonParamInfos(), SIM_MODEL_SOURCE::makeRandomUniformParamInfos(), SIM_MODEL_KIBIS::makeRectWaveformParamInfos(), SIM_MODEL_TLINE::makeRlgcParamInfos(), SIM_MODEL_SOURCE::makeSinParamInfos(), SIM_MODEL_SWITCH::makeSwIParamInfos(), SIM_MODEL_SWITCH::makeSwVParamInfos(), SIM_MODEL_SOURCE::makeWhiteNoiseParamInfos(), SIM_MODEL_TLINE::makeZ0ParamInfos(), SIM_MODEL_NGSPICE::SetParamFromSpiceCode(), SIM_MODEL_NGSPICE::SIM_MODEL_NGSPICE(), and TEST_SIM_LIBRARY_SPICE_FIXTURE::TestTransistor().

◆ defaultValue

std::string SIM_MODEL::PARAM::INFO::defaultValue

Definition at line 382 of file sim_model.h.

Referenced by SIM_MODEL::AddParam(), SIM_MODEL_SOURCE::appendAcParamInfos(), SIM_MODEL_SOURCE::appendSpParamInfos(), SIM_MODEL_SOURCE::makeBurstNoiseParamInfos(), SIM_MODEL_SOURCE::makeDcParamInfos(), SIM_MODEL_KIBIS::makeDcWaveformParamInfos(), SIM_MODEL_SOURCE::makeExpParamInfos(), SIM_MODEL_L_MUTUAL::makeParamInfos(), SIM_MODEL_R_POT::makeParamInfos(), SIM_MODEL_RAW_SPICE::makeParamInfos(), SIM_MODEL_KIBIS::makeParamInfos(), SIM_MODEL_SOURCE::makePinkNoiseParamInfos(), SIM_MODEL_KIBIS::makePrbsWaveformParamInfos(), SIM_MODEL_SOURCE::makePulseParamInfos(), SIM_MODEL_SOURCE::makePwlParamInfos(), SIM_MODEL_SOURCE::makeRandomExpParamInfos(), SIM_MODEL_SOURCE::makeRandomNormalParamInfos(), SIM_MODEL_SOURCE::makeRandomPoissonParamInfos(), SIM_MODEL_SOURCE::makeRandomUniformParamInfos(), SIM_MODEL_KIBIS::makeRectWaveformParamInfos(), SIM_MODEL_TLINE::makeRlgcParamInfos(), SIM_MODEL_SOURCE::makeSinParamInfos(), SIM_MODEL_SWITCH::makeSwIParamInfos(), SIM_MODEL_SWITCH::makeSwVParamInfos(), SIM_MODEL_SOURCE::makeWhiteNoiseParamInfos(), SIM_MODEL_TLINE::makeZ0ParamInfos(), and DIALOG_SIM_MODEL< T_symbol, T_field >::newParamProperty().

◆ description

std::string SIM_MODEL::PARAM::INFO::description

Definition at line 383 of file sim_model.h.

Referenced by SIM_MODEL_SOURCE::appendAcParamInfos(), SIM_MODEL_SOURCE::appendSpParamInfos(), SIM_MODEL_SOURCE::makeBurstNoiseParamInfos(), SIM_MODEL_SOURCE::makeCcParamInfos(), SIM_MODEL_SOURCE::makeDcParamInfos(), SIM_MODEL_KIBIS::makeDcWaveformParamInfos(), SIM_MODEL_SOURCE::makeExpParamInfos(), SIM_MODEL_IDEAL::makeParamInfo(), SIM_MODEL_L_MUTUAL::makeParamInfos(), SIM_MODEL_R_POT::makeParamInfos(), SIM_MODEL_RAW_SPICE::makeParamInfos(), SIM_MODEL_KIBIS::makeParamInfos(), SIM_MODEL_BEHAVIORAL::makeParams(), SIM_MODEL_SOURCE::makePinkNoiseParamInfos(), SIM_MODEL_KIBIS::makePrbsWaveformParamInfos(), SIM_MODEL_SOURCE::makePulseParamInfos(), SIM_MODEL_SOURCE::makePwlParamInfos(), SIM_MODEL_SOURCE::makeRandomExpParamInfos(), SIM_MODEL_SOURCE::makeRandomNormalParamInfos(), SIM_MODEL_SOURCE::makeRandomPoissonParamInfos(), SIM_MODEL_SOURCE::makeRandomUniformParamInfos(), SIM_MODEL_KIBIS::makeRectWaveformParamInfos(), SIM_MODEL_TLINE::makeRlgcParamInfos(), SIM_MODEL_SOURCE::makeSinParamInfos(), SIM_MODEL_SWITCH::makeSwIParamInfos(), SIM_MODEL_SWITCH::makeSwVParamInfos(), SIM_MODEL_SOURCE::makeVcParamInfos(), SIM_MODEL_SOURCE::makeWhiteNoiseParamInfos(), SIM_MODEL_TLINE::makeZ0ParamInfos(), DIALOG_SIM_MODEL< T_symbol, T_field >::newParamProperty(), and DIALOG_SIM_MODEL< T_symbol, T_field >::updateBuiltinModelWidgets().

◆ dir

DIR SIM_MODEL::PARAM::INFO::dir

Definition at line 378 of file sim_model.h.

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

◆ enumValues

std::vector<std::string> SIM_MODEL::PARAM::INFO::enumValues

Definition at line 388 of file sim_model.h.

Referenced by SIM_MODEL::AddParam(), SIM_MODEL_KIBIS::makeDcWaveformParamInfos(), SIM_MODEL_KIBIS::makeParamInfos(), SIM_MODEL_SWITCH::makeSwIParamInfos(), SIM_MODEL_SWITCH::makeSwVParamInfos(), DIALOG_SIM_MODEL< T_symbol, T_field >::newParamProperty(), and SIM_ENUM_PROPERTY::SIM_ENUM_PROPERTY().

◆ id

unsigned SIM_MODEL::PARAM::INFO::id

Definition at line 377 of file sim_model.h.

Referenced by SIM_MODEL_SOURCE::makeCcParamInfos(), SIM_MODEL_SOURCE::makeVcParamInfos(), and SIM_MODEL_NGSPICE::SetParamFromSpiceCode().

◆ isInstanceParam

bool SIM_MODEL::PARAM::INFO::isInstanceParam

Definition at line 385 of file sim_model.h.

Referenced by SIM_MODEL_TLINE::makeRlgcParamInfos(), and SIM_MODEL_TLINE::makeZ0ParamInfos().

◆ isSpiceInstanceParam

bool SIM_MODEL::PARAM::INFO::isSpiceInstanceParam

Definition at line 384 of file sim_model.h.

Referenced by SIM_MODEL_L_MUTUAL::makeParamInfos(), SIM_MODEL_RAW_SPICE::makeParamInfos(), SIM_MODEL_TLINE::makeRlgcParamInfos(), SIM_MODEL_SWITCH::makeSwIParamInfos(), SIM_MODEL_SWITCH::makeSwVParamInfos(), SIM_MODEL_TLINE::makeZ0ParamInfos(), SIM_MODEL::requiresSpiceModelLine(), and SIM_MODEL_NGSPICE::SetParamFromSpiceCode().

◆ name

std::string SIM_MODEL::PARAM::INFO::name

Definition at line 376 of file sim_model.h.

Referenced by SIM_MODEL_SOURCE::appendAcParamInfos(), SIM_MODEL_SOURCE::appendSpParamInfos(), TEST_SIM_LIBRARY_SPICE_FIXTURE::CompareToEmptyModel(), SIM_MODEL_SERIALIZER::generateParamValuePair(), SIM_MODEL_SOURCE::makeBurstNoiseParamInfos(), SIM_MODEL_SOURCE::makeCcParamInfos(), SIM_MODEL_SOURCE::makeDcParamInfos(), SIM_MODEL_KIBIS::makeDcWaveformParamInfos(), SIM_MODEL_SOURCE::makeExpParamInfos(), SIM_MODEL_L_MUTUAL::makeParamInfos(), SIM_MODEL_R_POT::makeParamInfos(), SIM_MODEL_RAW_SPICE::makeParamInfos(), SIM_MODEL_KIBIS::makeParamInfos(), SIM_MODEL_SOURCE::makePinkNoiseParamInfos(), SIM_MODEL_KIBIS::makePrbsWaveformParamInfos(), SIM_MODEL_SOURCE::makePulseParamInfos(), SIM_MODEL_SOURCE::makePwlParamInfos(), SIM_MODEL_SOURCE::makeRandomExpParamInfos(), SIM_MODEL_SOURCE::makeRandomNormalParamInfos(), SIM_MODEL_SOURCE::makeRandomPoissonParamInfos(), SIM_MODEL_SOURCE::makeRandomUniformParamInfos(), SIM_MODEL_KIBIS::makeRectWaveformParamInfos(), SIM_MODEL_TLINE::makeRlgcParamInfos(), SIM_MODEL_SOURCE::makeSinParamInfos(), SIM_MODEL_SWITCH::makeSwIParamInfos(), SIM_MODEL_SWITCH::makeSwVParamInfos(), SIM_MODEL_SOURCE::makeVcParamInfos(), SIM_MODEL_SOURCE::makeWhiteNoiseParamInfos(), SIM_MODEL_TLINE::makeZ0ParamInfos(), Matches(), DIALOG_SIM_MODEL< T_symbol, T_field >::newParamProperty(), SIM_MODEL_KIBIS::SIM_MODEL_KIBIS(), DIALOG_SIM_MODEL< T_symbol, T_field >::updateBuiltinModelWidgets(), and SIMULATOR_FRAME_UI::UpdateTunerValue().

◆ spiceInstanceName

std::string SIM_MODEL::PARAM::INFO::spiceInstanceName

Definition at line 387 of file sim_model.h.

◆ spiceModelName

std::string SIM_MODEL::PARAM::INFO::spiceModelName

Definition at line 386 of file sim_model.h.

Referenced by SIM_MODEL_KIBIS::makeParamInfos(), SIM_MODEL_SWITCH::makeSwIParamInfos(), and SIM_MODEL_SWITCH::makeSwVParamInfos().

◆ type

SIM_VALUE::TYPE SIM_MODEL::PARAM::INFO::type

Definition at line 379 of file sim_model.h.

Referenced by SIM_MODEL_SOURCE::appendAcParamInfos(), SIM_MODEL_SOURCE::appendSpParamInfos(), SIM_MODEL_SOURCE::makeBurstNoiseParamInfos(), SIM_MODEL_SOURCE::makeCcParamInfos(), SIM_MODEL_SOURCE::makeDcParamInfos(), SIM_MODEL_KIBIS::makeDcWaveformParamInfos(), SIM_MODEL_SOURCE::makeExpParamInfos(), SIM_MODEL_L_MUTUAL::makeParamInfos(), SIM_MODEL_R_POT::makeParamInfos(), SIM_MODEL_RAW_SPICE::makeParamInfos(), SIM_MODEL_KIBIS::makeParamInfos(), SIM_MODEL_SOURCE::makePinkNoiseParamInfos(), SIM_MODEL_KIBIS::makePrbsWaveformParamInfos(), SIM_MODEL_SOURCE::makePulseParamInfos(), SIM_MODEL_SOURCE::makePwlParamInfos(), SIM_MODEL_SOURCE::makeRandomExpParamInfos(), SIM_MODEL_SOURCE::makeRandomNormalParamInfos(), SIM_MODEL_SOURCE::makeRandomPoissonParamInfos(), SIM_MODEL_SOURCE::makeRandomUniformParamInfos(), SIM_MODEL_KIBIS::makeRectWaveformParamInfos(), SIM_MODEL_TLINE::makeRlgcParamInfos(), SIM_MODEL_SOURCE::makeSinParamInfos(), SIM_MODEL_SWITCH::makeSwIParamInfos(), SIM_MODEL_SWITCH::makeSwVParamInfos(), SIM_MODEL_SOURCE::makeVcParamInfos(), SIM_MODEL_SOURCE::makeWhiteNoiseParamInfos(), SIM_MODEL_TLINE::makeZ0ParamInfos(), DIALOG_SIM_MODEL< T_symbol, T_field >::newParamProperty(), and TEST_SIM_LIBRARY_SPICE_FIXTURE::TestTransistor().

◆ unit

std::string SIM_MODEL::PARAM::INFO::unit

Definition at line 380 of file sim_model.h.

Referenced by SIM_MODEL_SOURCE::appendAcParamInfos(), SIM_MODEL_SOURCE::appendSpParamInfos(), SIM_MODEL_SOURCE::makeBurstNoiseParamInfos(), SIM_MODEL_SOURCE::makeCcParamInfos(), SIM_MODEL_SOURCE::makeDcParamInfos(), SIM_MODEL_KIBIS::makeDcWaveformParamInfos(), SIM_MODEL_SOURCE::makeExpParamInfos(), SIM_MODEL_L_MUTUAL::makeParamInfos(), SIM_MODEL_R_POT::makeParamInfos(), SIM_MODEL_RAW_SPICE::makeParamInfos(), SIM_MODEL_KIBIS::makeParamInfos(), SIM_MODEL_SOURCE::makePinkNoiseParamInfos(), SIM_MODEL_KIBIS::makePrbsWaveformParamInfos(), SIM_MODEL_SOURCE::makePulseParamInfos(), SIM_MODEL_SOURCE::makePwlParamInfos(), SIM_MODEL_SOURCE::makeRandomExpParamInfos(), SIM_MODEL_SOURCE::makeRandomNormalParamInfos(), SIM_MODEL_SOURCE::makeRandomPoissonParamInfos(), SIM_MODEL_SOURCE::makeRandomUniformParamInfos(), SIM_MODEL_KIBIS::makeRectWaveformParamInfos(), SIM_MODEL_TLINE::makeRlgcParamInfos(), SIM_MODEL_SOURCE::makeSinParamInfos(), SIM_MODEL_SWITCH::makeSwIParamInfos(), SIM_MODEL_SWITCH::makeSwVParamInfos(), SIM_MODEL_SOURCE::makeVcParamInfos(), SIM_MODEL_SOURCE::makeWhiteNoiseParamInfos(), SIM_MODEL_TLINE::makeZ0ParamInfos(), and DIALOG_SIM_MODEL< T_symbol, T_field >::newParamProperty().

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