pyedb 0.37.0__py3-none-any.whl → 0.39.0__py3-none-any.whl

pyedb/grpc/database/definitions.py

@@ -0,0 +1,70 @@
+# 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 ansys.edb.core.geometry.polygon_data import PolygonData as GrpcPolygonData
+
+from pyedb.grpc.database.definition.component_def import ComponentDef
+from pyedb.grpc.database.definition.package_def import PackageDef
+
+
+class Definitions:
+    def __init__(self, pedb):
+        self._pedb = pedb
+
+    @property
+    def component(self):
+        """Component definitions"""
+        return {l.name: ComponentDef(self._pedb, l) for l in self._pedb.active_db.component_defs}
+
+    @property
+    def package(self):
+        """Package definitions."""
+        return {l.name: PackageDef(self._pedb, l) for l in self._pedb.active_db.package_defs}
+
+    def add_package_def(self, name, component_part_name=None, boundary_points=None):
+        """Add a package definition.
+
+        Parameters
+        ----------
+        name: str
+            Name of the package definition.
+        component_part_name : str, optional
+            Part name of the component.
+        boundary_points : list, optional
+            Boundary points which define the shape of the package.
+
+        Returns
+        -------
+
+        """
+        if not name in self.package:
+            package_def = PackageDef.create(self._pedb.active_db, name=name)
+            if component_part_name in self.component:
+                definition = self.component[component_part_name]
+                if not boundary_points and not definition.is_null:
+                    package_def.exterior_boundary = GrpcPolygonData(
+                        points=list(definition.components.values())[0].bounding_box
+                    )
+            if boundary_points:
+                package_def.exterior_boundary = GrpcPolygonData(points=boundary_points)
+            return PackageDef(self._pedb, package_def)
+        return False

pyedb/grpc/database/general.py

@@ -0,0 +1,43 @@
+# 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.
+
+"""
+This module contains EDB general methods and related methods.
+
+"""
+
+from __future__ import absolute_import  # noreorder
+
+import logging
+import re
+
+logger = logging.getLogger(__name__)
+
+
+def pascal_to_snake(s):
+    # Convert PascalCase to snake_case
+    return re.sub(r"(?<!^)(?=[A-Z])", "_", s).lower()
+
+
+def snake_to_pascal(s):
+    # Split the string at underscores and capitalize the first letter of each part
+    return "".join(word.capitalize() for word in s.split("_"))

pyedb/grpc/database/geometry/arc_data.py

@@ -0,0 +1,93 @@
+# 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 ansys.edb.core.geometry.arc_data import ArcData as GrpcArcData
+
+
+class ArcData(GrpcArcData):
+    """Class managing ArcData."""
+
+    def __init__(self, pedb, edb_object):
+        self._pedb = pedb
+        optional = {"height": edb_object.height, "direction": edb_object.direction}
+        super.__init__(edb_object.start, edb_object.end, optional)
+
+    @property
+    def center(self):
+        """Arc data center.
+
+        Returns
+        -------
+        [float, float]
+            [x value, y value]
+
+        """
+        return [self.center.x.value, self.center.y.value]
+
+    @property
+    def start(self):
+        """Arc data start point.
+
+        Returns
+        -------
+        [float, float]
+            [x value, y value]
+
+        """
+        return [self.start.x.value, self.start.y.value]
+
+    @property
+    def end(self):
+        """Arc data end point.
+
+        Returns
+        -------
+        [float, float]
+            [x value, y value]
+
+        """
+        return [self.end.x.value, self.end.y.value]
+
+    @property
+    def mid_point(self):
+        """Arc data mid point.
+
+        Returns
+        -------
+        [float, float]
+            [x value, y value]
+
+        """
+        return [self.midpoint.x.value, self.midpoint.y.value]
+
+    @property
+    def points(self):
+        """Arc data points.
+
+        Returns
+        -------
+        [[float, float]]
+            [[x value, y value]]
+
+        """
+        return [[pt.x.value, pt.y.value] for pt in self.points]

pyedb/grpc/database/geometry/point_3d_data.py

@@ -0,0 +1,79 @@
+# 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 ansys.edb.core.geometry.point3d_data import Point3DData as GrpcPoint3DData
+from ansys.edb.core.utility.value import Value as GrpcValue
+
+
+class Point3DData(GrpcPoint3DData):
+    """Point 3D Data."""
+
+    def __init__(self, x, y, z):
+        super().__init__(x, y, z)
+
+    @property
+    def x(self):
+        """X position.
+
+        Returns
+        -------
+        float
+            X position value.
+
+        """
+        return self.x.value
+
+    @x.setter
+    def x(self, value):
+        self.x = GrpcValue(value)
+
+    @property
+    def y(self):
+        """Y position.
+
+        Returns
+        -------
+        float
+            Y position value.
+
+        """
+        return self.y.value
+
+    @y.setter
+    def y(self, value):
+        self.y = GrpcValue(value)
+
+    @property
+    def z(self):
+        """Z position.
+
+        Returns
+        -------
+        float
+            Z position value.
+
+        """
+        return self.z.value
+
+    @z.setter
+    def z(self, value):
+        self.z = GrpcValue(value)

