:class:`HfssExtentInfo` ======================= .. py:class:: pyedb.dotnet.database.edb_data.hfss_extent_info.HfssExtentInfo(pedb) Manages EDB functionalities for HFSS extent information. :Parameters: **pedb** : :class:`pyedb.edb.Edb` Inherited EDB object. .. !! processed by numpydoc !! .. py:currentmodule:: HfssExtentInfo Overview -------- .. tab-set:: .. tab-item:: Methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~set_air_box_horizontal_extent` - * - :py:attr:`~get_air_box_horizontal_extent` - * - :py:attr:`~set_air_box_positive_vertical_extent` - * - :py:attr:`~get_air_box_positive_vertical_extent` - * - :py:attr:`~set_air_box_negative_vertical_extent` - * - :py:attr:`~get_air_box_negative_vertical_extent` - * - :py:attr:`~set_dielectric_extent` - * - :py:attr:`~get_dielectric_extent` - * - :py:attr:`~load_config` - Load HFSS extent configuration. * - :py:attr:`~export_config` - Export HFSS extent information. .. tab-item:: Properties .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~air_box_horizontal_extent_enabled` - Whether horizontal extent is enabled for the airbox. * - :py:attr:`~air_box_horizontal_extent` - Size of horizontal extent for the air box. * - :py:attr:`~air_box_positive_vertical_extent_enabled` - Whether positive vertical extent is enabled for the air box. * - :py:attr:`~air_box_positive_vertical_extent` - Negative vertical extent for the air box. * - :py:attr:`~air_box_negative_vertical_extent_enabled` - Whether negative vertical extent is enabled for the air box. * - :py:attr:`~air_box_negative_vertical_extent` - Negative vertical extent for the airbox. * - :py:attr:`~base_polygon` - Base polygon. * - :py:attr:`~dielectric_base_polygon` - Dielectric base polygon. * - :py:attr:`~dielectric_extent_size_enabled` - Whether dielectric extent size is enabled. * - :py:attr:`~dielectric_extent_size` - Dielectric extent size. * - :py:attr:`~dielectric_extent_type` - Dielectric extent type. * - :py:attr:`~extent_type` - Extent type. * - :py:attr:`~honor_user_dielectric` - Honor user dielectric. * - :py:attr:`~is_pml_visible` - Whether visibility of the PML is enabled. * - :py:attr:`~open_region_type` - Open region type. * - :py:attr:`~operating_freq` - PML Operating frequency. * - :py:attr:`~radiation_level` - PML Radiation level to calculate the thickness of boundary. * - :py:attr:`~pml_radiation_factor` - PML Radiation level to calculate the thickness of boundary. * - :py:attr:`~sync_air_box_vertical_extent` - Vertical extent of the sync air box. * - :py:attr:`~truncate_air_box_at_ground` - Truncate air box at ground. * - :py:attr:`~use_open_region` - Whether using an open region is enabled. * - :py:attr:`~use_xy_data_extent_for_vertical_expansion` - Whether using the xy data extent for vertical expansion is enabled. Import detail ------------- .. code-block:: python from pyedb.dotnet.database.edb_data.hfss_extent_info import HfssExtentInfo Property detail --------------- .. py:property:: air_box_horizontal_extent_enabled Whether horizontal extent is enabled for the airbox. .. !! processed by numpydoc !! .. py:property:: air_box_horizontal_extent Size of horizontal extent for the air box. Returns: dotnet.database.edb_data.edbvalue.EdbValue .. !! processed by numpydoc !! .. py:property:: air_box_positive_vertical_extent_enabled Whether positive vertical extent is enabled for the air box. .. !! processed by numpydoc !! .. py:property:: air_box_positive_vertical_extent Negative vertical extent for the air box. .. !! processed by numpydoc !! .. py:property:: air_box_negative_vertical_extent_enabled Whether negative vertical extent is enabled for the air box. .. !! processed by numpydoc !! .. py:property:: air_box_negative_vertical_extent Negative vertical extent for the airbox. .. !! processed by numpydoc !! .. py:property:: base_polygon Base polygon. :Returns: :class:`dotnet.database.edb_data.primitives_data.EDBPrimitive` .. .. !! processed by numpydoc !! .. py:property:: dielectric_base_polygon Dielectric base polygon. :Returns: :class:`dotnet.database.edb_data.primitives_data.EDBPrimitive` .. .. !! processed by numpydoc !! .. py:property:: dielectric_extent_size_enabled Whether dielectric extent size is enabled. .. !! processed by numpydoc !! .. py:property:: dielectric_extent_size Dielectric extent size. .. !! processed by numpydoc !! .. py:property:: dielectric_extent_type Dielectric extent type. .. !! processed by numpydoc !! .. py:property:: extent_type Extent type. .. !! processed by numpydoc !! .. py:property:: honor_user_dielectric Honor user dielectric. .. !! processed by numpydoc !! .. py:property:: is_pml_visible Whether visibility of the PML is enabled. .. !! processed by numpydoc !! .. py:property:: open_region_type Open region type. .. !! processed by numpydoc !! .. py:property:: operating_freq PML Operating frequency. :Returns: :obj:`pyedb.dotnet.database.edb_data.edbvalue.EdbValue` .. .. !! processed by numpydoc !! .. py:property:: radiation_level PML Radiation level to calculate the thickness of boundary. .. !! processed by numpydoc !! .. py:property:: pml_radiation_factor PML Radiation level to calculate the thickness of boundary. .. !! processed by numpydoc !! .. py:property:: sync_air_box_vertical_extent Vertical extent of the sync air box. .. !! processed by numpydoc !! .. py:property:: truncate_air_box_at_ground Truncate air box at ground. .. !! processed by numpydoc !! .. py:property:: use_open_region Whether using an open region is enabled. .. !! processed by numpydoc !! .. py:property:: use_xy_data_extent_for_vertical_expansion Whether using the xy data extent for vertical expansion is enabled. .. !! processed by numpydoc !! Method detail ------------- .. py:method:: set_air_box_horizontal_extent(size: float, is_multiple: bool = True) .. py:method:: get_air_box_horizontal_extent() .. py:method:: set_air_box_positive_vertical_extent(size: float, is_multiple: bool = True) .. py:method:: get_air_box_positive_vertical_extent() .. py:method:: set_air_box_negative_vertical_extent(size: float, is_multiple: bool = True) .. py:method:: get_air_box_negative_vertical_extent() .. py:method:: set_dielectric_extent(size: float, is_multiple: bool = True) .. py:method:: get_dielectric_extent() .. py:method:: load_config(config) Load HFSS extent configuration. :Parameters: **config: dict** Parameters of the HFSS extent information. .. !! processed by numpydoc !! .. py:method:: export_config() Export HFSS extent information. Returns: dict Parameters of the HFSS extent information. .. !! processed by numpydoc !!