Parameter Forms

Classes

class keysight.ads.de.db.CompoundForm

Bases: Form

CompoundForm is a type of Form for a parameter that contains one or more sub-parameters.

The CompoundForm describes how the parameter is netlisted and displayed. The Form for each sub-parameter describes how that portion of the parameter is netlisted and displayed. The number of sub-parameters is fixed by the parameter definition.

__init__(name: str, label: str = '', params: Sequence[ModelParam] = [], net_format: str = '', display_format: str = '', dialog_data: str = '') → None

add_parameter(parameter: ModelParam) → None

property parameters: NamedListRefAbc[ModelParam]

class keysight.ads.de.db.ConstForm

Bases: Form

A Form representing a fixed value, such as “Yes” or 1.

__init__(name: str, label: str | None = None, net_format: str | None = None, display_format: str | None = None, dialog_data: str = '') → None

class keysight.ads.de.db.Form

All parameter values are described by a Form that defines how the parameter is netlisted and displayed.

A Form must appear in the Formset of a parameter definition in order to be usable by that parameter. See Formset and class de.db.ModelParam.

property dialog_data: str

A string used by edit dialogs for this form.

If this string is empty, the name of the form will be used by default.

property discrete: bool

property display_format: str: The display format string for values using this form.

static is_compound_form(form: Form) → TypeGuard[CompoundForm]

static is_constant_form(form: Form) → TypeGuard[ConstForm]

static is_null_form(form: Form) → TypeGuard[NullForm]

static is_string_form(form: Form) → TypeGuard[StringForm]

property label: str: Short descriptive label of the Form.

property name: str: Unique name of the Form.

property net_format: str: The netlist format string for values using this form.

class keysight.ads.de.db.Formset

A Formset holds one or more Forms that define how a parameter is netlisted and displayed.

__init__(name: str, forms: Sequence[Form]) → None

contains(name: str) → bool: contains is deprecated, and will be removed in the 2025 Update 2 release. Use Formset.forms.find(name) is not None.

find_constant_form_by_label_or_display(label_or_display: str) → Form | None

find_form_by_label(label: str) → Form | None

find_form_by_name(name: str) → Form | None

property forms: NamedListRefAbc[Form]

property name: str

class keysight.ads.de.db.NullForm

Bases: Form

A Form representing a parameter with no value.

class keysight.ads.de.db.RepeatedForm

Bases: Form

RepeatedForm is the form used for a parameter that is repeatable.

All repeatable parameters share the same RepeatedForm.

class keysight.ads.de.db.StringForm

Bases: Form

A Form representing a value stored in a string.

__init__(name: str, label: str | None = None, net_format: str = '%v', display_format: str = '%v', dialog_data: str = '') → None

class keysight.ads.de.db.StringFormWithAELCallbacks: Bases: StringForm

class keysight.ads.de.db.StringFormWithCallbacks

Bases: StringForm

__init__(name: str, label: str | None = None, net_format: str = '%v', display_format: str = '%v', dialog_data: str = '', option_cb: Callable[[Design], list[str]] | None = None, valid_cb: Callable[[str], bool] | None = None, data_cb: Callable[[ParamItem, Design], list[str]] | None = None) → None

Functions

keysight.ads.de.db.global_model_lib() → ModelLib

db.model_lib A collection of global forms and formsets.

On this page