PropagatorHPOPThirdBodyGravityCollection#

class ansys.stk.core.stkobjects.PropagatorHPOPThirdBodyGravityCollection#

Collection of third-body gravity options for the LOP propagator.

Overview#

item

Given an index, returns an element in the collection.

remove_at

Remove an element from the collection using specified index.

remove_all

Remove all elements from the collection.

add_third_body

Add a new element to the collection.

remove_third_body

Remove an element from the collection.

count

Return the number of elements in a collection.

_new_enum

Return an enumerator that can iterate through the collection.

available_third_body_names

Get the available third bodies. The return result is a collection of strings representing names of the central bodies that can be used as third body.

Import detail#

from ansys.stk.core.stkobjects import PropagatorHPOPThirdBodyGravityCollection

Property detail#

property PropagatorHPOPThirdBodyGravityCollection.count: int#

Return the number of elements in a collection.

property PropagatorHPOPThirdBodyGravityCollection._new_enum: EnumeratorProxy#

Return an enumerator that can iterate through the collection.

property PropagatorHPOPThirdBodyGravityCollection.available_third_body_names: list#

Get the available third bodies. The return result is a collection of strings representing names of the central bodies that can be used as third body.

Method detail#

PropagatorHPOPThirdBodyGravityCollection.item(self, index: int) PropagatorHPOPThirdBodyGravityElement#

Given an index, returns an element in the collection.

Parameters:

index : int

Returns:

PropagatorHPOPThirdBodyGravityElement

PropagatorHPOPThirdBodyGravityCollection.remove_at(self, index: int) None#

Remove an element from the collection using specified index.

Parameters:

index : int

Returns:

None

PropagatorHPOPThirdBodyGravityCollection.remove_all(self) None#

Remove all elements from the collection.

Returns:

None

PropagatorHPOPThirdBodyGravityCollection.add_third_body(self, third_body: str) PropagatorHPOPThirdBodyGravityElement#

Add a new element to the collection.

Parameters:

third_body : str

Returns:

PropagatorHPOPThirdBodyGravityElement

PropagatorHPOPThirdBodyGravityCollection.remove_third_body(self, third_body: str) None#

Remove an element from the collection.

Parameters:

third_body : str

Returns:

None