RadarSarImageLocationCollection
===============================

.. py:class:: ansys.stk.core.stkrfchannelmodeler.RadarSarImageLocationCollection

   A collection of image location information.

.. py:currentmodule:: RadarSarImageLocationCollection

Overview
--------

.. tab-set::

    .. tab-item:: Methods

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

            * - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.RadarSarImageLocationCollection.item`
              - Given an index, returns the element in the collection.
            * - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.RadarSarImageLocationCollection.remove_at`
              - Remove the SAR image location with the supplied index.
            * - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.RadarSarImageLocationCollection.remove`
              - Remove the supplied SAR image location from the collection.
            * - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.RadarSarImageLocationCollection.add_new`
              - Add and returns a new SAR image location.
            * - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.RadarSarImageLocationCollection.remove_all`
              - Clear all SAR image locations from the collection.
            * - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.RadarSarImageLocationCollection.contains`
              - Check to see if a given SAR image location exists in the collection.
            * - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.RadarSarImageLocationCollection.find`
              - Find a SAR image location by name. Returns Null if the image location name does not exist in the collection.

    .. tab-item:: Properties

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

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



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

.. code-block:: python

    from ansys.stk.core.stkrfchannelmodeler import RadarSarImageLocationCollection


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

.. py:property:: count
    :canonical: ansys.stk.core.stkrfchannelmodeler.RadarSarImageLocationCollection.count
    :type: int

    Return the number of elements in the collection.

.. py:property:: _new_enum
    :canonical: ansys.stk.core.stkrfchannelmodeler.RadarSarImageLocationCollection._new_enum
    :type: EnumeratorProxy

    Return an enumerator for the collection.


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


.. py:method:: item(self, index: int) -> RadarSarImageLocation
    :canonical: ansys.stk.core.stkrfchannelmodeler.RadarSarImageLocationCollection.item

    Given an index, returns the element in the collection.

    :Parameters:

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


    :Returns:

        :obj:`~RadarSarImageLocation`


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

    Remove the SAR image location with the supplied index.

    :Parameters:

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


    :Returns:

        :obj:`~None`

.. py:method:: remove(self, name_str: str) -> None
    :canonical: ansys.stk.core.stkrfchannelmodeler.RadarSarImageLocationCollection.remove

    Remove the supplied SAR image location from the collection.

    :Parameters:

        **name_str** : :obj:`~str`


    :Returns:

        :obj:`~None`

.. py:method:: add_new(self) -> RadarSarImageLocation
    :canonical: ansys.stk.core.stkrfchannelmodeler.RadarSarImageLocationCollection.add_new

    Add and returns a new SAR image location.

    :Returns:

        :obj:`~RadarSarImageLocation`

.. py:method:: remove_all(self) -> None
    :canonical: ansys.stk.core.stkrfchannelmodeler.RadarSarImageLocationCollection.remove_all

    Clear all SAR image locations from the collection.

    :Returns:

        :obj:`~None`

.. py:method:: contains(self, name_str: str) -> bool
    :canonical: ansys.stk.core.stkrfchannelmodeler.RadarSarImageLocationCollection.contains

    Check to see if a given SAR image location exists in the collection.

    :Parameters:

        **name_str** : :obj:`~str`


    :Returns:

        :obj:`~bool`

.. py:method:: find(self, name_str: str) -> RadarSarImageLocation
    :canonical: ansys.stk.core.stkrfchannelmodeler.RadarSarImageLocationCollection.find

    Find a SAR image location by name. Returns Null if the image location name does not exist in the collection.

    :Parameters:

        **name_str** : :obj:`~str`


    :Returns:

        :obj:`~RadarSarImageLocation`