pyedb 0.2.0__py3-none-any.whl

pyedb/dotnet/edb_core/edb_data/design_options.py

@@ -0,0 +1,35 @@
+class EdbDesignOptions:
+    def __init__(self, active_cell):
+        self._active_cell = active_cell
+
+    @property
+    def suppress_pads(self):
+        """Whether to suppress non-functional pads.
+
+        Returns
+        -------
+        bool
+            ``True`` if suppress non-functional pads is on, ``False`` otherwise.
+
+        """
+        return self._active_cell.GetSuppressPads()
+
+    @suppress_pads.setter
+    def suppress_pads(self, value):
+        self._active_cell.SetSuppressPads(value)
+
+    @property
+    def antipads_always_on(self):
+        """Whether to always turn on antipad.
+
+        Returns
+        -------
+        bool
+            ``True`` if antipad is always on, ``False`` otherwise.
+
+        """
+        return self._active_cell.GetAntiPadsAlwaysOn()
+
+    @antipads_always_on.setter
+    def antipads_always_on(self, value):
+        self._active_cell.SetAntiPadsAlwaysOn(value)

pyedb/dotnet/edb_core/edb_data/edbvalue.py

@@ -0,0 +1,45 @@
+class EdbValue:
+    """Class defining Edb Value properties."""
+
+    def __init__(self, edb_obj):
+        self._edb_obj = edb_obj
+
+    @property
+    def value(self):
+        """Variable Value Object.
+
+        Returns
+        -------
+        Edb Object
+        """
+        return self._edb_obj
+
+    @property
+    def name(self):
+        """Variable name.
+
+        Returns
+        -------
+        str
+        """
+        return self._edb_obj.GetName()
+
+    @property
+    def tofloat(self):
+        """Returns the float number of the variable.
+
+        Returns
+        -------
+        float
+        """
+        return self._edb_obj.ToDouble()
+
+    @property
+    def tostring(self):
+        """Returns the string of the variable.
+
+        Returns
+        -------
+        str
+        """
+        return self._edb_obj.ToString()

pyedb/dotnet/edb_core/edb_data/hfss_extent_info.py

