ScriptingParameterEnumerationChoiceCollection#

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

Bases: IRuntimeTypeInfoProvider

Scripting Parameter Enumeration Choice Collection.

Overview#

Methods

`item`	Allow you to iterate through the collection.
`add`	Add an enumeration choice to the collection.
`remove`	Remove an enumeration choice.
`cut`	Copy the enumeration choice into the clipboard and removes the enumeration choice from the list.
`paste`	Pastes the enumeration choice from the clipboard and inserts into the list.
`insert_copy`	Copy the enumeration choice and inserts the copy into the list.
`get_item_by_index`	Retrieve a scripting parameter enumeration choice in the collection by index.
`get_item_by_name`	Retrieve a scripting parameter enumeration choice in the collection by name.

Properties

`_new_enum`	Allow you to enumerate through the collection.
`count`	Return the size of the collection.
`provide_runtime_type_info`	Return the RuntimeTypeInfo interface to access properties at runtime.

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

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

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

property ScriptingParameterEnumerationChoiceCollection.provide_runtime_type_info: RuntimeTypeInfo#: Return the RuntimeTypeInfo interface to access properties at runtime.

ScriptingParameterEnumerationChoiceCollection.item(self, index_or_name: Any) → ScriptingParameterEnumerationChoice#

Allow you to iterate through the collection.

ScriptingParameterEnumerationChoiceCollection.add(self, choice_name: str) → ScriptingParameterEnumerationChoice#

Add an enumeration choice to the collection.

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

Remove an enumeration choice.

ScriptingParameterEnumerationChoiceCollection.cut(self, index_or_name: Any) → None#

Copy the enumeration choice into the clipboard and removes the enumeration choice from the list.

ScriptingParameterEnumerationChoiceCollection.paste(self) → ScriptingParameterEnumerationChoice#

Pastes the enumeration choice from the clipboard and inserts into the list.

ScriptingParameterEnumerationChoiceCollection.insert_copy(self, choice: ScriptingParameterEnumerationChoice) → ScriptingParameterEnumerationChoice#

Copy the enumeration choice and inserts the copy into the list.

ScriptingParameterEnumerationChoiceCollection.get_item_by_index(self, index: int) → ScriptingParameterEnumerationChoice#

Retrieve a scripting parameter enumeration choice in the collection by index.

ScriptingParameterEnumerationChoiceCollection.get_item_by_name(self, name: str) → ScriptingParameterEnumerationChoice#

Retrieve a scripting parameter enumeration choice in the collection by name.