ScriptingParameterCollection#

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

Bases: IRuntimeTypeInfoProvider

Scripting Parameter Collection.

Overview#

Methods

`item`	Allow you to iterate through the collection.
`add`	Add a parameter to the collection.
`remove`	Remove a parameter.
`remove_all`	Remove all parameters.
`cut`	Copy the parameter into the clipboard and removes the parameter from the list.
`paste`	Pastes the parameter from the clipboard and inserts into the list.
`insert_copy`	Copy the parameter and inserts the copy into the list.
`get_item_by_index`	Retrieve a scripting parameter in the collection by index.
`get_item_by_name`	Retrieve a scripting parameter 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 ScriptingParameterCollection

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

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

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

ScriptingParameterCollection.item(self, index_or_name: Any) → ScriptingParameter#

Allow you to iterate through the collection.

ScriptingParameterCollection.add(self, parameter_name: str) → ScriptingParameter#

Add a parameter to the collection.

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

Remove a parameter.

ScriptingParameterCollection.remove_all(self) → None#

Remove all parameters.

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

Copy the parameter into the clipboard and removes the parameter from the list.

ScriptingParameterCollection.paste(self) → ScriptingParameter#

Pastes the parameter from the clipboard and inserts into the list.

ScriptingParameterCollection.insert_copy(self, parameter: ScriptingParameter) → ScriptingParameter#

Copy the parameter and inserts the copy into the list.

ScriptingParameterCollection.get_item_by_index(self, index: int) → ScriptingParameter#

Retrieve a scripting parameter in the collection by index.

ScriptingParameterCollection.get_item_by_name(self, name: str) → ScriptingParameter#

Retrieve a scripting parameter in the collection by name.