AdditionalGainLossCollection

class ansys.stk.core.stkobjects.AdditionalGainLossCollection

Class defining a collection of additional gains and losses.

Overview

Methods

item	Given an index, returns the element in the collection.
remove_at	Remove the gain with the supplied index.
add	Add and returns a new gain with the corresponding value.
clear	Clear all gain values from the collection.

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 AdditionalGainLossCollection

Property detail

property AdditionalGainLossCollection.count: int

Return the number of elements in the collection.

property AdditionalGainLossCollection._new_enum: EnumeratorProxy

Return an enumerator for the collection.

Method detail

AdditionalGainLossCollection.item(self, index: int) → AdditionalGainLoss

Given an index, returns the element in the collection.

Parameters:

index : int

Returns:

AdditionalGainLoss

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

Remove the gain with the supplied index.

Parameters:

index : int

Returns:

None

AdditionalGainLossCollection.add(self, value: float) → AdditionalGainLoss

Add and returns a new gain with the corresponding value.

Parameters:

value : float

Returns:

AdditionalGainLoss

AdditionalGainLossCollection.clear(self) → None

Clear all gain values from the collection.

Returns:

None