CDF

CDF module contains the API for interoperable components.

Classes

class keysight.ads.de.experimental.cdf.CDFBase
__init__(unused: InvalidCall, *args, **kwargs) → None

Return an error about attempts to initialize objects that don’t support initialization.

add_param(param: ParamDef) → None
delete_param(index: int) → None
property done_proc: str
find_param(name: str) → ParamDef | None
find_sim_info(sim_name: str) → SimInfo | None
find_view_info(view_name: str) → ViewInfo | None
property form_init_proc: str
insert_param(param: ParamDef, index: int) → None
property num_params: int
param(id_: int) → ParamDef
param(id_: str) → ParamDef
property params: NamedItemCollectionAbc[ParamDef]
sim_info(sim_name: str) → SimInfo
view_info(view_name: str) → ViewInfo
class keysight.ads.de.experimental.cdf.CellCDF

Bases: ManagedCDF

__init__(unused: InvalidCall, *args, **kwargs) → None

Return an error about attempts to initialize objects that don’t support initialization.

property cell: Cell
property library: Library
class keysight.ads.de.experimental.cdf.InstanceParams

Supports editing parameter values for interoperable instances.

__init__(inst_or_design: Instance | Instance, cdf: 'CellCDF' | None = None) → None
__init__(inst_or_design: Design | Design, cdf: CellCDF) → None
property cell_cdf: CellCDF
execute_callback(id_: ParamDef) → None
execute_callback(id_: str) → None
find_param(param_name: str) → Parameter | None
find_param_def(param_name: str) → ParamDef | None
property instance_dbu: Instance | None
property instance_uu: Instance | None
property is_modified: bool
param(id_: ParamDef) → Parameter
param(id_: str) → Parameter
param_def(param_name: str) → ParamDef
param_value(id_: ParamDef) → bool | int | float | str
param_value(id_: str) → bool | int | float | str
param_value_no_default(id_: ParamDef) → bool | int | float | str | None
param_value_no_default(id_: str) → bool | int | float | str | None
property params: NamedItemCollectionAbc[Parameter]
property parent_design_dbu: Design
property parent_design_uu: Design
reset_to_defaults() → None
set_param_value(id_: ParamDef, value: bool | int | float | str) → None
set_param_value(id_: str, value: bool | int | float | str) → None

Set the parameter value and call the callback if one exists.

set_param_value_no_callback(id_: ParamDef, value: bool | int | float | str) → None
set_param_value_no_callback(id_: str, value: bool | int | float | str) → None

Set the parameter value without calling any callback.

update_instance(inst: Instance | Instance | None) → None

Assign all the modified parameter values to the instance.

class keysight.ads.de.experimental.cdf.LibraryCDF

Bases: ManagedCDF

__init__(unused: InvalidCall, *args, **kwargs) → None

Return an error about attempts to initialize objects that don’t support initialization.

property library: Library
class keysight.ads.de.experimental.cdf.ManagedCDF

Bases: CDFBase

__init__(unused: InvalidCall, *args, **kwargs) → None

Return an error about attempts to initialize objects that don’t support initialization.

property library_name: str
class keysight.ads.de.experimental.cdf.ParamDef
__init__(name: str, param_type: ParamType) → None
property callback: str
change_type(param_type: ParamType) → None

Change the type of a parameter. This may require changing the default value.

property choices: list[str]
property default_oa_param: OAParam

Mainly for testing. Use default_value.

property default_value: bool | int | float | str
property display_condition: str
property dont_save_condition: str
property editable_condition: str
property has_callback: bool
property has_choices: bool
property name: str
property param_type: ParamType
property parse_as_cel: bool | None
property parse_as_cel_expr: str | None
property parse_as_number: bool | None
property parse_as_number_expr: str | None
property prompt: str
set_choices(choices: str) → None
property store_default: bool | None
property store_default_expr: str | None
property units: ParamUnits
property use_condition: str
class keysight.ads.de.experimental.cdf.ScratchCDF

Bases: CDFBase

