pyedb 0.13.dev0__py3-none-any.whl → 0.15.dev0__py3-none-any.whl

pyedb/dotnet/edb_core/cell/primitive.py

@@ -25,7 +25,6 @@ from pyedb.dotnet.edb_core.cell.layout_obj import Connectable
 
 class Primitive(Connectable):
     """Manages EDB functionalities for a primitives.
-
     It inherits EDB Object properties.
 
     Examples
@@ -44,6 +43,21 @@ class Primitive(Connectable):
         self._core_net = pedb.nets
         self.primitive_object = self._edb_object
 
+        bondwire_type = self._pedb._edb.Cell.Primitive.BondwireType
+        self._bondwire_type = {
+            "invalid": bondwire_type.Invalid,
+            "apd": bondwire_type.ApdBondwire,
+            "jedec_4": bondwire_type.Jedec4Bondwire,
+            "jedec_5": bondwire_type.Jedec5Bondwire,
+            "num_of_bondwire_type": bondwire_type.NumOfBondwireType,
+        }
+        bondwire_cross_section_type = self._pedb._edb.Cell.Primitive.BondwireCrossSectionType
+        self._bondwire_cross_section_type = {
+            "invalid": bondwire_cross_section_type.Invalid,
+            "round": bondwire_cross_section_type.BondwireRound,
+            "rectangle": bondwire_cross_section_type.BondwireRectangle,
+        }
+
     @property
     def type(self):
         """Return the type of the primitive.
