ScriptingCalculationObjectCollection#

class ansys.stk.core.stkobjects.astrogator.ScriptingCalculationObjectCollection#: Calc Object Collection.

Overview#

Methods

`add`	Add a calculation object to the collection.
`cut`	Copy the calc object into the clipboard and removes the calc object from the list.
`get_item_by_index`	Retrieve a scripting calc object from the collection by index.
`get_item_by_name`	Retrieve a scripting calc object from the collection by name.
`insert_copy`	Copy the calc object and inserts the copy into the list.
`item`	Allow you to iterate through the collection.
`paste`	Pastes the calc object from the clipboard and inserts into the list.
`remove`	Remove a calculation object.
`remove_all`	Remove all calculation objects.

Properties

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

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

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

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

ScriptingCalculationObjectCollection.add(self, component_name: str) → ScriptingCalculationObject#

Add a calculation object to the collection.

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

Copy the calc object into the clipboard and removes the calc object from the list.

ScriptingCalculationObjectCollection.get_item_by_index(self, index: int) → ScriptingCalculationObject#

Retrieve a scripting calc object from the collection by index.

ScriptingCalculationObjectCollection.get_item_by_name(self, component_name: str) → ScriptingCalculationObject#

Retrieve a scripting calc object from the collection by name.

ScriptingCalculationObjectCollection.insert_copy(self, calc_obj: ScriptingCalculationObject) → ScriptingCalculationObject#

Copy the calc object and inserts the copy into the list.

ScriptingCalculationObjectCollection.item(self, index_or_name: Any) → ScriptingCalculationObject#

Allow you to iterate through the collection.

ScriptingCalculationObjectCollection.paste(self) → ScriptingCalculationObject#

Pastes the calc object from the clipboard and inserts into the list.

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

Remove a calculation object.

ScriptingCalculationObjectCollection.remove_all(self) → None#

Remove all calculation objects.