pyedb/grpc/database/geometry/point_data.py

@@ -0,0 +1,30 @@
+# 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 ansys.edb.core.geometry.point_data import PointData as GrpcPointData
+
+
+class PointData(GrpcPointData):
+    """Class managing :class:`Point Data <ansys.edb.core.geometry.point_data.PointData>`"""
+
+    def __init__(self, edb_object=None):
+        super().__init__(edb_object)

pyedb/grpc/database/geometry/polygon_data.py

@@ -0,0 +1,133 @@
+# 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 ansys.edb.core.geometry.point_data import PointData as GrpcPointData
+from ansys.edb.core.geometry.polygon_data import PolygonData as GrpcPolygonData
+
+from pyedb.grpc.database.geometry.arc_data import ArcData
+
+
+class PolygonData(GrpcPolygonData):
+    """Class managing Polygon Data."""
+
+    def __init__(
+        self,
+        pedb,
+        edb_object=None,
+        create_from_points=None,
+        create_from_circle=None,
+        create_from_rectangle=None,
+        create_from_bounding_box=None,
+        **kwargs,
+    ):
+        self._pedb = pedb
+        super().__init__()
+        if create_from_points:
+            self._edb_object = self.create_from_points(**kwargs)
+        elif create_from_circle:
+            x_center, y_center, radius = kwargs
+        elif create_from_rectangle:
+            x_lower_left, y_lower_left, x_upper_right, y_upper_right = kwargs
+        elif create_from_bounding_box:
+            self._edb_object = self.create_from_bounding_box(**kwargs)
+        else:  # pragma: no cover
+            self._edb_object = edb_object
+
+    @property
+    def bounding_box(self):
+        """Bounding box.
+
+        Returns
+        -------
+        List[float]
+            List of coordinates for the component's bounding box, with the list of
+            coordinates in this order: [X lower left corner, Y lower left corner,
+            X upper right corner, Y upper right corner].
+        """
+        bbox = self.bbox()
+        return [bbox[0].x.value, bbox[0].xyvalue, bbox[1].x.value, bbox[1].y.value]
+
+    @property
+    def arcs(self):
+        """Get the Primitive Arc Data.
+
+        Returns
+        -------
+        List[:class:`ArcData <pyedb.grpc.database.geometry.arc_data.ArcData>`]
+        """
+        arcs = [ArcData(self._pedb, i) for i in self.arc_data]
+        return arcs
+
+    @property
+    def points(self):
+        """Get all points in polygon.
+
+        Returns
+        -------
+        list[list[float]]
+        """
+        return [[i.x.value, i.y.value] for i in list(self.points)]
+
+    def create_from_points(self, points, closed=True):
+        list_of_point_data = []
+        for pt in points:
+            list_of_point_data.append(GrpcPointData(pt))
+        return PolygonData.create_from_points(points=list_of_point_data, closed=closed)
+
+    @staticmethod
+    def create_from_bounding_box(points):
+        """Create PolygonData from point list.
+
+        Returns
+        -------
+        :class:`PolygonData <pyedb.grpc.database.geometry.polygon_data.PolygonData>`
+
+        """
+        return PolygonData.create_from_bounding_box(points=points)
+
+    def expand(self, offset=0.001, tolerance=1e-12, round_corners=True, maximum_corner_extension=0.001):
+        """Expand the polygon shape by an absolute value in all direction.
+        Offset can be negative for negative expansion.
+
+        Parameters
+        ----------
+        offset : float, optional
+            Offset value in meters.
+        tolerance : float, optional
+            Tolerance in meters.
+        round_corners : bool, optional
+            Whether to round corners or not.
+            If True, use rounded corners in the expansion otherwise use straight edges (can be degenerate).
+        maximum_corner_extension : float, optional
+            The maximum corner extension (when round corners are not used) at which point the corner is clipped.
+
+        Returns
+        -------
+        bool
+
+        """
+        new_poly = self.expand(offset, tolerance, round_corners, maximum_corner_extension)
+        if not new_poly[0].points:
+            return False
+        self._edb_object = new_poly[0]
+        return True