AntennaModelHelix
=================

.. py:class:: ansys.stk.core.stkobjects.AntennaModelHelix

   Bases: :py:class:`~ansys.stk.core.stkobjects.IAntennaModel`, :py:class:`~ansys.stk.core.stkobjects.IComponentInfo`, :py:class:`~ansys.stk.core.stkobjects.ICloneable`

   Class defining a helix antenna model.

.. py:currentmodule:: AntennaModelHelix

Overview
--------

.. tab-set::

    .. tab-item:: Properties

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

            * - :py:attr:`~ansys.stk.core.stkobjects.AntennaModelHelix.diameter`
              - Get or set the diameter.
            * - :py:attr:`~ansys.stk.core.stkobjects.AntennaModelHelix.efficiency`
              - Get or set the efficiency.
            * - :py:attr:`~ansys.stk.core.stkobjects.AntennaModelHelix.backlobe_gain`
              - Get or set the back lobe gain.
            * - :py:attr:`~ansys.stk.core.stkobjects.AntennaModelHelix.turn_spacing`
              - Get or set the turn spacing.
            * - :py:attr:`~ansys.stk.core.stkobjects.AntennaModelHelix.number_of_turns`
              - Get or set the number of turns.
            * - :py:attr:`~ansys.stk.core.stkobjects.AntennaModelHelix.use_backlobe_as_mainlobe_atten`
              - Get or set the option for using the back lobe gain as a main lobe gain attenuation.



Import detail
-------------

.. code-block:: python

    from ansys.stk.core.stkobjects import AntennaModelHelix


Property detail
---------------

.. py:property:: diameter
    :canonical: ansys.stk.core.stkobjects.AntennaModelHelix.diameter
    :type: float

    Get or set the diameter.

.. py:property:: efficiency
    :canonical: ansys.stk.core.stkobjects.AntennaModelHelix.efficiency
    :type: float

    Get or set the efficiency.

.. py:property:: backlobe_gain
    :canonical: ansys.stk.core.stkobjects.AntennaModelHelix.backlobe_gain
    :type: float

    Get or set the back lobe gain.

.. py:property:: turn_spacing
    :canonical: ansys.stk.core.stkobjects.AntennaModelHelix.turn_spacing
    :type: float

    Get or set the turn spacing.

.. py:property:: number_of_turns
    :canonical: ansys.stk.core.stkobjects.AntennaModelHelix.number_of_turns
    :type: float

    Get or set the number of turns.

.. py:property:: use_backlobe_as_mainlobe_atten
    :canonical: ansys.stk.core.stkobjects.AntennaModelHelix.use_backlobe_as_mainlobe_atten
    :type: bool

    Get or set the option for using the back lobe gain as a main lobe gain attenuation.