IOrbitState

class ansys.stk.core.stkutil.IOrbitState

Interface to set and retrieve the coordinate type used to specify the orbit state.

Overview

Methods

convert_to	Change the coordinate type to the type specified.
assign	Assign a new coordinate type.
assign_classical	Assign a new orbit state using Classical representation.
assign_cartesian	Assign a new orbit state using Cartesian representation.
assign_geodetic	Assign a new orbit state using Geodetic representation.
assign_equinoctial_posigrade	Assign a new orbit state using Equinoctial representation.
assign_equinoctial_retrograde	Assign a new orbit state using Equinoctial representation.
assign_mixed_spherical	Assign a new orbit state using Mixed Spherical representation.
assign_spherical	Assign a new orbit state using Spherical representation.

Properties

orbit_state_type	Return the coordinate type currently being used.
central_body_name	Get the central body.
epoch	Get or set the state epoch.

Import detail

from ansys.stk.core.stkutil import IOrbitState

Property detail

property IOrbitState.orbit_state_type: OrbitStateType

Return the coordinate type currently being used.

property IOrbitState.central_body_name: str

Get the central body.

property IOrbitState.epoch: Any

Get or set the state epoch.

Method detail

IOrbitState.convert_to(self, type: OrbitStateType) → IOrbitState

Change the coordinate type to the type specified.

Parameters:

type : OrbitStateType

Returns:

IOrbitState

IOrbitState.assign(self, orbit_state: IOrbitState) → None

Assign a new coordinate type.

Parameters:

orbit_state : IOrbitState

Returns:

None

IOrbitState.assign_classical(self, coordinate_system: CoordinateSystem, semi_major_axis: float, eccentricity: float, inclination: float, arg_of_perigee: float, raan: float, mean_anomaly: float) → None

Assign a new orbit state using Classical representation.

Parameters:

coordinate_system : CoordinateSystem

semi_major_axis : float

eccentricity : float

inclination : float

arg_of_perigee : float

raan : float

mean_anomaly : float

Returns:

None

IOrbitState.assign_cartesian(self, coordinate_system: CoordinateSystem, x_position: float, y_position: float, z_position: float, x_velocity: float, y_velocity: float, z_velocity: float) → None

Assign a new orbit state using Cartesian representation.

Parameters:

coordinate_system : CoordinateSystem

x_position : float

y_position : float

z_position : float

x_velocity : float

y_velocity : float

z_velocity : float

Returns:

None

IOrbitState.assign_geodetic(self, coordinate_system: CoordinateSystem, latitude: float, longitude: float, altitude: float, latitude_rate: float, longitude_rate: float, altitude_rate: float) → None

Assign a new orbit state using Geodetic representation.

Parameters:

coordinate_system : CoordinateSystem

latitude : float

longitude : float

altitude : float

latitude_rate : float

longitude_rate : float

altitude_rate : float

Returns:

None

IOrbitState.assign_equinoctial_posigrade(self, coordinate_system: CoordinateSystem, semi_major_axis: float, h: float, k: float, p: float, q: float, mean_lon: float) → None

Assign a new orbit state using Equinoctial representation.

Parameters:

coordinate_system : CoordinateSystem

semi_major_axis : float

h : float

k : float

p : float

q : float

mean_lon : float

Returns:

None

IOrbitState.assign_equinoctial_retrograde(self, coordinate_system: CoordinateSystem, semi_major_axis: float, h: float, k: float, p: float, q: float, mean_lon: float) → None

Assign a new orbit state using Equinoctial representation.

Parameters:

coordinate_system : CoordinateSystem

semi_major_axis : float

h : float

k : float

p : float

q : float

mean_lon : float

Returns:

None

IOrbitState.assign_mixed_spherical(self, coordinate_system: CoordinateSystem, latitude: float, longitude: float, altitude: float, horizontal_flight_path_angle: float, flight_path_azimuth: float, velocity: float) → None

Assign a new orbit state using Mixed Spherical representation.

Parameters:

coordinate_system : CoordinateSystem

latitude : float

longitude : float

altitude : float

horizontal_flight_path_angle : float

flight_path_azimuth : float

velocity : float

Returns:

None

IOrbitState.assign_spherical(self, coordinate_system: CoordinateSystem, right_ascension: float, declination: float, radius: float, horizontal_flight_path_angle: float, flight_path_azimuth: float, velocity: float) → None

Assign a new orbit state using Spherical representation.

Parameters:

coordinate_system : CoordinateSystem

right_ascension : float

declination : float

radius : float

horizontal_flight_path_angle : float

flight_path_azimuth : float

velocity : float

Returns:

None