UserVariableDefinitionCollection#

class ansys.stk.core.stkobjects.astrogator.UserVariableDefinitionCollection#: User Variable Definition Collection.

Overview#

Methods

`item`	Allow you to iterate through the collection.
`add`	Add a user variable to the collection.
`remove`	Remove a user variable.
`remove_all`	Remove all user variables.
`get_item_by_index`	Retrieve a user variable definition in the collection by index.
`get_item_by_name`	Retrieve a user variable definition in the collection by name.

Properties

`_new_enum`	Allow you to enumerate through the collection.
`count`	Return the size of the collection.

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

property UserVariableDefinitionCollection._new_enum: EnumeratorProxy#: Allow you to enumerate through the collection.

property UserVariableDefinitionCollection.count: int#: Return the size of the collection.

UserVariableDefinitionCollection.item(self, index_or_name: Any) → UserVariableDefinition#

Allow you to iterate through the collection.

UserVariableDefinitionCollection.add(self, parameter_name: str) → UserVariableDefinition#

Add a user variable to the collection.

UserVariableDefinitionCollection.remove(self, index_or_name: Any) → None#

Remove a user variable.

UserVariableDefinitionCollection.remove_all(self) → None#

Remove all user variables.

UserVariableDefinitionCollection.get_item_by_index(self, index: int) → UserVariableDefinition#

Retrieve a user variable definition in the collection by index.

UserVariableDefinitionCollection.get_item_by_name(self, name: str) → UserVariableDefinition#

Retrieve a user variable definition in the collection by name.