ScriptingCalculationObjectCollection#

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

Calc Object Collection.

Overview#

item

Allow you to iterate through the collection.

add

Add a calculation object to the collection.

remove

Remove a calculation object.

remove_all

Remove all calculation objects.

cut

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

paste

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

insert_copy

Copy the calc object and inserts the copy into 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.

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

Property detail#

property ScriptingCalculationObjectCollection._new_enum: EnumeratorProxy#

Allow you to enumerate through the collection.

property ScriptingCalculationObjectCollection.count: int#

Return the size of the collection.

Method detail#

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

Allow you to iterate through the collection.

Parameters:

index_or_name : Any

Returns:

ScriptingCalculationObject

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

Add a calculation object to the collection.

Parameters:

component_name : str

Returns:

ScriptingCalculationObject

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

Remove a calculation object.

Parameters:

index_or_name : Any

Returns:

None

ScriptingCalculationObjectCollection.remove_all(self) None#

Remove all calculation objects.

Returns:

None

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

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

Parameters:

index_or_name : Any

Returns:

None

ScriptingCalculationObjectCollection.paste(self) ScriptingCalculationObject#

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

Returns:

ScriptingCalculationObject

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

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

Parameters:

calc_obj : ScriptingCalculationObject

Returns:

ScriptingCalculationObject

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

Retrieve a scripting calc object from the collection by index.

Parameters:

index : int

Returns:

ScriptingCalculationObject

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

Retrieve a scripting calc object from the collection by name.

Parameters:

component_name : str

Returns:

ScriptingCalculationObject