Layout

class pyedb.grpc.database.layout.layout.Layout(pedb, core: ansys.edb.core.layout.layout.Layout)

Bases: PrimitivesQuery

Manage Layout class.

Overview

Methods

refresh_cache	Refresh the layout cache.
clear_cache	Clear the layout cache.
find_padstack_instances	Finds padstack instances matching the specified criteria.
convert_primitives_to_vias	Convert a list of primitives into vias or pins.

Properties

layout_instance
use_cache	bool: Enable or disable layout caching.
terminals	Get terminals belonging to active layout.
nets	Nets.
groups	Groups
coordinate_systems	Coordinate systems.
pin_groups	Pin groups.
net_classes	Net classes.
extended_nets	Extended nets.
differential_pairs	Differential pairs.
padstack_instances	Get all padstack instances in a list.
voltage_regulators	Voltage regulators.

Attributes

core

Import detail

from pyedb.grpc.database.layout.layout import Layout

Property detail

property Layout.layout_instance: Any

property Layout.use_cache

bool: Enable or disable layout caching.

When enabled, caches padstack instances and primitives for faster access.

property Layout.terminals: list[pyedb.grpc.database.terminal.pingroup_terminal.PinGroupTerminal | pyedb.grpc.database.terminal.padstack_instance_terminal.PadstackInstanceTerminal | pyedb.grpc.database.terminal.edge_terminal.EdgeTerminal | pyedb.grpc.database.terminal.bundle_terminal.BundleTerminal | pyedb.grpc.database.terminal.point_terminal.PointTerminal]

Get terminals belonging to active layout.

Returns:

Terminal dictionaryDict[str, Terminal]

Dictionary of terminals.

property Layout.nets: list[pyedb.grpc.database.net.net.Net]

Nets.

Returns:

List[Net]

List of Net.

property Layout.groups: list[pyedb.grpc.database.hierarchy.component.Component]

Groups

Returns:

List[Group].

List of Component.

property Layout.coordinate_systems

Coordinate systems.

Returns:

List[Group]

List of coordinate systems.

property Layout.pin_groups: list[pyedb.grpc.database.hierarchy.pingroup.PinGroup]

Pin groups.

Returns:

List[PinGroup]

List of PinGroup.

property Layout.net_classes: list[pyedb.grpc.database.net.net_class.NetClass]

Net classes.

Returns:

List[NetClass]

List of NetClass.

property Layout.extended_nets: list[pyedb.grpc.database.net.extended_net.ExtendedNet]

Extended nets.

Returns:

List[ExtendedNet]

List of extended nets.

property Layout.differential_pairs: list[pyedb.grpc.database.net.differential_pair.DifferentialPair]

Differential pairs.

Returns:

List[DifferentialPair

List of DifferentialPair.

property Layout.padstack_instances: list[pyedb.grpc.database.primitive.padstack_instance.PadstackInstance]

Get all padstack instances in a list.

property Layout.voltage_regulators: list[pyedb.grpc.database.layout.voltage_regulator.VoltageRegulator]

Voltage regulators.

List[VoltageRegulator.

List of VoltageRegulator.

Attribute detail

Layout.core

Method detail

Layout.refresh_cache()

Refresh the layout cache.

Caches padstack instances and primitives from the core object.

Layout.clear_cache()

Clear the layout cache.

Clears cached padstack instances and primitives.

Layout.find_padstack_instances(aedt_name: str | List[str] = None, component_name: str | List[str] = None, component_pin_name: str | List[str] = None, net_name: str | List[str] = None, instance_id: int | List[int] = None) → List

Finds padstack instances matching the specified criteria.

This method filters the available padstack instances based on specified attributes such as aedt_name, component_name, component_pin_name, net_name, or instance_id. Criteria can be passed as individual values or as a list of values. If no padstack instances match the criteria, an error is raised.

Parameters:

aedt_nameUnion[str, List[str]], optional

Name(s) of the AEDT padstack instance(s) to filter.

component_nameUnion[str, List[str]], optional

Name(s) of the component(s) to filter padstack instances by.

component_pin_nameUnion[str, List[str]], optional

Name(s) of the component pin(s) to filter padstack instances by.

net_nameUnion[str, List[str]], optional

Name(s) of the net(s) to filter padstack instances by.

instance_idUnion[int, List[int]], optional

ID(s) of the padstack instance(s) to filter.

Returns:

List

A list of padstack instances matching the specified criteria.

Layout.convert_primitives_to_vias(primitives: list[pyedb.grpc.database.primitive.primitive.Primitive], is_pins: bool = False)

Convert a list of primitives into vias or pins.

Parameters:

primitivesList[Primitive]

List of primitives to convert.

is_pinsbool, optional

If True, convert to pins; otherwise, convert to vias. Default is False.