CalculationObjectCollection#

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

The Calculation Object component folder.

Overview#

add

Add a calc object to the collection.

item

Return a calc object.

remove

Remove a calc object from the collection.

cut

Copy a calc object to the clipboard and removes the calc object from the list.

paste

Pastes a calc object from the clipboard into the list.

insert_copy

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

get_item_by_index

Retrieve a calc object found by the index.

get_item_by_name

Retrieve a calc object found by the 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 CalculationObjectCollection

Property detail#

property CalculationObjectCollection._new_enum: EnumeratorProxy#

Allow you to enumerate through the collection.

property CalculationObjectCollection.count: int#

Return the size of the collection.

Method detail#

CalculationObjectCollection.add(self, name: str) IComponentInfo#

Add a calc object to the collection.

Parameters:

name : str

Returns:

IComponentInfo

CalculationObjectCollection.item(self, index_or_name: Any) IComponentInfo#

Return a calc object.

Parameters:

index_or_name : Any

Returns:

IComponentInfo

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

Remove a calc object from the collection.

Parameters:

index_or_name : Any

Returns:

None

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

Copy a calc object to the clipboard and removes the calc object from the list.

Parameters:

index_or_name : Any

Returns:

None

CalculationObjectCollection.paste(self) IComponentInfo#

Pastes a calc object from the clipboard into the list.

Returns:

IComponentInfo

CalculationObjectCollection.insert_copy(self, calc_obj: IComponentInfo) IComponentInfo#

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

Parameters:

calc_obj : IComponentInfo

Returns:

IComponentInfo

CalculationObjectCollection.get_item_by_index(self, index: int) IComponentInfo#

Retrieve a calc object found by the index.

Parameters:

index : int

Returns:

IComponentInfo

CalculationObjectCollection.get_item_by_name(self, name: str) IComponentInfo#

Retrieve a calc object found by the name.

Parameters:

name : str

Returns:

IComponentInfo