CentralBodyComponentCollection#

class ansys.stk.core.stkobjects.astrogator.CentralBodyComponentCollection#: Central Body Collection.

Overview#

Methods

`item`	Allow you to iterate through the collection.
`add`	Add a central body to the collection.
`remove`	Remove a central body from the collection.
`remove_all`	Remove all central bodies from the collection.
`get_item_by_index`	Retrieve a central body from the collection by index.
`get_item_by_name`	Retrieve a central body from the collection by name.

Properties

`count`	Return the size of the collection.
`_new_enum`	Iterates through the collection.

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

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

property CentralBodyComponentCollection._new_enum: EnumeratorProxy#: Iterates through the collection.

CentralBodyComponentCollection.item(self, index_or_cb_name: Any) → CentralBodyComponent#

Allow you to iterate through the collection.

CentralBodyComponentCollection.add(self, cb_name: str) → None#

Add a central body to the collection.

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

Remove a central body from the collection.

CentralBodyComponentCollection.remove_all(self) → None#

Remove all central bodies from the collection.

CentralBodyComponentCollection.get_item_by_index(self, index: int) → CentralBodyComponent#

Retrieve a central body from the collection by index.

CentralBodyComponentCollection.get_item_by_name(self, cb_name: str) → CentralBodyComponent#

Retrieve a central body from the collection by name.