UserVariableCollection

class ansys.stk.core.stkobjects.astrogator.UserVariableCollection

User Variable Initial Value Collection.

Overview

Methods

item	Allow you to iterate through the collection.
get_item_by_index	Retrieve a user variable in the collection by index.
get_item_by_name	Retrieve a user variable in the collection by name.

Properties

_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 UserVariableCollection

Property detail

property UserVariableCollection._new_enum: EnumeratorProxy

Allow you to enumerate through the collection.

property UserVariableCollection.count: int

Return the size of the collection.

Method detail

UserVariableCollection.item(self, index_or_name: Any) → UserVariable

Allow you to iterate through the collection.

Parameters:

index_or_name : Any

Returns:

UserVariable

UserVariableCollection.get_item_by_index(self, index: int) → UserVariable

Retrieve a user variable in the collection by index.

Parameters:

index : int

Returns:

UserVariable

UserVariableCollection.get_item_by_name(self, name: str) → UserVariable

Retrieve a user variable in the collection by name.

Parameters:

name : str

Returns:

UserVariable