ControlFileBoundaries#

class pyedb.grpc.database.control_file.ControlFileBoundaries(units: str = 'um')#

Manages boundaries for the control file.

Parameters:
unitsstr, optional

Length units. Default is “um”.

Overview#

add_port

Add a port.

add_extent

Add an extent.

ports

extents

circuit_models

circuit_elements

units

Import detail#

from pyedb.grpc.database.control_file import ControlFileBoundaries

Attribute detail#

ControlFileBoundaries.ports: Dict[str, ControlCircuitPt]#
ControlFileBoundaries.extents: List[ControlExtent] = []#
ControlFileBoundaries.circuit_models: Dict[str, Any]#
ControlFileBoundaries.circuit_elements: Dict[str, Any]#
ControlFileBoundaries.units: str = 'um'#

Method detail#

ControlFileBoundaries.add_port(name: str, x1: float, y1: float, layer1: str, x2: float, y2: float, layer2: str, z0: float = 50) → ControlCircuitPt#

Add a port.

Parameters:
namestr

Port name.

x1float

X-coordinate of first point.

y1float

Y-coordinate of first point.

layer1str

Layer of first point.

x2float

X-coordinate of second point.

y2float

Y-coordinate of second point.

layer2str

Layer of second point.

z0float, optional

Characteristic impedance. Default is 50.

Returns:
ControlCircuitPt

Created port object.

ControlFileBoundaries.add_extent(type: str = 'bbox', dieltype: str = 'bbox', diel_hactor: float = 0.25, airbox_hfactor: float = 0.25, airbox_vr_p: float = 0.25, airbox_vr_n: float = 0.25, useradiation: bool = True, honor_primitives: bool = True, truncate_at_gnd: bool = True) → ControlExtent#

Add an extent.

Parameters:
typestr, optional

Extent type. Default is “bbox”.

dieltypestr, optional

Dielectric extent type. Default is “bbox”.

diel_hactorfloat, optional

Dielectric horizontal factor. Default is 0.25.

airbox_hfactorfloat, optional

Airbox horizontal factor. Default is 0.25.

airbox_vr_pfloat, optional

Airbox vertical factor (positive). Default is 0.25.

airbox_vr_nfloat, optional

Airbox vertical factor (negative). Default is 0.25.

useradiationbool, optional

Use radiation boundary. Default is True.

honor_primitivesbool, optional

Honor primitives. Default is True.

truncate_at_gndbool, optional

Truncate at ground. Default is True.

Returns:
ControlExtent

Created extent object.