DoublesCollection

class ansys.stk.core.stkutil.DoublesCollection

A collection of doubles.

Overview

Methods

item	Return a double at a specified position.
add	Add a value to the collection of doubles.
remove_at	Remove an element from the collection at a specified position.
remove_all	Clear the collection.
to_array	Return an array of the elements in the collection.
set_at	Update an element in the collection at a specified position.

Properties

count	Return the number of items in the collection.
_new_enum	Return a collection enumerator.

Import detail

from ansys.stk.core.stkutil import DoublesCollection

Property detail

property DoublesCollection.count: int

Return the number of items in the collection.

property DoublesCollection._new_enum: EnumeratorProxy

Return a collection enumerator.

Method detail

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

Return a double at a specified position.

Parameters:

index : int

Returns:

float

DoublesCollection.add(self, value: float) → None

Add a value to the collection of doubles.

Parameters:

value : float

Returns:

None

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

Remove an element from the collection at a specified position.

Parameters:

index : int

Returns:

None

DoublesCollection.remove_all(self) → None

Clear the collection.

Returns:

None

DoublesCollection.to_array(self) → list

Return an array of the elements in the collection.

Returns:

list

DoublesCollection.set_at(self, index: int, value: float) → None

Update an element in the collection at a specified position.

Parameters:

index : int

value : float

Returns:

None