@@ -0,0 +1,330 @@
+from pyedb.dotnet.edb_core.edb_data.edbvalue import EdbValue
+from pyedb.dotnet.edb_core.edb_data.primitives_data import cast
+from pyedb.dotnet.edb_core.general import convert_pytuple_to_nettuple
+from pyedb.generic.general_methods import pyedb_function_handler
+
+
+class HfssExtentInfo:
+    """Manages EDB functionalities for HFSS extent information.
+
+    Parameters
+    ----------
+    pedb : :class:`pyedb.edb.Edb`
+        Inherited EDB object.
+    """
+
+    def __init__(self, pedb):
+        self._pedb = pedb
+
+        self._hfss_extent_info_type = {
+            "BoundingBox": self._pedb.edb_api.utility.utility.HFSSExtentInfoType.BoundingBox,
+            "Conforming": self._pedb.edb_api.utility.utility.HFSSExtentInfoType.Conforming,
+            "ConvexHull": self._pedb.edb_api.utility.utility.HFSSExtentInfoType.ConvexHull,
+            "Polygon": self._pedb.edb_api.utility.utility.HFSSExtentInfoType.Polygon,
+        }
+        self._open_region_type = {
+            "Radiation": self._pedb.edb_api.utility.utility.OpenRegionType.Radiation,
+            "PML": self._pedb.edb_api.utility.utility.OpenRegionType.PML,
+        }
+
+    @pyedb_function_handler()
+    def _get_edb_value(self, value):
+        """Get EDB value."""
+        return self._pedb.edb_value(value)
+
+    @pyedb_function_handler()
+    def _update_hfss_extent_info(self, hfss_extent_info):
+        return self._pedb.active_cell.SetHFSSExtentInfo(hfss_extent_info)
+
+    @property
+    def _edb_hfss_extent_info(self):
+        return self._pedb.active_cell.GetHFSSExtentInfo()
+
+    @property
+    def air_box_horizontal_extent_enabled(self):
+        """Whether horizontal extent is enabled for the airbox."""
+        return self._edb_hfss_extent_info.AirBoxHorizontalExtent.Item2
+
+    @air_box_horizontal_extent_enabled.setter
+    def air_box_horizontal_extent_enabled(self, value):
+        info = self._edb_hfss_extent_info
+        info.AirBoxHorizontalExtent = convert_pytuple_to_nettuple((self.air_box_horizontal_extent, value))
+        self._update_hfss_extent_info(info)
+
+    @property
+    def air_box_horizontal_extent(self):
+        """Size of horizontal extent for the air box.
+
+        Returns:
+        dotnet.edb_core.edb_data.edbvalue.EdbValue
+        """
+        return self._edb_hfss_extent_info.AirBoxHorizontalExtent.Item1
+
+    @air_box_horizontal_extent.setter
+    def air_box_horizontal_extent(self, value):
+        info = self._edb_hfss_extent_info
+        info.AirBoxHorizontalExtent = convert_pytuple_to_nettuple((value, self.air_box_horizontal_extent_enabled))
+        self._update_hfss_extent_info(info)
+
+    @property
+    def air_box_positive_vertical_extent_enabled(self):
+        """Whether positive vertical extent is enabled for the air box."""
+        return self._edb_hfss_extent_info.AirBoxPositiveVerticalExtent.Item2
+
+    @air_box_positive_vertical_extent_enabled.setter
+    def air_box_positive_vertical_extent_enabled(self, value):
+        info = self._edb_hfss_extent_info
+        info.AirBoxPositiveVerticalExtent = convert_pytuple_to_nettuple((self.air_box_positive_vertical_extent, value))
+        self._update_hfss_extent_info(info)
+
+    @property
+    def air_box_positive_vertical_extent(self):
+        """Negative vertical extent for the air box."""
+        return self._edb_hfss_extent_info.AirBoxPositiveVerticalExtent.Item1
+
+    @air_box_positive_vertical_extent.setter
+    def air_box_positive_vertical_extent(self, value):
+        value = float(value)
+        info = self._edb_hfss_extent_info
+        info.AirBoxPositiveVerticalExtent = convert_pytuple_to_nettuple(
+            (value, self.air_box_positive_vertical_extent_enabled)
+        )
+        self._update_hfss_extent_info(info)
+
+    @property
+    def air_box_negative_vertical_extent_enabled(self):
+        """Whether negative vertical extent is enabled for the air box."""
+        return self._edb_hfss_extent_info.AirBoxNegativeVerticalExtent.Item2
+
+    @air_box_negative_vertical_extent_enabled.setter
+    def air_box_negative_vertical_extent_enabled(self, value):
+        info = self._edb_hfss_extent_info
+        info.AirBoxNegativeVerticalExtent = convert_pytuple_to_nettuple((self.air_box_negative_vertical_extent, value))
+        self._update_hfss_extent_info(info)
+
+    @property
+    def air_box_negative_vertical_extent(self):
+        """Negative vertical extent for the airbox."""
+        return self._edb_hfss_extent_info.AirBoxNegativeVerticalExtent.Item1
+
+    @air_box_negative_vertical_extent.setter
+    def air_box_negative_vertical_extent(self, value):
+        value = float(value)
+        info = self._edb_hfss_extent_info
+        info.AirBoxNegativeVerticalExtent = convert_pytuple_to_nettuple(
+            (value, self.air_box_negative_vertical_extent_enabled)
+        )
+        self._update_hfss_extent_info(info)
+
+    @property
+    def base_polygon(self):
+        """Base polygon.
+
+        Returns
+        -------
+        :class:`dotnet.edb_core.edb_data.primitives_data.EDBPrimitive`
+        """
+        return cast(self._edb_hfss_extent_info.BasePolygon, self._pedb)
+
+    @base_polygon.setter
+    def base_polygon(self, value):
+        info = self._edb_hfss_extent_info
+        info.BasePolygon = value.primitive_object
+        self._update_hfss_extent_info(info)
+
+    @property
+    def dielectric_base_polygon(self):
+        """Dielectric base polygon.
+
+        Returns
+        -------
+        :class:`dotnet.edb_core.edb_data.primitives_data.EDBPrimitive`
+        """
+        return cast(self._edb_hfss_extent_info.DielectricBasePolygon, self._pedb)
+
+    @dielectric_base_polygon.setter
+    def dielectric_base_polygon(self, value):
+        info = self._edb_hfss_extent_info
+        info.DielectricBasePolygon = value.primitive_object
+        self._update_hfss_extent_info(info)
+
+    @property
+    def dielectric_extent_size_enabled(self):
+        """Whether dielectric extent size is enabled."""
+        return self._edb_hfss_extent_info.DielectricExtentSize.Item2
+
+    @dielectric_extent_size_enabled.setter
+    def dielectric_extent_size_enabled(self, value):
+        info = self._edb_hfss_extent_info
+        info.DielectricExtentSize = convert_pytuple_to_nettuple((self.dielectric_extent_size, value))
+        self._update_hfss_extent_info(info)
+
+    @property
+    def dielectric_extent_size(self):
+        """Dielectric extent size."""
+        return self._edb_hfss_extent_info.DielectricExtentSize.Item1
+
+    @dielectric_extent_size.setter
+    def dielectric_extent_size(self, value):
+        info = self._edb_hfss_extent_info
+        info.DielectricExtentSize = convert_pytuple_to_nettuple((value, self.dielectric_extent_size_enabled))
+        self._update_hfss_extent_info(info)
+
+    @property
+    def dielectric_extent_type(self):
+        """Dielectric extent type."""
+        return self._edb_hfss_extent_info.DielectricExtentType.ToString()
+
+    @dielectric_extent_type.setter
+    def dielectric_extent_type(self, value):
+        info = self._edb_hfss_extent_info
+        info.DielectricExtentType = self._hfss_extent_info_type[value]
+        self._update_hfss_extent_info(info)
+
+    @property
+    def extent_type(self):
+        """Extent type."""
+        return self._edb_hfss_extent_info.ExtentType.ToString()
+
+    @extent_type.setter
+    def extent_type(self, value):
+        info = self._edb_hfss_extent_info
+        info.ExtentType = self._hfss_extent_info_type[value]
+        self._update_hfss_extent_info(info)
+
+    @property
+    def honor_user_dielectric(self):
+        """Honor user dielectric."""
+        return self._edb_hfss_extent_info.HonorUserDielectric
+
+    @honor_user_dielectric.setter
+    def honor_user_dielectric(self, value):
+        info = self._edb_hfss_extent_info
+        info.HonorUserDielectric = value
+        self._update_hfss_extent_info(info)
+
+    @property
+    def is_pml_visible(self):
+        """Whether visibility of the PML is enabled."""
+        return self._edb_hfss_extent_info.IsPMLVisible
+
+    @is_pml_visible.setter
+    def is_pml_visible(self, value):
+        info = self._edb_hfss_extent_info
+        info.IsPMLVisible = value
+        self._update_hfss_extent_info(info)
+
+    @property
+    def open_region_type(self):
+        """Open region type."""
+        return self._edb_hfss_extent_info.OpenRegionType.ToString()
+
+    @open_region_type.setter
+    def open_region_type(self, value):
+        info = self._edb_hfss_extent_info
+        info.OpenRegionType = self._open_region_type[value]
+        self._update_hfss_extent_info(info)
+
+    @property
+    def operating_freq(self):
+        """Operating frequency.
+
+        Returns
+        -------
+        pyedb.dotnet.edb_core.edb_data.edbvalue.EdbValue
+        """
+        return EdbValue(self._edb_hfss_extent_info.OperatingFreq)
+
+    @operating_freq.setter
+    def operating_freq(self, value):
+        value = value._edb_obj if isinstance(value, EdbValue) else self._get_edb_value(value)
+        info = self._edb_hfss_extent_info
+        info.OperatingFreq = value
+        self._update_hfss_extent_info(info)
+
+    @property
+    def radiation_level(self):
+        """Radiation level."""
+        return EdbValue(self._edb_hfss_extent_info.RadiationLevel)
+
+    @radiation_level.setter
+    def radiation_level(self, value):
+        value = value._edb_obj if isinstance(value, EdbValue) else self._get_edb_value(value)
+        info = self._edb_hfss_extent_info
+        info.RadiationLevel = value
+        self._update_hfss_extent_info(info)
+
+    @property
+    def sync_air_box_vertical_extent(self):
+        """Vertical extent of the sync air box."""
+        return self._edb_hfss_extent_info.SyncAirBoxVerticalExtent
+
+    @sync_air_box_vertical_extent.setter
+    def sync_air_box_vertical_extent(self, value):
+        info = self._edb_hfss_extent_info
+        info.SyncAirBoxVerticalExtent = value
+        self._update_hfss_extent_info(info)
+
+    @property
+    def truncate_air_box_at_ground(self):
+        """Truncate air box at ground."""
+        return self._edb_hfss_extent_info.TruncateAirBoxAtGround
+
+    @truncate_air_box_at_ground.setter
+    def truncate_air_box_at_ground(self, value):
+        info = self._edb_hfss_extent_info
+        info.TruncateAirBoxAtGround = value
+        self._update_hfss_extent_info(info)
+
+    @property
+    def use_open_region(self):
+        """Whether using an open region is enabled."""
+        return self._edb_hfss_extent_info.UseOpenRegion
+
+    @use_open_region.setter
+    def use_open_region(self, value):
+        info = self._edb_hfss_extent_info
+        info.UseOpenRegion = value
+        self._update_hfss_extent_info(info)
+
+    @property
+    def use_xy_data_extent_for_vertical_expansion(self):
+        """Whether using the xy data extent for vertical expansion is enabled."""
+        return self._edb_hfss_extent_info.UseXYDataExtentForVerticalExpansion
+
+    @use_xy_data_extent_for_vertical_expansion.setter
+    def use_xy_data_extent_for_vertical_expansion(self, value):
+        info = self._edb_hfss_extent_info
+        info.UseXYDataExtentForVerticalExpansion = value
+        self._update_hfss_extent_info(info)
+
+    @pyedb_function_handler()
+    def load_config(self, config):
+        """Load HFSS extent configuration.
+
+        Parameters
+        ----------
+        config: dict
+            Parameters of the HFSS extent information.
+        """
+        for i, j in config.items():
+            if hasattr(self, i):
+                setattr(self, i, j)
+
+    @pyedb_function_handler()
+    def export_config(self):
+        """Export HFSS extent information.
+
+        Returns:
+        dict
+            Parameters of the HFSS extent information.
+        """
+        config = dict()
+        for i in dir(self):
+            if i.startswith("_"):
+                continue
+            elif i in ["load_config", "export_config"]:
+                continue
+            else:
+                config[i] = getattr(self, i)
+        return config