AntennaModelDipole
==================

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

   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 dipole antenna model.

.. py:currentmodule:: AntennaModelDipole

Overview
--------

.. tab-set::

    .. tab-item:: Properties

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

            * - :py:attr:`~ansys.stk.core.stkobjects.AntennaModelDipole.length`
              - Get or set the length.
            * - :py:attr:`~ansys.stk.core.stkobjects.AntennaModelDipole.efficiency`
              - Get or set the efficiency.
            * - :py:attr:`~ansys.stk.core.stkobjects.AntennaModelDipole.length_to_wavelength_ratio`
              - Get or set the length-to-wavelength ratio.



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

.. code-block:: python

    from ansys.stk.core.stkobjects import AntennaModelDipole


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

.. py:property:: length
    :canonical: ansys.stk.core.stkobjects.AntennaModelDipole.length
    :type: float

    Get or set the length.

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

    Get or set the efficiency.

.. py:property:: length_to_wavelength_ratio
    :canonical: ansys.stk.core.stkobjects.AntennaModelDipole.length_to_wavelength_ratio
    :type: float

    Get or set the length-to-wavelength ratio.