The ``layout_obj.py`` module
============================

.. py:module:: pyedb.grpc.database.inner.layout_obj


Summary
-------






















.. py:currentmodule:: layout_obj
.. tab-set::




    .. tab-item:: Classes

        .. list-table::
          :header-rows: 0
          :widths: auto


          * - :py:obj:`~pyedb.grpc.database.inner.layout_obj.HFSSProductProperty`
            - Represents the HFSS product properties.


          * - :py:obj:`~pyedb.grpc.database.inner.layout_obj.HorizontalWavePortProperty`
            - Represents the properties of a horizontal wave port.


          * - :py:obj:`~pyedb.grpc.database.inner.layout_obj.PadstackInstanceMeshingProperty`
            - Represents the padstack instance meshing properties.


          * - :py:obj:`~pyedb.grpc.database.inner.layout_obj.ViaMeshingProperty`
            - Represents the via meshing properties.


          * - :py:obj:`~pyedb.grpc.database.inner.layout_obj.PlanarEMProperty`
            - Represents the PlanarEM solver properties.


          * - :py:obj:`~pyedb.grpc.database.inner.layout_obj.SiwaveProperty`
            - Represents the SIwave solver properties.


          * - :py:obj:`~pyedb.grpc.database.inner.layout_obj.LayoutObj`
            - Represents a layout object.





    .. tab-item:: Functions

        .. list-table::
          :header-rows: 0
          :widths: auto


          * - :py:obj:`~parse_hfss_string`
            - Parse an HFSS property string into an HFSSProductProperty object.


          * - :py:obj:`~parse_horizontal_wave_port_string`
            - Parse a horizontal wave port property string into a HorizontalWavePortProperty object.


          * - :py:obj:`~parse_padstack_instance_meshing_string`
            - Parse a padstack instance meshing property string into a PadstackInstanceMeshingProperty object.


          * - :py:obj:`~parse_via_meshing_string`
            - Parse a via meshing property string into a ViaMeshingProperty object.


          * - :py:obj:`~parse_planar_em_string`
            - Parse a PlanarEM property string into a PlanarEMProperty object.


          * - :py:obj:`~parse_siwave_string`
            - Parse a SIwave property string into a SiwaveProperty object.









.. toctree::
   :titlesonly:
   :maxdepth: 1
   :hidden:

    <span class="nf nf-cod-symbol_class"></span> HFSSProductProperty</autoapi/pyedb/grpc/database/inner/layout_obj/HFSSProductProperty>
    <span class="nf nf-cod-symbol_class"></span> HorizontalWavePortProperty</autoapi/pyedb/grpc/database/inner/layout_obj/HorizontalWavePortProperty>
    <span class="nf nf-cod-symbol_class"></span> PadstackInstanceMeshingProperty</autoapi/pyedb/grpc/database/inner/layout_obj/PadstackInstanceMeshingProperty>
    <span class="nf nf-cod-symbol_class"></span> ViaMeshingProperty</autoapi/pyedb/grpc/database/inner/layout_obj/ViaMeshingProperty>
    <span class="nf nf-cod-symbol_class"></span> PlanarEMProperty</autoapi/pyedb/grpc/database/inner/layout_obj/PlanarEMProperty>
    <span class="nf nf-cod-symbol_class"></span> SiwaveProperty</autoapi/pyedb/grpc/database/inner/layout_obj/SiwaveProperty>
    <span class="nf nf-cod-symbol_class"></span> LayoutObj</autoapi/pyedb/grpc/database/inner/layout_obj/LayoutObj>















Module detail
-------------

.. py:function:: parse_hfss_string(s: str | None) -> HFSSProductProperty

   
   Parse an HFSS property string into an HFSSProductProperty object.

   This function extracts configuration settings from a formatted string representation of
   HFSS properties and reconstructs them into a structured object.

   :Parameters:

       **s** : :class:`python:str` | :data:`python:None`
           A formatted string containing HFSS configuration settings.
           If None, returns an HFSSProductProperty with default values.
           Expected format includes key-value pairs like "'HFSS Type'='value'", etc.,
           and may contain parameters like Orientation, Layer Alignment, extent factors, etc.



   :Returns:

       :obj:`HFSSProductProperty`
           An object containing the parsed HFSS properties
           with all settings extracted from the input string. If the string is None or any specific
           property is not found, default values are used.











   ..
       !! processed by numpydoc !!

