AntennaBeamCollection
=====================

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

   Class defining an antenna beam collection.

.. py:currentmodule:: AntennaBeamCollection

Overview
--------

.. tab-set::

    .. tab-item:: Methods

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

            * - :py:attr:`~ansys.stk.core.stkobjects.AntennaBeamCollection.item`
              - Given an index, returns the element in the collection.
            * - :py:attr:`~ansys.stk.core.stkobjects.AntennaBeamCollection.remove_at`
              - Remove the layer with the specified index.
            * - :py:attr:`~ansys.stk.core.stkobjects.AntennaBeamCollection.insert_at`
              - Insert a new beam at the supplied index.
            * - :py:attr:`~ansys.stk.core.stkobjects.AntennaBeamCollection.add`
              - Add a new beam to the collection.

    .. tab-item:: Properties

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

            * - :py:attr:`~ansys.stk.core.stkobjects.AntennaBeamCollection.count`
              - Return the number of elements in the collection.
            * - :py:attr:`~ansys.stk.core.stkobjects.AntennaBeamCollection._new_enum`
              - Return an enumerator for the collection.



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

.. code-block:: python

    from ansys.stk.core.stkobjects import AntennaBeamCollection


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

.. py:property:: count
    :canonical: ansys.stk.core.stkobjects.AntennaBeamCollection.count
    :type: int

    Return the number of elements in the collection.

.. py:property:: _new_enum
    :canonical: ansys.stk.core.stkobjects.AntennaBeamCollection._new_enum
    :type: EnumeratorProxy

    Return an enumerator for the collection.


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


.. py:method:: item(self, index: int) -> IAntennaBeam
    :canonical: ansys.stk.core.stkobjects.AntennaBeamCollection.item

    Given an index, returns the element in the collection.

    :Parameters:

        **index** : :obj:`~int`


    :Returns:

        :obj:`~IAntennaBeam`


.. py:method:: remove_at(self, index: int) -> None
    :canonical: ansys.stk.core.stkobjects.AntennaBeamCollection.remove_at

    Remove the layer with the specified index.

    :Parameters:

        **index** : :obj:`~int`


    :Returns:

        :obj:`~None`

.. py:method:: insert_at(self, index: int) -> IAntennaBeam
    :canonical: ansys.stk.core.stkobjects.AntennaBeamCollection.insert_at

    Insert a new beam at the supplied index.

    :Parameters:

        **index** : :obj:`~int`


    :Returns:

        :obj:`~IAntennaBeam`

.. py:method:: add(self) -> IAntennaBeam
    :canonical: ansys.stk.core.stkobjects.AntennaBeamCollection.add

    Add a new beam to the collection.

    :Returns:

        :obj:`~IAntennaBeam`