Merge branch 'main' into F511_dm_part_1_0

Author: drewm102

CONTRIBUTORS.md

@@ -6,6 +6,11 @@
 
 ## Individual Contributors
 
+* [amruta3991](https://github.com/amruta3991)
+* [apasarka](https://github.com/apasarka)
+* [asamaiya](https://github.com/asamaiya)
+* [chenchienjacklin](https://github.com/chenchienjacklin)
+* [drewm102](https://github.com/drewm102)
 * [Hiroki](https://github.com/hiro727)
 * [Isaac Waldron](https://github.com/isaacwaldron)
 * [Karan Bhagat](https://github.com/kbhagat-ansys)
@@ -14,11 +19,6 @@
 * [Roberto Pastor Muela](https://github.com/RobPasMue)
 * [SitaRamesh](https://github.com/SitaRamesh)
 * [SriniSundararajan](https://github.com/SriniSundararajan)
-* [Sébastien Morais](https://github.com/SMoraisAnsys)
-* [amruta3991](https://github.com/amruta3991)
-* [apasarka](https://github.com/apasarka)
-* [asamaiya](https://github.com/asamaiya)
-* [chenchienjacklin](https://github.com/chenchienjacklin)
-* [drewm102](https://github.com/drewm102)
 * [svandenb-dev](https://github.com/svandenb-dev)
+* [Sébastien Morais](https://github.com/SMoraisAnsys)
 * [vamartid](https://github.com/vmartidis)

doc/source/api/simulation_setup.rst

@@ -36,6 +36,7 @@ Classes
    simulation_setup.FreqSweepType
    simulation_setup.HFSSRegionComputeResource
    simulation_setup.InterpolatingSweepData
+   simulation_setup.FrequencyData
    raptor_x_simulation_settings.RaptorXSimulationSettings
    raptor_x_simulation_settings.RaptorXGeneralSettings
    raptor_x_simulation_settings.RaptorXAdvancedSettings
@@ -71,6 +72,7 @@ Enums
    :toctree: _autosummary
 
       simulation_setup.SimulationSetupType
+      simulation_setup.Distribution
       hfss_simulation_settings.AdaptType
       hfss_simulation_settings.BasisFunctionOrder
       hfss_simulation_settings.SolverType

doc/source/api/utility.rst

@@ -20,3 +20,18 @@ Classes
    transform.Transform
    transform3d.Transform3D
    value.Value
+   edb_error_manager.EDBErrorSeverity
+   edb_error_manager.EDBError
+   edb_error_manager.get_error_messages
+
+
+Enums
+-----
+
+.. autosummary::
+   :toctree: _autosummary
+
+   heat_sink.HeatSinkFinOrientation
+   hfss_extent_info.HFSSExtentInfoType
+   hfss_extent_info.OpenRegionType
+   layer_map.LayerMapUniqueDirection

pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "flit_core.buildapi"
 [project]
 # Check https://flit.readthedocs.io/en/latest/pyproject_toml.html for all available sections
 name = "ansys-edb-core"
-version = "0.2.0.dev3"
+version = "0.2.0.dev4"
 description = "A python wrapper for Ansys Edb service"
 readme = "README.rst"
 requires-python = ">=3.8"
@@ -25,7 +25,7 @@ classifiers = [
 
 
 dependencies = [
-    "ansys-api-edb==0.2.dev3",
+    "ansys-api-edb==0.2.dev6",
     "protobuf>=3.19.3,<5",
     "grpcio>=1.44.0",
     "Django>=4.2.16"

src/ansys/edb/core/definition/component_def.py

@@ -1,9 +1,23 @@
 """Component definition."""
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, List
+
+if TYPE_CHECKING:
+    from src.ansys.edb.core.database import ProductIdType
+
 from ansys.api.edb.v1.component_def_pb2_grpc import ComponentDefServiceStub
 
 from ansys.edb.core.definition import component_model, component_pin
 from ansys.edb.core.edb_defs import DefinitionObjType
 from ansys.edb.core.inner import ObjBase, messages
+from ansys.edb.core.inner.messages import (
+    edb_obj_collection_property_message,
+    edb_obj_pair_message,
+    get_product_property_ids_message,
+    get_product_property_message,
+    set_product_property_message,
+)
 from ansys.edb.core.inner.utils import map_list
 from ansys.edb.core.session import StubAccessor, StubType
 
@@ -87,7 +101,7 @@ def component_models(self):
         This property is read-only.
         """
         objs = self.__stub.GetComponentModels(self.msg).items
-        return map_list(objs, component_model.ComponentModel)
+        return map_list(objs, lambda msg: component_model.ComponentModel(msg).cast())
 
     @property
     def component_pins(self):
@@ -125,3 +139,80 @@ def remove_component_model(self, value):
         Once a component model is added to one component def, it cannot be added to any other, even when removed.
         """
         self.__stub.RemoveComponentModel(messages.pointer_property_message(self, value))
+
+    def reorder_pins(self, reordered_pins: List[component_pin.ComponentPin]):
+        """Reorders the existing pins in the components definition to be in the same order \
+        as in the provided list.
+
+        Parameters
+        ----------
+        reordered_pins : list of .ComponentPin
+            The component pins in the new order. These must be the same pins \
+            that already exist in the component definition.
+        """
+        self.__stub.ReorderPins(edb_obj_collection_property_message(self, reordered_pins))
+
+    def remove_pin(self, pin_to_remove: component_pin.ComponentPin):
+        """Remove the provided component pin from the component definition. \
+        the pin will be deleted and set to :meth:`null <.is_null>`.
+
+        Parameters
+        ----------
+        pin_to_remove : .ComponentPin
+            The pin to be removed.
+        """
+        self.__stub.RemovePin(edb_obj_pair_message(self, pin_to_remove))
+        pin_to_remove.msg = None
+
+    def get_product_property(self, prod_id: ProductIdType, attr_it: int) -> str:
+        """Get the product property for a given product ID and attribute ID.
+
+        Parameters
+        ----------
+        prod_id : .ProductIdType
+            Product ID.
+        attr_it : int
+            Attribute ID.
+
+        Returns
+        -------
+        str
+            Product property for the given product ID and attribute ID.
+        """
+        return self.__stub.GetProductProperty(
+            get_product_property_message(self, prod_id, attr_it)
+        ).value
+
+    def set_product_property(self, prod_id: ProductIdType, attr_it: int, prop_value: str):
+        """Set the product property for the given product ID and attribute ID.
+
+        Parameters
+        ----------
+        prod_id : .ProductIdType
+            Product ID.
+        attr_it : int
+            Attribute ID.
+        prop_value : str
+            New value for the product property.
+        """
+        self.__stub.SetProductProperty(
+            set_product_property_message(self, prod_id, attr_it, prop_value)
+        )
+
+    def get_product_property_ids(self, prod_id: ProductIdType) -> List[int]:
+        """Get the list of property IDs for a given property ID.
+
+        Parameters
+        ----------
+        prod_id : ProductIdType
+            Product ID.
+
+        Returns
+        -------
+        list[int]
+            Attribute IDs for the given product ID.
+        """
+        attr_ids = self.__stub.GetProductPropertyIds(
+            get_product_property_ids_message(self, prod_id)
+        ).ids
+        return [attr_id for attr_id in attr_ids]

src/ansys/edb/core/definition/component_model.py

@@ -1,4 +1,7 @@
 """Component model definition."""
+from enum import Enum
+
+from ansys.api.edb.v1.component_model_pb2 import ComponentModelType as pb_comp_model_Type
 from ansys.api.edb.v1.component_model_pb2_grpc import (
     ComponentModelServiceStub,
     DynamicLinkComponentModelServiceStub,
@@ -10,6 +13,14 @@
 from ansys.edb.core.session import StubAccessor, StubType
 
 
+class ComponentModelType(Enum):
+    """Enum representing component model types."""
+
+    N_PORT = pb_comp_model_Type.N_PORT
+    DYNAMIC_LINK = pb_comp_model_Type.DYNAMIC_LINK
+    UNKNOWN_COMPONENT_MODEL_TYPE = pb_comp_model_Type.UNKNOWN_MODEL_TYPE
+
+
 class ComponentModel(ObjBase):
     """Represents a component model."""
 
@@ -42,7 +53,7 @@ def find_by_name(cls, comp_def, value):
         """
         return ComponentModel(
             cls.__stub.FindByName(messages.string_property_message(comp_def, value))
-        )
+        ).cast()
 
     @classmethod
     def find_by_id(cls, comp_def, value):
@@ -60,7 +71,51 @@ def find_by_id(cls, comp_def, value):
         ComponentModel
             Component model that is found, ``None`` otherwise.
         """
-        return ComponentModel(cls.__stub.FindById(messages.int_proprty_message(comp_def, value)))
+        return ComponentModel(
+            cls.__stub.FindById(messages.int_property_message(comp_def, value))
+        ).cast()
+
+    @property
+    def name(self) -> str:
+        """:obj:`str`: The name of the component model.
+
+        This property is read-only.
+        """
+        return self.__stub.GetName(self.msg).value
+
+    @property
+    def component_model_type(self) -> ComponentModelType:
+        """:class:`.ComponentModelType`: The type of the component model.
+
+        This property is read-only.
+        """
+        return ComponentModelType(self.__stub.GetType(self.msg).type)
+
+    @property
+    def component_model_id(self) -> int:
+        """:obj:`int`: The id of the component model.
+
+        This property is read-only.
+        """
+        return self.__stub.GetId(self.msg).value
+
+    def cast(self) -> "ComponentModel":
+        """Cast the component model object to the correct concrete type.
+
+        Returns
+        -------
+        .ComponentModel
+        """
+        comp_model_type = (
+            ComponentModelType.UNKNOWN_COMPONENT_MODEL_TYPE
+            if self.is_null
+            else self.component_model_type
+        )
+        if comp_model_type == ComponentModelType.N_PORT:
+            return NPortComponentModel(self.msg)
+        elif comp_model_type == ComponentModelType.DYNAMIC_LINK:
+            return DynamicLinkComponentModel(self.msg)
+        return ComponentModel(self.msg)
 
 
 class NPortComponentModel(ComponentModel):

src/ansys/edb/core/definition/padstack_def_data.py

@@ -189,13 +189,15 @@ def get_pad_parameters(self, layer, pad_type):
                 Value(message.generic.offset_y),
                 Value(message.generic.rotation),
             )
-        else:
+        elif message.HasField("polygon"):
             return (
                 parser.to_polygon_data(message.polygon.fp),
                 Value(message.polygon.offset_x),
                 Value(message.polygon.offset_y),
                 Value(message.polygon.rotation),
             )
+        else:
+            return ()
 
     def set_pad_parameters(
         self, layer, pad_type, offset_x, offset_y, rotation, type_geom=None, sizes=None, fp=None

src/ansys/edb/core/geometry/polygon_data.py

@@ -9,6 +9,7 @@
 from ansys.edb.core import session
 from ansys.edb.core.geometry.arc_data import ArcData
 from ansys.edb.core.inner import messages, parser
+from ansys.edb.core.inner.utils import client_stream_iterator
 from ansys.edb.core.utility import conversions
 
 
@@ -40,6 +41,17 @@ class IntersectionType(Enum):
 class PolygonData:
     """Represents a polygon data object."""
 
+    @staticmethod
+    def _polygon_data_request_iterator(polys):
+        chunk_entry_creator = lambda poly: messages.polygon_data_message(poly)
+        chunk_entries_getter = lambda chunk: chunk.polygons
+        return client_stream_iterator(
+            polys,
+            polygon_data_pb2.PolygonDataListMessage,
+            chunk_entry_creator,
+            chunk_entries_getter,
+        )
+
     __stub: polygon_data_pb2_grpc.PolygonDataServiceStub = session.StubAccessor(
         session.StubType.polygon_data
     )
@@ -355,7 +367,7 @@ def bbox_of_polygons(cls, polygons):
         -------
         tuple[.PointData, .PointData]
         """
-        return cls.__stub.GetBBox(messages.polygon_data_list_message(polygons))
+        return cls.__stub.GetStreamedBBox(PolygonData._polygon_data_request_iterator(polygons))
 
     @parser.to_circle
     def bounding_circle(self):

src/ansys/edb/core/hierarchy/group.py

@@ -6,6 +6,7 @@
 from ansys.edb.core.edb_defs import LayoutObjType
 from ansys.edb.core.hierarchy.hierarchy_obj import HierarchyObj
 from ansys.edb.core.inner import messages
+from ansys.edb.core.inner.utils import query_lyt_object_collection
 from ansys.edb.core.session import StubAccessor, StubType
 
 
@@ -113,7 +114,10 @@ def members(self):
 
         This property is read-only.
         """
-        from ansys.edb.core.inner import factory
-
-        objs = self.__stub.GetMembers(self.msg).items
-        return [factory.create_conn_obj(co) for co in objs]
+        return query_lyt_object_collection(
+            self,
+            LayoutObjType.INVALID_LAYOUT_OBJ,
+            self.__stub.GetMembers,
+            self.__stub.StreamMembers,
+            False,
+        )

src/ansys/edb/core/hierarchy/spice_model.py

@@ -1,6 +1,6 @@
 """SPICE Model."""
 from ansys.edb.core.hierarchy.model import Model
-from ansys.edb.core.inner import messages
+from ansys.edb.core.inner import messages, parser
 from ansys.edb.core.session import SpiceModelServiceStub, StubAccessor, StubType
 
 
@@ -78,3 +78,10 @@ def remove_terminal(self, terminal):
             Terminal name.
         """
         self.__stub.RemoveTerminalPinPair(messages.string_property_message(self, terminal))
+
+    @property
+    @parser.to_string_dict
+    def terminal_pin_pairs(self):
+        """:obj:`dict` of {:obj:`str` : :obj:`str`}: A dictionary showing the mapping of terminals in the layout to \
+        pins in the spice model by name."""
+        return self.__stub.GetTerminalPinPairs(self.msg)

src/ansys/edb/core/inner/conn_obj.py

@@ -3,6 +3,7 @@
 
 from ansys.edb.core.edb_defs import LayoutObjType
 from ansys.edb.core.inner import layout_obj, messages
+from ansys.edb.core.inner.factory import create_lyt_obj
 from ansys.edb.core.layout import mcad_model as mm
 from ansys.edb.core.session import ConnectableServiceStub, StubAccessor, StubType
 
@@ -48,6 +49,15 @@ def get_client_prim_type_from_class():
             return client_obj
         return cls(None)
 
+    def cast(self):
+        """Cast the ConnObj object to the correct concrete type.
+
+        Returns
+        -------
+        .ConnObj
+        """
+        return create_lyt_obj(self.msg, self.obj_type)
+
     @property
     def obj_type(self):
         """:class:`LayoutObjType <ansys.edb.core.edb_defs.LayoutObjType>`: Layout object type.