.. py:function:: parse_horizontal_wave_port_string(s: str | None) -> HorizontalWavePortProperty

   
   Parse a horizontal wave port property string into a HorizontalWavePortProperty object.

   This function extracts configuration settings from a formatted string representation of
   horizontal wave port properties and reconstructs them into a structured object. It supports
   parsing multiple padstack instance names (vias) from the HorizWavePort section.

   :Parameters:

       **s** : :class:`python:str` | :data:`python:None`
           A formatted string containing horizontal wave port configuration settings.
           If None, returns a HorizontalWavePortProperty with default values.
           Expected format includes key-value pairs like "Type='value'", "Arms=2", etc.,
           and may contain a "HorizWavePort(...)" section with one or more port/via names.
           Multiple vias are parsed from comma-separated quoted strings, e.g.,
           HorizWavePort('pos_via_name', 'neg_via_name').



   :Returns:

       :obj:`HorizontalWavePortProperty`
           An object containing the parsed horizontal wave port properties
           with all settings extracted from the input string. The port_names attribute will be
           a tuple containing all parsed via names. If the string is None or any specific
           property is not found, default values are used.











   ..
       !! processed by numpydoc !!

.. py:function:: parse_padstack_instance_meshing_string(s: str | None) -> PadstackInstanceMeshingProperty

   
   Parse a padstack instance meshing property string into a PadstackInstanceMeshingProperty object.

   This function extracts configuration settings from a formatted string representation of
   padstack instance meshing properties and reconstructs them into a structured object.

   :Parameters:

       **s** : :class:`python:str` | :data:`python:None`
           A formatted string containing padstack instance meshing configuration settings.
           If None, returns a PadstackInstanceMeshingProperty with default values.
           Expected format includes key-value pairs like "sid=3", "mat='copper'", "vs='Mesh'", etc.



   :Returns:

       :obj:`PadstackInstanceMeshingProperty`
           An object containing the parsed padstack instance meshing properties
           with all settings extracted from the input string. If the string is None or any specific
           property is not found, default values are used.











   ..
       !! processed by numpydoc !!

.. py:function:: parse_via_meshing_string(s: str | None) -> ViaMeshingProperty

   
   Parse a via meshing property string into a ViaMeshingProperty object.

   This function extracts configuration settings from a formatted string representation of
   via meshing properties and reconstructs them into a structured object.

   :Parameters:

       **s** : :class:`python:str` | :data:`python:None`
           A formatted string containing via meshing configuration settings.
           If None, returns a ViaMeshingProperty with default values.
           Expected format includes key-value pairs like "sid=3", "mat='copper'", "vs='Mesh'", etc.



   :Returns:

       :obj:`ViaMeshingProperty`
           An object containing the parsed via meshing properties
           with all settings extracted from the input string. If the string is None or any specific
           property is not found, default values are used.











   ..
       !! processed by numpydoc !!

.. py:function:: parse_planar_em_string(s: str | None) -> PlanarEMProperty

   
   Parse a PlanarEM property string into a PlanarEMProperty object.

   This function extracts configuration settings from a formatted string representation of
   PlanarEM properties and reconstructs them into a structured object.

   :Parameters:

       **s** : :class:`python:str` | :data:`python:None`
           A formatted string containing PlanarEM configuration settings.
           If None, returns a PlanarEMProperty with default values.
           Expected format includes key-value pairs like "Type='value'", "PortSolver=true", etc.



   :Returns:

       :obj:`PlanarEMProperty`
           An object containing the parsed PlanarEM properties
           with all settings extracted from the input string. If the string is None or any specific
           property is not found, default values are used.











   ..
       !! processed by numpydoc !!

.. py:function:: parse_siwave_string(s: str | None) -> SiwaveProperty

   
   Parse a SIwave property string into a SiwaveProperty object.

   This function extracts configuration settings from a formatted string representation of
   SIwave properties and reconstructs them into a structured object.

   :Parameters:

       **s** : :class:`python:str` | :data:`python:None`
           A formatted string containing SIwave configuration settings.
           If None, returns a SiwaveProperty with default values.
           Expected format includes key-value pairs like "'Reference Net'='value'", etc.



   :Returns:

       :obj:`SiwaveProperty`
           An object containing the parsed SIwave properties
           with all settings extracted from the input string. If the string is None or any specific
           property is not found, default values are used.











   ..
       !! processed by numpydoc !!