Parameters

Classes

class keysight.ads.de.db.AppParam

Bases: object

Holds the value for an application defined OAParam.

__init__(app_type: str, value: str | ndarray) → None

property app_type: str

set_value_from_string(value: str) → None

property value: ndarray

value_as_string() → str

class keysight.ads.de.db.ExpressionContext

Used for expression evaluation.

__init__()

clear_design_caches() → None: Clear all the caches for this design.

evaluate_expression(expr: str, *, clear_caches: bool = False) → str

Evaluate the expression in this expression context and return the result.

If clear_caches is True, clear all the caches for this design before evaluating.

property hierarchy_context: DesignHierarchy

property is_valid: bool: Returns True if the HierarchyContext is valid.

pop() → None

push_instance_for_reading(inst: InstanceDbu | InstanceUu) → None

setup_hierarchy_for_design(design: DesignDbu | DesignUu) → None

setup_hierarchy_for_layout_only(design: DesignDbu | DesignUu) → None

class keysight.ads.de.db.OAParam

OAParams are accessed by your artwork function when generating artwork for your Pcell.

They are also used to store properties and CDF parameters. See Design.pcell_parameters()

__init__(name: str, param_type: OAParamType, val: int | float | str | TimeParam | AppParam) → None

property name: str

string_value_from_app_type(app_type: str) → str

property type: OAParamType

property value: int | float | str | TimeParam | AppParam

value_from_list_app_type() → list

class keysight.ads.de.db.Param

Bases: ParamNonRepeated

A single-valued parameter with a value, netlist value, and display value.

property display_value: str

evaluate(expr_context: ExpressionContext) → bool | int | float | str: Evaluate this parameter value.

evaluate_no_expr() → str

Prepare this parameter value for use by removing quotes and evaluating units.

Does not support expressions. Will raise an exception if the value has an arithmetic expression or references other parameters or variables.

property netlist_value: str

property value: str

class keysight.ads.de.db.ParamBase

Base class that holds both a parameter item and its definition.

See ParamItem and de.db.ModelParam.

property definition: ModelParam | None

property display_value: str | list[str] | list[list[str]]

evaluate(expr_context: ExpressionContext) → bool | int | float | str | list[bool | int | float | str] | list[list[bool | int | float | str]]: Evaluate this parameter value.

evaluate_no_expr() → str | list[str] | list[list[str]]

Prepare this parameter value for use by removing quotes and evaluating units.

Does not support expressions. Will raise an exception if the value has an arithmetic expression or references other parameters or variables.

property form_name: str

static is_compound(p: ParamBase) → TypeGuard[ParamCompound]

static is_const(p: ParamBase) → TypeGuard[Param]

static is_null(p: ParamBase) → TypeGuard[Param]

static is_repeated(p: ParamBase) → TypeGuard[ParamRepeated]

static is_single_valued(p: ParamBase) → TypeGuard[Param]

static is_string(p: ParamBase) → TypeGuard[Param]

property item: ParamItem

static make_param(item: ParamItem, model_param: ModelParam | None) → ParamBase

property name: str

property netlist_value: str | list[str] | list[list[str]]

property no_plot: bool: When True, this parameter will not be displayed in schematic view.

property value: str | list[str] | list[list[str]]

class keysight.ads.de.db.ParamCompound

Bases: ParamNonRepeated

A parameter that consists of one or more sub-parameters.

The sub-parameters may be accessed via sub_params.

property display_value: list[str]

evaluate(expr_context: ExpressionContext) → list[bool | int | float | str]: Evaluate this compound parameter value.

evaluate_no_expr() → list[str]

Prepare this compound parameter value for use by removing quotes and evaluating units.

Does not support expressions. Will raise an exception if the value has an arithmetic expression or references other parameters or variables.

property fields: list[Param]

list(sub_params)

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

get_field(index: int) → Param

Return the sub-parameter at the specified index.

get_field is deprecated, and will be removed in the 2025 Update 2 release. Use: sub_params[index]

property netlist_value: list[str]

property num_fields: int

len(sub_params)

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

property sub_params: _SubParamCollection

property value: list[str]

class keysight.ads.de.db.ParamItem

Base class for parameter items.

See also de.db.ModelParam which is the parameter definition. The classes derived from ParamItem are used for default values in ModelParam and to hold instance and terminal parameter values.

__init__(unused: InvalidCall, *args, **kwargs) → None: Return an error about attempts to initialize objects that don’t support initialization.

clone() → ParamItem

property form_name: str

static is_compound(p: ParamItem) → TypeGuard[ParamItemCompound]

static is_const(p: ParamItem) → TypeGuard[ParamItemConst]

static is_null(p: ParamItem) → TypeGuard[ParamItemNull]

static is_repeated(p: ParamItem) → TypeGuard[ParamItemRepeated]