@@ -140,3 +154,187 @@ class Primitive(Connectable):
         list
         """
         return self._pedb.get_connected_objects(self._layout_obj_instance)
+
+
+class Bondwire(Primitive):
+    """Class representing a bondwire object."""
+
+    def __init__(self, pedb, edb_object=None, **kwargs):
+        super().__init__(pedb, edb_object)
+        if self._edb_object is None:
+            self._edb_object = self.__create(**kwargs)
+
+    def __create(self, **kwargs):
+        return self._pedb._edb.Cell.Primitive.Bondwire.Create(
+            self._pedb.modeler._edb_object,
+            kwargs.get("net"),
+            self._bondwire_type[kwargs.get("bondwire_type")],
+            kwargs.get("definition_name"),
+            kwargs.get("placement_layer"),
+            kwargs.get("width"),
+            kwargs.get("material"),
+            kwargs.get("start_context"),
+            kwargs.get("start_layer_name"),
+            kwargs.get("start_x"),
+            kwargs.get("start_y"),
+            kwargs.get("end_context"),
+            kwargs.get("end_layer_name"),
+            kwargs.get("end_x"),
+            kwargs.get("end_y"),
+        )
+
+    def get_material(self, evaluated=True):
+        """Get material of the bondwire.
+
+        Parameters
+        ----------
+        evaluated : bool, optional
+            True if an evaluated material name is wanted.
+
+        Returns
+        -------
+        str
+            Material name.
+        """
+        return self._edb_object.GetMaterial(evaluated)
+
+    def set_material(self, material):
+        """Set the material of a bondwire.
+
+        Parameters
+        ----------
+        material : str
+            Material name.
+        """
+        self._edb_object.SetMaterial(material)
+
+    @property
+    def type(self):
+        """:class:`BondwireType`: Bondwire-type of a bondwire object."""
+
+        type_name = self._edb_object.GetType()
+        return [i for i, j in self._bondwire_type.items() if j == type_name][0]
+
+    @type.setter
+    def type(self, bondwire_type):
+        self._edb_object.SetType(self._bondwire_type[bondwire_type])
+
+    @property
+    def cross_section_type(self):
+        """:class:`BondwireCrossSectionType`: Bondwire-cross-section-type of a bondwire object."""
+        cs_type = self._edb_object.GetCrossSectionType()
+        return [i for i, j in self._bondwire_cross_section_type.items() if j == cs_type][0]
+
+    @cross_section_type.setter
+    def cross_section_type(self, bondwire_type):
+        self._edb_object.SetCrossSectionType(self._bondwire_cross_section_type[bondwire_type])
+
+    @property
+    def cross_section_height(self):
+        """:class:`Value <ansys.edb.utility.Value>`: Bondwire-cross-section height of a bondwire object."""
+        return self._edb_object.GetCrossSectionHeight().ToDouble()
+
+    @cross_section_height.setter
+    def cross_section_height(self, height):
+        self._edb_object.SetCrossSectionHeight(self._pedb.edb_value(height))
+
+    def get_definition_name(self, evaluated=True):
+        """Get definition name of a bondwire object.
+
+        Parameters
+        ----------
+        evaluated : bool, optional
+            True if an evaluated (in variable namespace) material name is wanted.
+
+        Returns
+        -------
+        str
+            Bondwire name.
+        """
+        return self._edb_object.GetDefinitionName(evaluated)
+
+    def set_definition_name(self, definition_name):
+        """Set the definition name of a bondwire.
+
+        Parameters
+        ----------
+        definition_name : str
+            Bondwire name to be set.
+        """
+        self._edb_object.SetDefinitionName(definition_name)
+
+    def get_trajectory(self):
+        """Get trajectory parameters of a bondwire object.
+
+        Returns
+        -------
+        tuple[
+            :class:`Value <ansys.edb.utility.Value>`,
+            :class:`Value <ansys.edb.utility.Value>`,
+            :class:`Value <ansys.edb.utility.Value>`,
+            :class:`Value <ansys.edb.utility.Value>`
+        ]
+
+            Returns a tuple of the following format:
+
+            **(x1, y1, x2, y2)**
+
+            **x1** : X value of the start point.
+
+            **y1** : Y value of the start point.
+
+            **x1** : X value of the end point.
+
+            **y1** : Y value of the end point.
+        """
+        return [i.ToDouble() for i in self._edb_object.GetTrajectory() if not isinstance(i, bool)]
+
+    def set_trajectory(self, x1, y1, x2, y2):
+        """Set the parameters of the trajectory of a bondwire.
+
+        Parameters
+        ----------
+        x1 : :class:`Value <ansys.edb.utility.Value>`
+            X value of the start point.
+        y1 : :class:`Value <ansys.edb.utility.Value>`
+            Y value of the start point.
+        x2 : :class:`Value <ansys.edb.utility.Value>`
+            X value of the end point.
+        y2 : :class:`Value <ansys.edb.utility.Value>`
+            Y value of the end point.
+        """
+        values = [self._pedb.edb_value(i) for i in [x1, y1, x2, y2]]
+        self._edb_object.SetTrajectory(*values)
+
+    @property
+    def width(self):
+        """:class:`Value <ansys.edb.utility.Value>`: Width of a bondwire object."""
+        return self._edb_object.GetWidth().ToDouble()
+
+    @width.setter
+    def width(self, width):
+        self._edb_object.SetWidth(self._pedb.edb_value(width))
+
+    def set_start_elevation(self, layer, start_context=None):
+        """Set the start elevation of a bondwire.
+
+        Parameters
+        ----------
+        start_context : :class:`CellInstance <ansys.edb.hierarchy.CellInstance>`
+            Start cell context of the bondwire. None means top level.
+        layer : str or :class:`Layer <ansys.edb.layer.Layer>`
+            Start layer of the bondwire.
+        """
+        self._edb_object.SetStartElevation(start_context, layer)
+
+    def set_end_elevation(self, layer, end_context=None):
+        """Set the end elevation of a bondwire.
+
+        Parameters
+        ----------
+        end_context : :class:`CellInstance <ansys.edb.hierarchy.CellInstance>`
+            End cell context of the bondwire. None means top level.
+        layer : str or :class:`Layer <ansys.edb.layer.Layer>`
+            End layer of the bondwire.
+        """
+        self._edb_object.SetEndElevation(end_context, layer)

pyedb/dotnet/edb_core/cell/terminal/bundle_terminal.py

@@ -0,0 +1,52 @@
+# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+from pyedb.dotnet.edb_core.cell.terminal.edge_terminal import EdgeTerminal
+from pyedb.dotnet.edb_core.cell.terminal.terminal import Terminal
+
+
+class BundleTerminal(Terminal):
+    """Manages bundle terminal properties.
+
+    Parameters
+    ----------
+    pedb : pyedb.edb.Edb
+        EDB object from the ``Edblib`` library.
+    edb_object : Ansys.Ansoft.Edb.Cell.Terminal.BundleTerminal
+        BundleTerminal instance from EDB.
+    """
+
+    def __init__(self, pedb, edb_object):
+        super().__init__(pedb, edb_object)
+
+    @property
+    def terminals(self):
+        """Get terminals belonging to this excitation."""
+        return [EdgeTerminal(self._pedb, i) for i in list(self._edb_object.GetTerminals())]
+
+    @property
+    def name(self):
+        return self.terminals[0].name
+
+    def decouple(self):
+        """Ungroup a bundle of terminals."""
+        return self._edb_object.Ungroup()

pyedb/dotnet/edb_core/cell/terminal/edge_terminal.py

@@ -0,0 +1,50 @@
+# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+from pyedb.dotnet.edb_core.cell.terminal.terminal import Terminal
+from pyedb.dotnet.edb_core.general import convert_py_list_to_net_list
+
+
+class EdgeTerminal(Terminal):
+    def __init__(self, pedb, edb_object):
+        super().__init__(pedb, edb_object)
+
+    def couple_ports(self, port):
+        """Create a bundle wave port.
+
+        Parameters
+        ----------
+        port : :class:`dotnet.edb_core.ports.WavePort`, :class:`dotnet.edb_core.ports.GapPort`, list, optional
+            Ports to be added.
+
+        Returns
+        -------
+        :class:`dotnet.edb_core.ports.BundleWavePort`
+
+        """
+        if not isinstance(port, (list, tuple)):
+            port = [port]
+        temp = [self._edb_object]
+        temp.extend([i._edb_object for i in port])
+        edb_list = convert_py_list_to_net_list(temp, self._edb.cell.terminal.Terminal)
+        _edb_bundle_terminal = self._edb.cell.terminal.BundleTerminal.Create(edb_list)
+        return self._pedb.ports[self.name]

pyedb/dotnet/edb_core/cell/terminal/padstack_instance_terminal.py

@@ -0,0 +1,88 @@
+# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+from pyedb.dotnet.edb_core.cell.terminal.terminal import Terminal
+from pyedb.dotnet.edb_core.edb_data.padstacks_data import EDBPadstackInstance
+from pyedb.generic.general_methods import generate_unique_name
+
+
+class PadstackInstanceTerminal(Terminal):
+    """Manages bundle terminal properties."""
+
+    def __init__(self, pedb, edb_object):
+        super().__init__(pedb, edb_object)
+
+    @property
+    def position(self):
+        """Return terminal position.
+        Returns
+        -------
+        Position [x,y] : [float, float]
+        """
+        edb_padstack_instance = self._edb_object.GetParameters()
+        if edb_padstack_instance[0]:
+            return EDBPadstackInstance(edb_padstack_instance[1], self._pedb).position
+        return False
+
+    def create(self, padstack_instance, name=None, layer=None, is_ref=False):
+        """Create an edge terminal.
+
+        Parameters
+        ----------
+        prim_id : int
+            Primitive ID.
+        point_on_edge : list
+            Coordinate of the point to define the edge terminal.
+            The point must be on the target edge but not on the two
+            ends of the edge.
+        terminal_name : str, optional
+            Name of the terminal. The default is ``None``, in which case the
+            default name is assigned.
+        is_ref : bool, optional
+            Whether it is a reference terminal. The default is ``False``.
+
+        Returns
+        -------
+        Edb.Cell.Terminal.EdgeTerminal
+        """
+        if not name:
+            pin_name = padstack_instance._edb_object.GetName()
+            refdes = padstack_instance.component.refdes
+            name = "{}_{}".format(refdes, pin_name)
+            name = generate_unique_name(name)
+
+        if not layer:
+            layer = padstack_instance.start_layer
+
+        layer_obj = self._pedb.stackup.signal_layers[layer]
+
+        terminal = self._edb.cell.terminal.PadstackInstanceTerminal.Create(
+            self._pedb.active_layout,
+            padstack_instance.net.net_object,
+            name,
+            padstack_instance._edb_object,
+            layer_obj._edb_layer,
+            isRef=is_ref,
+        )
+        terminal = PadstackInstanceTerminal(self._pedb, terminal)
+
+        return terminal if not terminal.is_null else False

pyedb/dotnet/edb_core/cell/terminal/pingroup_terminal.py

@@ -0,0 +1,59 @@
+# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+from pyedb.dotnet.edb_core.cell.terminal.terminal import Terminal
+
+
+class PinGroupTerminal(Terminal):
+    """Manages pin group terminal properties."""
+
+    def __init__(self, pedb, edb_object=None):
+        super().__init__(pedb, edb_object)
+
+    def create(self, name, net_name, pin_group_name, is_ref=False):
+        """Create a pin group terminal.
+
+        Parameters
+        ----------
+        name : str
+            Name of the terminal.
+        net_name : str
+            Name of the net.
+        pin_group_name : str,
+            Name of the pin group.
+        is_ref : bool, optional
+            Whether it is a reference terminal. The default is ``False``.
+
+        Returns
+        -------
+        :class:`pyedb.dotnet.edb_core.edb_data.terminals.PinGroupTerminal`
+        """
+        net_obj = self._pedb.edb_api.cell.net.find_by_name(self._pedb.active_layout, net_name)
+        term = self._pedb.edb_api.cell.terminal.PinGroupTerminal.Create(
+            self._pedb.active_layout,
+            net_obj.api_object,
+            name,
+            self._pedb.siwave.pin_groups[pin_group_name]._edb_object,
+            is_ref,
+        )
+        term = PinGroupTerminal(self._pedb, term)
+        return term if not term.is_null else False

pyedb/dotnet/edb_core/cell/terminal/point_terminal.py

@@ -0,0 +1,73 @@
+# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+from pyedb.dotnet.edb_core.cell.terminal.terminal import Terminal
+
+
+class PointTerminal(Terminal):
+    """Manages point terminal properties."""
+
+    def __init__(self, pedb, edb_object=None):
+        super().__init__(pedb, edb_object)
+        self._pedb = pedb
+
+    def create(self, name, net, location, layer, is_ref=False):
+        """Create a point terminal.
+
+        Parameters
+        ----------
+        name : str
+            Name of the terminal.
+        net : str
+            Name of the net.
+        location : list
+            Location of the terminal.
+        layer : str
+            Name of the layer.
+        is_ref : bool, optional
+            Whether it is a reference terminal.
+
+        Returns
+        -------
+        :class:`pyedb.dotnet.edb_core.edb_data.terminals.PointTerminal`
+        """
+        terminal = self._pedb.edb_api.cell.terminal.PointTerminal.Create(
+            self._pedb.active_layout,
+            self._pedb.nets[net].net_object,
+            name,
+            self._pedb.point_data(*location),
+            self._pedb.stackup[layer]._edb_layer,
+            is_ref,
+        )
+        terminal = PointTerminal(self._pedb, terminal)
+        return terminal if not terminal.is_null else False
+
+    @property
+    def ref_terminal(self):
+        """Get reference terminal."""
+
+        terminal = Terminal(self._pedb, self._edb_object.GetReferenceTerminal())
+        return terminal if not terminal.is_null else False
+
+    @ref_terminal.setter
+    def ref_terminal(self, value):
+        self._edb_object.SetReferenceTerminal(value._edb_object)