PropagatorFunctionCollection#

class ansys.stk.core.stkobjects.astrogator.PropagatorFunctionCollection#: Propagator Function Collection.

Overview#

Methods

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

Properties

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

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

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

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

PropagatorFunctionCollection.add(self, result_name: str) → IComponentInfo#

Add a function to the collection.

PropagatorFunctionCollection.item(self, index_or_name: Any) → IComponentInfo#

Allow you to iterate through the collection.

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

Remove the specified function from the collection.

PropagatorFunctionCollection.remove_all(self) → None#

Remove all functions from the collection.

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

Copy a propagator function to the clipboard and removes the propagator function from the list.

PropagatorFunctionCollection.paste(self) → IComponentInfo#

Pastes a propagator function from the clipboard into the list.

PropagatorFunctionCollection.insert_copy(self, prop_func: IComponentInfo) → IComponentInfo#

Copy a propagator function and inserts the copy into the list.

PropagatorFunctionCollection.get_item_by_index(self, index: int) → IComponentInfo#

Retrieve a propagator function from the collection by index.

PropagatorFunctionCollection.get_item_by_name(self, name: str) → IComponentInfo#

Retrieve a propagator function from the collection by name.