static is_string(p: ParamItem) → TypeGuard[ParamItemString]

property name: str

property no_plot: bool: When True, this parameter will not be displayed in schematic view.

class keysight.ads.de.db.ParamItemCompound

Bases: ParamItem

A parameter item that consists one or more sub-parameters.

The number of sub-parameters must match the number of sub-parameters on the compound form that is used to create the parameter definition.

__init__(param_name: str, form_name: str, subparams: Sequence[ParamItem]) → None

get_sub_parameter(index: int) → ParamItem: get_sub_parameter is deprecated, and will be removed in the 2025 Update 2 release. Use sub_params[index]

get_sub_parameters() → Sequence[ParamItem]: get_sub_parameters is deprecated, and will be removed in the 2025 Update 2 release. Use: list(sub_params)

property has_sub_parameters: bool

len(sub_params) > 0

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

property number_of_sub_parameters: int

len(sub_params)

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

property sub_params: IndexedSettableCollectionAbc[ParamItem]

property value: list[ParamItem]

sub_params

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

class keysight.ads.de.db.ParamItemConst

Bases: ParamItem

A parameter item whose value is determined by its form - (see de.db.ConstForm).

__init__(param_name: str) → None
__init__(param_name: str, form: str | Form) → None

class keysight.ads.de.db.ParamItemNull

Bases: ParamItem

A parameter item with no value.

__init__(param_name: str) → None

property value: None

class keysight.ads.de.db.ParamItemRepeated

Bases: ParamItem

A parameter item that holds a list of one or more repeats.

The parameter definition’s formset dictates the forms that can be used for each repeat. A repeat cannot also be repeated but may use compound forms, having their own sub-parameters.

__init__(param_name: str, repeats: Sequence[ParamItem]) → None

append_repeat(param: ParamItem) → None: append_repeat is deprecated, and will be removed in the 2025 Update 2 release. Use: repeats.append(param)

append_repeats(params: Sequence[ParamItem]) → None: append_repeats is deprecated, and will be removed in the 2025 Update 2 release. Use: repeats.append(params)

clear_and_set_repeats(parameters: Sequence[ParamItem]) → None: clear_and_set_repeats is deprecated, and will be removed in the 2025 Update 2 release. Use: repeats = parameters

clear_and_set_single_repeat(parameter: ParamItem) → None: clear_and_set_single_repeat is deprecated, and will be removed in the 2025 Update 2 release. Use: repeats = parameter

extract_repeat(index: int) → ParamItem: extract_repeat is deprecated, and will be removed in the 2025 Update 2 release. Use: repeats.pop(index)

get_repeat(index: int) → ParamItem: get_repeat is deprecated, and will be removed in the 2025 Update 2 release. Use: repeats[index]

get_repeats() → Sequence[ParamItem]: get_repeats is deprecated, and will be removed in the 2025 Update 2 release. Use: list(repeats)

property has_repeats: bool

len(repeats) > 0

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

insert_repeat(index: int, param: ParamItem) → None: insert_repeat is deprecated, and will be removed in the 2025 Update 2 release. Use: repeats.insert(index, param)

property number_of_repeats: int

len(repeats)

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

property repeats: _RepeatParamItemCollection

property value: list[ParamItem]

list(repeats)

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

class keysight.ads.de.db.ParamItemString

Bases: ParamItem

A string-valued parameter item.

__init__(param_name: str) → None
__init__(param_name: str, form: str | Form, param_value: str) → None

property value: str

class keysight.ads.de.db.ParamIter

An iterator that can be used to visit parameters of an instance or terminal.

__init__(owner: InstanceDbu | InstanceUu) → None
__init__(owner: TermBaseDbu | TermBaseUu) → None

property definition: ModelParam

property is_valid: bool

property item: ParamItem

property value: ParamBase

class keysight.ads.de.db.ParamNonRepeated

Bases: ParamBase

Non-repeated parameters are either Param or ParamCompound.

__init__(unused: InvalidCall, *args, **kwargs) → None: Return an error about attempts to initialize objects that don’t support initialization.

property display_value: str | list[str]

evaluate(expr_context: ExpressionContext) → bool | int | float | str | list[bool | int | float | str]: Evaluate this parameter value.

evaluate_no_expr() → str | list[str]

Prepare this parameter value for use by removing quotes and evaluating units.

Does not support expressions. Will raise an exception if the value has an arithmetic expression or references other parameters or variables.

property netlist_value: str | list[str]

property value: str | list[str]

class keysight.ads.de.db.ParamRepeated

Bases: ParamBase

A parameter that is essentially a vector of parameters of the same definition.

The repeats of a repeated parameter must be non-repeating. There must always be at least one repeat.

