CommRadComplexNumberCollection

class ansys.stk.core.stkobjects.CommRadComplexNumberCollection

Class defining a collection of complex numbers.

Overview

Methods

item	Given an index, returns the element in the collection.
remove_at	Remove the complex value with the supplied index.
add	Add and returns a new complex value.
insert_at	Insert and returns a new complex value at the supplied index.
clear	Clear all complex 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 CommRadComplexNumberCollection

Property detail

property CommRadComplexNumberCollection.count: int

Return the number of elements in the collection.

property CommRadComplexNumberCollection._new_enum: EnumeratorProxy

Return an enumerator for the collection.

Method detail

CommRadComplexNumberCollection.item(self, index: int) → CommRadComplexNumber

Given an index, returns the element in the collection.

Parameters:

index : int

Returns:

CommRadComplexNumber

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

Remove the complex value with the supplied index.

Parameters:

index : int

Returns:

None

CommRadComplexNumberCollection.add(self, real: float, imaginary: float) → CommRadComplexNumber

Add and returns a new complex value.

Parameters:

real : float

imaginary : float

Returns:

CommRadComplexNumber

CommRadComplexNumberCollection.insert_at(self, index: int, real: float, imaginary: float) → CommRadComplexNumber

Insert and returns a new complex value at the supplied index.

Parameters:

index : int

real : float

imaginary : float

Returns:

CommRadComplexNumber

CommRadComplexNumberCollection.clear(self) → None

Clear all complex values from the collection.

Returns:

None