ComponentDef

class pyedb.grpc.database.definition.component_def.ComponentDef(pedb, edb_object)

Manages EDB functionalities for component definitions.

Parameters:

edb_objectobject

Edb ComponentDef Object

Overview

Constructors

find	Find component definition by name.
create	Create a new component definition.

Methods

assign_rlc_model	Assign RLC to all components under this part name.
assign_s_param_model	Assign S-parameter to all components under this part name.
assign_spice_model	Assign Spice model to all components under this part name.
add_n_port_model	Add N-port model.
get_properties
set_properties

Properties

part_name	Component definition name.
type	Component definition type.
components	Component instances belonging to the definition.
is_null	Check if the component definition is null.
component_pins	Component pins.
reference_file	Model reference file.
component_models	Component models.
name	Component definition name.

Attributes

core

Import detail

from pyedb.grpc.database.definition.component_def import ComponentDef

Property detail

property ComponentDef.part_name: str

Component definition name.

Returns:

str

Component part name.

property ComponentDef.type: str

Component definition type.

Returns:

str

Component definition type.

property ComponentDef.components: dict[str, pyedb.grpc.database.hierarchy.component.Component]

Component instances belonging to the definition.

Returns:

dict[str, Component]

property ComponentDef.is_null: bool

Check if the component definition is null.

Returns:

bool

True if the component definition is null, False otherwise.

property ComponentDef.component_pins: list[pyedb.grpc.database.definition.component_pin.ComponentPin]

Component pins.

Returns:

list[ComponentPin]

property ComponentDef.reference_file: list[str]

Model reference file.

Returns:

list[str]

List of reference files.

property ComponentDef.component_models

Component models.

Returns:

list[ComponentModel]

property ComponentDef.name

Component definition name.

Returns:

str

Component definition name.

Attribute detail

ComponentDef.core

Method detail

classmethod ComponentDef.find(edb, name)

Find component definition by name.

Parameters:

edbpyedb.grpc.edb.Edb

EDB database object.

namestr

Component definition name.

Returns:

ComponentDef or None

classmethod ComponentDef.create(edb, name, fp=None)

Create a new component definition.

Parameters:

edbpyedb.grpc.edb.Edb

EDB database object.

namestr

Component definition name.

fpstr, optional

Footprint cell name.

Returns:

ComponentDef

ComponentDef.assign_rlc_model(res=None, ind=None, cap=None, is_parallel=False) → bool

Assign RLC to all components under this part name.

Parameters:

resint, float

Resistance. Default is None.

indint, float

Inductance. Default is None.

capint, float

Capacitance. Default is None.

is_parallelbool, optional

Whether it is parallel or series RLC component.

Returns:

bool

ComponentDef.assign_s_param_model(file_path, model_name=None, reference_net=None) → bool

Assign S-parameter to all components under this part name.

Parameters:

file_pathstr

File path of the S-parameter model.

model_namestr, optional

Name of the S-parameter model.

reference_netstr, optional

Name of the reference net.

Returns:

bool

ComponentDef.assign_spice_model(file_path, model_name=None) → bool

Assign Spice model to all components under this part name.

Parameters:

file_pathstr

File path of the Spice model.

model_namestr, optional

Name of the Spice model.

Returns:

bool

ComponentDef.add_n_port_model(fpath, name=None)

Add N-port model.

Returns:

Nport modelNPortComponentModel

ComponentDef.get_properties()

ComponentDef.set_properties(**kwargs)