StoppingConditionCollection#

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

Bases: IRuntimeTypeInfoProvider

The stopping conditions collection.

Overview#

Methods

`item`	Allow you to iterate through the collection.
`add`	Add a stopping condition.
`remove`	Remove a stopping condition.
`cut`	Copy the stopping condition into the clipboard and removes the stopping condition from the list.
`paste`	Pastes the stopping condition from the clipboard and inserts into the list.
`insert_copy`	Copy the stopping condition and inserts the copy into the list.
`get_item_by_index`	Retrieve a stopping condition in the collection by index.
`get_item_by_name`	Retrieve a stopping condition in 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 StoppingConditionCollection

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

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

StoppingConditionCollection.item(self, index_or_name: Any) → StoppingConditionElement#

Allow you to iterate through the collection.

StoppingConditionCollection.add(self, condition_name: str) → StoppingConditionElement#

Add a stopping condition.

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

Remove a stopping condition.

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

Copy the stopping condition into the clipboard and removes the stopping condition from the list.

StoppingConditionCollection.paste(self) → StoppingConditionElement#

Pastes the stopping condition from the clipboard and inserts into the list.

StoppingConditionCollection.insert_copy(self, stop_cond: StoppingConditionElement) → StoppingConditionElement#

Copy the stopping condition and inserts the copy into the list.

StoppingConditionCollection.get_item_by_index(self, index: int) → StoppingConditionElement#

Retrieve a stopping condition in the collection by index.

StoppingConditionCollection.get_item_by_name(self, name: str) → StoppingConditionElement#

Retrieve a stopping condition in the collection by name.