TransferFunctionPolynomialCollection
====================================

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

   Class defining a collection of polynomial coefficients.

.. py:currentmodule:: TransferFunctionPolynomialCollection

Overview
--------

.. tab-set::

    .. tab-item:: Methods

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

            * - :py:attr:`~ansys.stk.core.stkobjects.TransferFunctionPolynomialCollection.item`
              - Given an index, returns the element in the collection.
            * - :py:attr:`~ansys.stk.core.stkobjects.TransferFunctionPolynomialCollection.remove_at`
              - Remove the complex value with the supplied index.
            * - :py:attr:`~ansys.stk.core.stkobjects.TransferFunctionPolynomialCollection.add`
              - Add a new coefficient.
            * - :py:attr:`~ansys.stk.core.stkobjects.TransferFunctionPolynomialCollection.insert_at`
              - Insert a new coefficient at the supplied index.

    .. tab-item:: Properties

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

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



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

.. code-block:: python

    from ansys.stk.core.stkobjects import TransferFunctionPolynomialCollection


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

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

    Return the number of elements in the collection.

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

    Return an enumerator for the collection.


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


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

    Given an index, returns the element in the collection.

    :Parameters:

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


    :Returns:

        :obj:`~float`


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

    Remove the complex value with the supplied index.

    :Parameters:

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


    :Returns:

        :obj:`~None`

.. py:method:: add(self, coefficient: float) -> None
    :canonical: ansys.stk.core.stkobjects.TransferFunctionPolynomialCollection.add

    Add a new coefficient.

    :Parameters:

        **coefficient** : :obj:`~float`


    :Returns:

        :obj:`~None`

.. py:method:: insert_at(self, index: int, coefficient: float) -> None
    :canonical: ansys.stk.core.stkobjects.TransferFunctionPolynomialCollection.insert_at

    Insert a new coefficient at the supplied index.

    :Parameters:

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

        **coefficient** : :obj:`~float`


    :Returns:

        :obj:`~None`