PinPairModel

class pyedb.grpc.database.hierarchy.pin_pair_model.PinPairModel(component: pyedb.grpc.database.hierarchy.component.Component)

Manage pin-pair model.

Overview

Constructors

create

Create pin pair model. Pin pair model is defined between two pins, and it can be used to define the RLC model

Methods

set_rlc	Set RLC model for the pin pair.
delete_rlc	Delete RLC model for the pin pair.
add_pin_pair	Add a pin pair definition.

Properties

pin_pairs	Get all pin pairs.
is_null	Check if the pin pair model is null.
rlc	Retrieve RLC model given pin pair.

Attributes

core

Import detail

from pyedb.grpc.database.hierarchy.pin_pair_model import PinPairModel

Property detail

property PinPairModel.pin_pairs: list[PinPair]

Get all pin pairs.

Returns:

List[Tuple[str, str]]

List of pin pairs.

property PinPairModel.is_null: bool

Check if the pin pair model is null.

Returns:

bool

True if the pin pair model is null, False otherwise.

property PinPairModel.rlc: ansys.edb.core.utility.rlc.Rlc | None

Retrieve RLC model given pin pair.

If pin pair is not provided, the first pin pair will be used by default. If there is no pin pair, None will be returned.

Parameters:

pin_pairTuple[str, str], optional

Tuple of pin names (first_pin, second_pin). If not provided, the first pin pair will be used by default. If not provided and there is no pin pair, the first pin will be taken.

Returns:

CoreRlc

RLC model for the pin pair.

Attribute detail

PinPairModel.core

Method detail

classmethod PinPairModel.create(component: pyedb.grpc.database.hierarchy.component.Component, resistance: float | None = None, inductance: float | None = None, capacitance: float | None = None, pin1_name: str | None = None, pin2_name: str | None = None, is_parallel: bool = False) → PinPairModel

Create pin pair model. Pin pair model is defined between two pins, and it can be used to define the RLC model between two pins. Adding optional RLC values will enable the RLC model for the pin pair.

Parameters:

componentComponent

Edb instance.

resistancefloat, optional

Resistance value. If not provided, the default value will be used. Default value is 0.

inductancefloat, optional

Inductance value. If not provided, the default value will be used. Default value is 0.

capacitancefloat, optional

Capacitance value. If not provided, the default value will be used. Default value is 0.

pin1_namestr, optional

First pin name. If not provided, the default name will be used. Default name is 1.

pin2_namestr, optional

Second pin name. If not provided, the default name will be used. Default name is 2.

is_parallelbool, optional

Whether the RLC model is parallel. If not provided, the default value will be used

Returns:

PinPairModel

The created pin pair model.

PinPairModel.set_rlc(pin_pair: tuple[str, str], rlc: ansys.edb.core.utility.rlc.Rlc)

Set RLC model for the pin pair.

Parameters:

pin_pairTuple[str, str]

Tuple of pin names (first_pin, second_pin).

rlcCoreRlc

RLC model to set for the pin pair.

PinPairModel.delete_rlc(pin_pair: tuple[str, str])

Delete RLC model for the pin pair.

Parameters:

pin_pairTuple[str, str]

Tuple of pin names (first_pin, second_pin).

PinPairModel.add_pin_pair(r: float | None = None, l: float | None = None, c: float | None = None, r_enabled: bool | None = None, l_enabled: bool | None = None, c_enabled: bool | None = None, first_pin: str | None = None, second_pin: str | None = None, is_parallel: bool = False)

Add a pin pair definition.

Parameters:

r: float | None

l: float | None

c: float | None

r_enabled: bool

l_enabled: bool

c_enabled: bool

first_pin: str

second_pin: str

is_parallel: bool

Returns: