UserVariableUpdateCollection#

class ansys.stk.core.stkobjects.astrogator.UserVariableUpdateCollection#

User Variable Update Collection.

Overview#

item

Allow you to iterate through the collection.

get_item_by_index

Retrieve a user variable update in the collection by index.

get_item_by_name

Retrieve a user variable update in the collection by name.

_new_enum

Allow you to enumerate through the collection.

count

Return the size of the collection.

Import detail#

from ansys.stk.core.stkobjects.astrogator import UserVariableUpdateCollection

Property detail#

property UserVariableUpdateCollection._new_enum: EnumeratorProxy#

Allow you to enumerate through the collection.

property UserVariableUpdateCollection.count: int#

Return the size of the collection.

Method detail#

UserVariableUpdateCollection.item(self, index_or_name: Any) UserVariableUpdate#

Allow you to iterate through the collection.

Parameters:

index_or_name : Any

Returns:

UserVariableUpdate

UserVariableUpdateCollection.get_item_by_index(self, index: int) UserVariableUpdate#

Retrieve a user variable update in the collection by index.

Parameters:

index : int

Returns:

UserVariableUpdate

UserVariableUpdateCollection.get_item_by_name(self, name: str) UserVariableUpdate#

Retrieve a user variable update in the collection by name.

Parameters:

name : str

Returns:

UserVariableUpdate