__init__() → None
class keysight.ads.de.experimental.cdf.SimInfo
__init__(name: str) → None
cdf_name_from_sim_param_name(sim_param_name: str) → str
property comp_name: str
property inst_parameters: list[str]
is_cdf_param_in_inst_parameters(cdf_param_name: str) → bool
is_cdf_param_in_other_parameters(cdf_param_name: str) → bool
property is_empty: bool
property netlist_procedure: str
property other_parameters: list[str]
property prop_mapping: dict[str, str]
set_prop_mapping(prop_mapping: str) → None
set_term_mapping(term_mapping: str) → None
set_term_order(term_order: str) → None
property sim_name: str
sim_term_name_from_term_name(term_name: str) → str
property term_mapping: dict[str, str]
property term_order: list[str]
class keysight.ads.de.experimental.cdf.ViewInfo
__init__(name: str) → None
cdf_name_from_sim_param_name(sim_param_name: str) → str
property inst_parameters: list[str]
is_cdf_param_in_parameters(cdf_param_name: str) → bool
property is_empty: bool
property module_name: str
property netlist_procedure: str
property parameters: list[str]
property prop_mapping: dict[str, str]
set_prop_mapping(prop_mapping: str) → None
set_term_mapping(term_mapping: str) → None
set_term_order(term_order: str) → None
sim_term_name_from_term_name(term_name: str) → str
property term_mapping: dict[str, str]
property term_order: list[str]
property view_name: str

Enumerated Types

class keysight.ads.de.experimental.cdf.ParamType

Bases: Enum

The type of a CDF Parameter - determines how values are stored.

UNKNOWN = <ParamType.UNKNOWN: -1>
STRING = <ParamType.STRING: 0>
INT = <ParamType.INT: 1>
FLOAT = <ParamType.FLOAT: 2>
RADIO = <ParamType.RADIO: 3>

Has choices - stored as a string.

CYCLIC = <ParamType.CYCLIC: 4>

Has choices - stored as a string.

BOOLEAN = <ParamType.BOOLEAN: 5>

Should be True/False, but stored as an int.

BUTTON = <ParamType.BUTTON: 6>

Not stored as a value.

NETSET = <ParamType.NETSET: 7>

Not stored as a value. Used for net connections.

class keysight.ads.de.experimental.cdf.ParamUnits

Bases: Enum

The units used for a CDF Parameter.

UNKNOWN = <ParamUnits.UNKNOWN: -1>
RESISTANCE = <ParamUnits.RESISTANCE: 0>
CAPACITANCE = <ParamUnits.CAPACITANCE: 1>
INDUCTANCE = <ParamUnits.INDUCTANCE: 2>
CONDUCTANCE = <ParamUnits.CONDUCTANCE: 3>
TIME = <ParamUnits.TIME: 4>
FREQUENCY = <ParamUnits.FREQUENCY: 5>
POWER = <ParamUnits.POWER: 6>
POWER_DB = <ParamUnits.POWER_DB: 7>
LENGTH = <ParamUnits.LENGTH: 8>
LENGTH_ENGLISH = <ParamUnits.LENGTH_ENGLISH: 9>
ANGLE = <ParamUnits.ANGLE: 10>
VOLTAGE = <ParamUnits.VOLTAGE: 11>
CURRENT = <ParamUnits.CURRENT: 12>
TEMPERATURE = <ParamUnits.TEMPERATURE: 13>

Functions

keysight.ads.de.experimental.cdf.cell_cdf(lib_or_cell: Library | Cell, cell_name: str | None = None) → CellCDF
keysight.ads.de.experimental.cdf.find_cell_cdf(lib_or_cell: Library, cell_name: str) → CellCDF | None
keysight.ads.de.experimental.cdf.find_cell_cdf(lib_or_cell: Cell) → CellCDF | None
keysight.ads.de.experimental.cdf.find_library_cdf(lib: Library) → LibraryCDF | None
keysight.ads.de.experimental.cdf.library_cdf(lib: Library) → LibraryCDF
On this page