ThirdBodyFunction

class ansys.stk.core.stkobjects.astrogator.ThirdBodyFunction

Bases: IComponentInfo, ICloneable

ThirdBody propagator function.

Overview

Methods

set_mode_type

Set the third body gravity mode.

Properties

third_body_name	Get or set the selected third body model.
ephemeris_source	Source for the third body’s ephemeris.
mode	Get the third body gravity mode. The IComponentInfo object returned by this property can be cast to GravityFieldFunction or PointMassFunction depending on the selected ModeType.
mode_type	Get the third body gravity mode type.
ephemeris_source_warning	Return a warning message if the Ephemeris source and the gravity are not compatible.

Import detail

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

Property detail

property ThirdBodyFunction.third_body_name: str

Get or set the selected third body model.

property ThirdBodyFunction.ephemeris_source: EphemerisSource

Source for the third body’s ephemeris.

property ThirdBodyFunction.mode: IComponentInfo

Get the third body gravity mode. The IComponentInfo object returned by this property can be cast to GravityFieldFunction or PointMassFunction depending on the selected ModeType.

property ThirdBodyFunction.mode_type: ThirdBodyMode

Get the third body gravity mode type.

property ThirdBodyFunction.ephemeris_source_warning: str

Return a warning message if the Ephemeris source and the gravity are not compatible.

Method detail

ThirdBodyFunction.set_mode_type(self, mode: ThirdBodyMode) → None

Set the third body gravity mode.

Parameters:

mode : ThirdBodyMode

Returns:

None