AntennaControl
==============

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

   Class defining the properties for a antenna control.

.. py:currentmodule:: AntennaControl

Overview
--------

.. tab-set::

    .. tab-item:: Methods

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

            * - :py:attr:`~ansys.stk.core.stkobjects.AntennaControl.set_embedded_model`
              - Do not use this method, as it is deprecated. Use EmbeddedModelComponentLinking on AntennaControl instead. Sets the current antenna model by name.

    .. tab-item:: Properties

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

            * - :py:attr:`~ansys.stk.core.stkobjects.AntennaControl.reference_type`
              - Get or set the antenna control reference type.
            * - :py:attr:`~ansys.stk.core.stkobjects.AntennaControl.supported_linked_antenna_objects`
              - Get an array of available antenna objects that this object can link to and use.
            * - :py:attr:`~ansys.stk.core.stkobjects.AntennaControl.linked_antenna_object`
              - Get or set the linked antenna object.
            * - :py:attr:`~ansys.stk.core.stkobjects.AntennaControl.supported_embedded_models`
              - Do not use this property, as it is deprecated. Use EmbeddedModelComponentLinking on AntennaControl instead. Gets an array of supported model names.
            * - :py:attr:`~ansys.stk.core.stkobjects.AntennaControl.embedded_model`
              - Do not use this property, as it is deprecated. Use EmbeddedModelComponentLinking on AntennaControl instead. Gets the current antenna model.
            * - :py:attr:`~ansys.stk.core.stkobjects.AntennaControl.embedded_model_orientation`
              - Get or set the antenna orientation.
            * - :py:attr:`~ansys.stk.core.stkobjects.AntennaControl.embedded_model_component_linking`
              - Get the link/embed controller for managing the embedded antenna model component.



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

.. code-block:: python

    from ansys.stk.core.stkobjects import AntennaControl


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

.. py:property:: reference_type
    :canonical: ansys.stk.core.stkobjects.AntennaControl.reference_type
    :type: AntennaControlReferenceType

    Get or set the antenna control reference type.

.. py:property:: supported_linked_antenna_objects
    :canonical: ansys.stk.core.stkobjects.AntennaControl.supported_linked_antenna_objects
    :type: list

    Get an array of available antenna objects that this object can link to and use.

.. py:property:: linked_antenna_object
    :canonical: ansys.stk.core.stkobjects.AntennaControl.linked_antenna_object
    :type: str

    Get or set the linked antenna object.

.. py:property:: supported_embedded_models
    :canonical: ansys.stk.core.stkobjects.AntennaControl.supported_embedded_models
    :type: list

    Do not use this property, as it is deprecated. Use EmbeddedModelComponentLinking on AntennaControl instead. Gets an array of supported model names.

.. py:property:: embedded_model
    :canonical: ansys.stk.core.stkobjects.AntennaControl.embedded_model
    :type: IAntennaModel

    Do not use this property, as it is deprecated. Use EmbeddedModelComponentLinking on AntennaControl instead. Gets the current antenna model.

.. py:property:: embedded_model_orientation
    :canonical: ansys.stk.core.stkobjects.AntennaControl.embedded_model_orientation
    :type: IOrientation

    Get or set the antenna orientation.

.. py:property:: embedded_model_component_linking
    :canonical: ansys.stk.core.stkobjects.AntennaControl.embedded_model_component_linking
    :type: IComponentLinkEmbedControl

    Get the link/embed controller for managing the embedded antenna model component.


Method detail
-------------







.. py:method:: set_embedded_model(self, model_name: str) -> None
    :canonical: ansys.stk.core.stkobjects.AntennaControl.set_embedded_model

    Do not use this method, as it is deprecated. Use EmbeddedModelComponentLinking on AntennaControl instead. Sets the current antenna model by name.

    :Parameters:

        **model_name** : :obj:`~str`


    :Returns:

        :obj:`~None`