TransferFunctionPolynomialCollection

class ansys.stk.core.stkobjects.TransferFunctionPolynomialCollection

Class defining a collection of polynomial coefficients.

Overview

Methods

item	Given an index, returns the element in the collection.
remove_at	Remove the complex value with the supplied index.
add	Add a new coefficient.
insert_at	Insert a new coefficient at the supplied index.

Properties

count	Return the number of elements in the collection.
_new_enum	Return an enumerator for the collection.

Import detail

from ansys.stk.core.stkobjects import TransferFunctionPolynomialCollection

Property detail

property TransferFunctionPolynomialCollection.count: int

Return the number of elements in the collection.

property TransferFunctionPolynomialCollection._new_enum: EnumeratorProxy

Return an enumerator for the collection.

Method detail

TransferFunctionPolynomialCollection.item(self, index: int) → float

Given an index, returns the element in the collection.

Parameters:

index : int

Returns:

float

TransferFunctionPolynomialCollection.remove_at(self, index: int) → None

Remove the complex value with the supplied index.

Parameters:

index : int

Returns:

None

TransferFunctionPolynomialCollection.add(self, coefficient: float) → None

Add a new coefficient.

Parameters:

coefficient : float

Returns:

None

TransferFunctionPolynomialCollection.insert_at(self, index: int, coefficient: float) → None

Insert a new coefficient at the supplied index.

Parameters:

index : int

coefficient : float

Returns:

None