ControlFileStackup#

class pyedb.grpc.database.utility.xml_control_file.ControlFileStackup(units='mm')#

Class that manages the Stackup info.

Overview#

add_material

Add a new material with specific properties.

add_layer

Add a new layer.

add_dielectric

Add a new dielectric.

add_via

Add a new via layer.

vias

Via list.

materials

Material list.

dielectrics

Dielectric layer list.

layers

Layer list.

Import detail#

from pyedb.grpc.database.utility.xml_control_file import ControlFileStackup

Property detail#

property ControlFileStackup.vias#

Via list.

Returns:
list of pyedb.dotnet.database.edb_data.control_file.ControlFileVia
property ControlFileStackup.materials#

Material list.

Returns:
list of pyedb.dotnet.database.edb_data.control_file.ControlFileMaterial
property ControlFileStackup.dielectrics#

Dielectric layer list.

Returns:
list of pyedb.dotnet.database.edb_data.control_file.ControlFileLayer
property ControlFileStackup.layers#

Layer list.

Returns:
list of pyedb.dotnet.database.edb_data.control_file.ControlFileLayer

Attribute detail#

ControlFileStackup.units = 'mm'#
ControlFileStackup.metal_layer_snapping_tolerance = None#
ControlFileStackup.dielectrics_base_elevation = 0#

Method detail#

ControlFileStackup.add_material(material_name, permittivity=1.0, dielectric_loss_tg=0.0, permeability=1.0, conductivity=0.0, properties=None)#

Add a new material with specific properties.

Parameters:
material_namestr

Material name.

permittivityfloat, optional

Material permittivity. The default is 1.0.

dielectric_loss_tgfloat, optional

Material tangent losses. The default is 0.0.

permeabilityfloat, optional

Material permeability. The default is 1.0.

conductivityfloat, optional

Material conductivity. The default is 0.0.

propertiesdict, optional

Specific material properties. The default is None. Dictionary with key and material property value.

Returns:
pyedb.dotnet.database.edb_data.control_file.ControlFileMaterial
ControlFileStackup.add_layer(layer_name, elevation=0.0, material='', gds_type=0, target_layer='', thickness=0.0, layer_type='conductor', solve_inside=True, properties=None)#

Add a new layer.

Parameters:
layer_namestr

Layer name.

elevationfloat

Layer elevation.

materialstr

Material for the layer.

gds_typeint

GDS type assigned on the layer. The value must be the same as in the GDS file otherwise geometries won’t be imported.

target_layerstr

Layer name assigned in EDB or HFSS 3D layout after import.

thicknessfloat

Layer thickness

layer_typestr

Define the layer type, default value for a layer is "conductor"

solve_insidebool

When True solver will solve inside metal, and not id False. Default value is True.

propertiesdict

Dictionary with key and property value.

Returns:
pyedb.dotnet.database.edb_data.control_file.ControlFileLayer
ControlFileStackup.add_dielectric(layer_name, layer_index=None, material='', thickness=0.0, properties=None, base_layer=None, add_on_top=True)#

Add a new dielectric.

Parameters:
layer_namestr

Layer name.

layer_indexint, optional

Dielectric layer index as they must be stacked. If not provided the layer index will be incremented.

materialstr

Material name.

thicknessfloat

Layer thickness.

propertiesdict

Dictionary with key and property value.

base_layerstr, optional

Layer name used for layer placement. Default value is None. This option is used for inserting dielectric layer between two existing ones. When no argument is provided the dielectric layer will be placed on top of the stacked ones.

methodbool, Optional.

Provides the method to use when the argument base_layer is provided. When True the layer is added on top on the base layer, when False it will be added below.

Returns:
pyedb.dotnet.database.edb_data.control_file.ControlFileDielectric
ControlFileStackup.add_via(layer_name, material='', gds_type=0, target_layer='', start_layer='', stop_layer='', solve_inside=True, via_group_method='proximity', via_group_tol=1e-06, via_group_persistent=True, snap_via_group_method='distance', snap_via_group_tol=1e-08, properties=None)#

Add a new via layer.

Parameters:
layer_namestr

Layer name.

materialstr

Define the material for this layer.

gds_typeint

Define the gds type.

target_layerstr

Target layer used after layout import in EDB and HFSS 3D layout.

start_layerstr

Define the start layer for the via

stop_layerstr

Define the stop layer for the via.

solve_insidebool

When True solve inside this layer is anbled. Default value is True.

via_group_methodstr

Define the via group method, default value is "proximity"

via_group_tolfloat

Define the via group tolerance.

via_group_persistentbool

When True activated otherwise when False``is deactivated. Default value is ``True.

snap_via_group_methodstr

Define the via group method, default value is "distance"

snap_via_group_tolfloat

Define the via group tolerance, default value is 10e-9.

propertiesdict

Dictionary with key and property value.

Returns:
pyedb.dotnet.database.edb_data.control_file.ControlFileVia