append_repeat(value: str | Sequence[str]) → None: append_repeat is deprecated, and will be removed in the 2025 Update 2 release. Use: repeats.append(value)

delete_repeat(index: int) → None: delete_repeat is deprecated, and will be removed in the 2025 Update 2 release. Use: repeats.remove(index)

property display_value: list[str] | list[list[str]]

evaluate(expr_context: ExpressionContext) → list[bool | int | float | str] | list[list[bool | int | float | str]]: Evaluate this repeated parameter value.

evaluate_no_expr() → str | list[str] | list[list[str]]

Prepare this repeated parameter value for use by removing quotes and evaluating units.

Does not support expressions. Will raise an exception if the value has an arithmetic expression or references other parameters or variables.

get_repeat(index: int) → ParamNonRepeated: get_repeat is deprecated, and will be removed in the 2025 Update 2 release. Use: repeats[index]

insert_repeat(index: int, value: str | Sequence[str]) → None: insert_repeat is deprecated, and will be removed in the 2025 Update 2 release. Use: repeats.insert(index, value)

property netlist_value: list[str] | list[list[str]]

property num_repeats: int

len(repeats)

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

property repeats: _RepeatParamCollection

property value: list[str] | list[list[str]]

class keysight.ads.de.db.TimeParam

__init__(time: int) → None

property time: int

Enumerated Types

class keysight.ads.de.db.ModelParamType

REAL = 'real'

STRING = 'string'

INT = 'int'

COMPLEX = 'complex'

REAL_ARRAY = 'realArray'

INT_ARRAY = 'intArray'

STRING_ARRAY = 'stringArray'

COMPLEX_ARRAY = 'complexArray'

FIXED_POINT = 'fixed'

FIXED_POINT_ARRAY = 'fixedArray'

PRECISION_STRING = 'precision'

UNSPECIFIED = 'unspecified'

class keysight.ads.de.db.ModelUnitType

STRING = 'string'

NO_UNIT = 'num'

FREQUENCY = 'freq'

RESISTANCE = 'res'

CONDUCTANCE = 'cond'

INDUCTANCE = 'ind'

CAPACITANCE = 'cap'

LENGTH = 'lng'

TIME = 'time'

ANGLE = 'ang'

POWER = 'power'

VOLTAGE = 'volt'

CURRENT = 'cur'

DISTANCE = 'dist'

TEMPERATURE = 'temp'

DB_GAIN = 'dbg'

DATARATE = 'datarate'

PERCENT = 'pct'

class keysight.ads.de.db.OAParamType

The type of an OAParam.

INT = <OAParamType.INT: 0>

FLOAT = <OAParamType.FLOAT: 1>

STRING = <OAParamType.STRING: 2>

APP_PARAM = <OAParamType.APP_PARAM: 3>: Application defined parameter holding typed data.

DOUBLE = <OAParamType.DOUBLE: 4>

BOOLEAN = <OAParamType.BOOLEAN: 5>

TIME = <OAParamType.TIME: 6>

Functions

keysight.ads.de.db.add_variable_to_var_instance(instance: InstanceDbu | InstanceUu, name: str, value: str) → None

keysight.ads.de.db.compound_param(form_name: str, sub_params: Sequence[ParamItemString | ParamItemConst]) → ParamItemCompound

keysight.ads.de.db.const_param(form: str | Form) → ParamItemConst

keysight.ads.de.db.get_ui_indexed_parameter_ui_string(instance: InstanceDbu | InstanceUu, index: int) → str

keysight.ads.de.db.make_compound_param(form_name: str, sub_params: Sequence[ParamItem]) → ParamItemCompound: make_compound_param is deprecated, and will be removed in the 2025 Update 2 release. Use: compound_param

keysight.ads.de.db.make_const_param(form: str | Form) → ParamItemConst: make_const_param is deprecated, and will be removed in the 2025 Update 2 release. Use: const_param

keysight.ads.de.db.make_repeated_param(repeats: Sequence[ParamItem]) → ParamItemRepeated: make_repeated_param is deprecated, and will be removed in the 2025 Update 2 release. Use: repeated_param

keysight.ads.de.db.make_string_param(form: str | Form, value: str) → ParamItemString: make_string_param is deprecated, and will be removed in the 2025 Update 2 release. Use: string_param or std_string_param

keysight.ads.de.db.repeated_param(repeats: Sequence[ParamItemString | ParamItemConst | ParamItemCompound]) → ParamItemRepeated

keysight.ads.de.db.std_string_param(value: str) → ParamItemString: Make a ParamItemString using the StdForm.

keysight.ads.de.db.string_param(form: str | Form, value: str) → ParamItemString

keysight.ads.de.db.update_pcell_params_and_maybe_relocate_in_layout(instance: InstanceDbu | InstanceUu, hierarchy_context: DesignHierarchy) → None

On this page