CalculationToolParameterSetOrbit#

class ansys.stk.core.analysis_workbench.CalculationToolParameterSetOrbit#

Bases: ICalculationToolParameterSet, IAnalysisWorkbenchComponent

Orbit parameter set contains various trajectory representations of an orbiting point.

Overview#

orbiting_point

Get the point for which orbital parameters are computed.

reference_system

Get the reference system in which orbital parameters are computed. Only used if the option to specify reference system is selected.

gravitational_parameter

Get the gravitational parameter for the mass relative to which orbital parameters are computed. Only used if the option to specify gravitational parameter is selected.

central_body

Get the central body relative to which orbital parameters are computed.

use_central_body_gravitational_parameter

Get the option that determines whether to specify the gravitational parameter value or to inherit it from the central body.

use_central_body_inertial

Get the option that determines whether to specify the reference coordinate system or to the inherit inertial reference system from the central body.

Import detail#

from ansys.stk.core.analysis_workbench import CalculationToolParameterSetOrbit

Property detail#

property CalculationToolParameterSetOrbit.orbiting_point: IVectorGeometryToolPoint#

Get the point for which orbital parameters are computed.

property CalculationToolParameterSetOrbit.reference_system: IVectorGeometryToolSystem#

Get the reference system in which orbital parameters are computed. Only used if the option to specify reference system is selected.

property CalculationToolParameterSetOrbit.gravitational_parameter: float#

Get the gravitational parameter for the mass relative to which orbital parameters are computed. Only used if the option to specify gravitational parameter is selected.

property CalculationToolParameterSetOrbit.central_body: str#

Get the central body relative to which orbital parameters are computed.

property CalculationToolParameterSetOrbit.use_central_body_gravitational_parameter: bool#

Get the option that determines whether to specify the gravitational parameter value or to inherit it from the central body.

property CalculationToolParameterSetOrbit.use_central_body_inertial: bool#

Get the option that determines whether to specify the reference coordinate system or to the inherit inertial reference system from the central body.