Model Definition

Classes

class keysight.ads.de.db.ModelDef

A model definition implemented in Python.

__init__(name: str, label: str) → None

Construct a ModelDef.

Parameters:

name (str) – The name of the item, for a cell definition, this is the cell name
label (str) – Display label, e.g. “Resistor”

class keysight.ads.de.db.ModelDefAEL: A model definition implemented in AEL.

class keysight.ads.de.db.ModelDefBase

A model definition, sometimes referred to as an item definition or component definition, contains the parameter definitions for a particular component or design.

append_parameter(parameter: ModelParam) → None: append_parameter is deprecated, and will be removed in the 2025 Update 2 release. Use: parameters.append(name)

property callbacks: ListRefAbc[ModelCbBase]: Return the collection of callbacks in this model definition.

property component_name: str

delete_parameter(index: int) → None: delete_parameter is deprecated, and will be removed in the 2025 Update 2 release. Use: del(parameters[index])

static find_model_def(libOrCell: Library, cellName: str) → ModelDefBase | None
static find_model_def(libOrCell: Cell) → ModelDefBase | None

property has_model_param: bool

A model definition with has_model_param set to True will netlist the first parameter as the model name.

See the Model Definition Properties section in the ADS Python Design Environment documentation.

insert_parameter(parameter: ModelParam, index: int) → None: insert_parameter is deprecated, and will be removed in the 2025 Update 2 release. Use: parameters.insert(index, parameter)

property inst_name_prefix: str

property is_bom_item: bool

property is_custom_variable: bool

property is_ground: bool

property is_smart_component: bool

property is_sub_design: bool

property is_transmission_line: bool

property is_unique: bool: Only one instance of this model is allowed in a design.

property is_variable: bool

property label: str

property legacy_dialog_data: str

property legacy_dialog_name: str

property library_name: str

property name: str

property parameters: NamedListRefAbc[ModelParam]

Return the collection of parameter definitions in this model definition.

A parameter definition may be accessed by using the [] operator. Use parameters.find to find a parameter by name.

class keysight.ads.de.db.ModelParam

ModelParam is a parameter definition that is a part of a model definition (see de.db.ModelDef).

Parameter values have associated forms (see de.db.Form). The allowed forms for a given parameter are listed in its formset (see de.db.Formset)

Initialize a ModelParam.

Parameters:

name (str) – Name of the parameter
label (str) – Descriptive label for the parameter
formset (Formset) – A Formset is a list of one or more Form that describe how the parameter is stored, how it is netlisted and how it is displayed on a schematic If not specified, the global StdFormSet will be used.
unit_type (Optional[ModelUnitType]) – The units of the parameter, defaults to NO_UNIT (plain numbers)
param_type (Optional[ModelParamType]) – The datatype of the parameter value, defaults to REAL

property callbacks: ListRefAbc[ModelCbBase]: Return the collection of callbacks in this parameter definition.

property default_value: ParamItem | None

find_parameter_form(param: ParamItem) → Form | None: find_parameter_form is deprecated, and will be removed in the 2025 Update 2 release. Use: formset.forms.find(param.form_name)

find_parameter_form_by_name(name: str) → Form | None: find_parameter_form_by_name is deprecated, and will be removed in the 2025 Update 2 release. Use: formset.forms.find(name)

property forms: Sequence[Form]

formset.forms

Type:: forms is deprecated, and will be removed in the 2025 Update 2 release. Use

property formset: Formset

get_default_value_copy(design: Design, model_definition: ModelDefBase) → ParamItem: Get a copy of the default value, invoking the callback if one exists.

property is_constant: bool

property is_design_name: bool

property is_discrete_value: bool

property is_displayed_by_default: bool

property is_doe: bool

property is_editable: bool

property is_evaluated: bool

property is_ignored_by_pcell: bool

property is_netlist_rhs_only: bool

property is_netlistable: bool

property is_not_netlisted_at_definition: bool

property is_on_screen_editable: bool

property is_optimizable: bool

property is_repeated: bool

property is_statistical: bool

property label: str

property name: str

property param_type: ModelParamType

property unit_type: ModelUnitType

On this page