PropagatorGreatArc

class ansys.stk.core.stkobjects.PropagatorGreatArc

Bases: IPropagator

Class defining the Great Arc propagator for an Aircraft, Ship or GroundVehicle.

Overview

Methods

propagate	Propagates the vehicle’s path using the specified time interval.
set_altitude_reference_type	Specify Waypoint Altitude Reference.
is_altitude_reference_type_supported	Get a value indicating whether the specified type can be used.
import_waypoints_from_file	Import waypoints from the filename specified. The filename must be an absolute path.
set_points_specify_time_and_propagate	Set waypoints from the array and propagates the route. The array is two-dimensional where each sub-array contains waypoint’s Time, Latitude, Longitude, Altitude and Turn Radius. The array must be in non-decreasing order with respect to time.
set_points_specify_velocity_and_propagate	Set waypoints from the array and propagates the route. The array is two-dimensional where each sub-array contains waypoint’s Latitude, Longitude, Altitude, Velocity, Acceleration and Turn Radius.
set_points_smooth_rate_and_propagate	Set waypoints from the array and propagates the route. The array is two-dimensional where each sub-array contains waypoint’s Latitude, Longitude, Altitude, Velocity and Turn Radius.

Properties

method	Compute waypoints.
altitude_reference_type	Reference altitude for waypoints.
altitude_reference_supported_types	Return an array of valid choices.
altitude_reference	Get the altitude reference.
arc_granularity	Get or set the frequency of interpolated points. Uses Angle Dimension.
waypoints	Get the waypoints.
ephemeris_interval	Get the propagator’s ephemeris interval.
default_altitude	Get or set the default altitude used when the first waypoint is added. Uses Distance Dimension.
default_rate	Get or set the default rate used when the first waypoint is added. Uses Rate Dimension.
default_turn_radius	Get or set the default turn radius used when the first waypoint is added. Uses Distance Dimension.

Import detail

from ansys.stk.core.stkobjects import PropagatorGreatArc

Property detail

property PropagatorGreatArc.method: VehicleWaypointComputationMethod

Compute waypoints.

property PropagatorGreatArc.altitude_reference_type: VehicleAltitudeReference

Reference altitude for waypoints.

property PropagatorGreatArc.altitude_reference_supported_types: list

Return an array of valid choices.

property PropagatorGreatArc.altitude_reference: IVehicleWaypointAltitudeReference

Get the altitude reference.

property PropagatorGreatArc.arc_granularity: float

Get or set the frequency of interpolated points. Uses Angle Dimension.

property PropagatorGreatArc.waypoints: VehicleWaypointsCollection

Get the waypoints.

property PropagatorGreatArc.ephemeris_interval: ITimeToolTimeIntervalSmartInterval

Get the propagator’s ephemeris interval.

property PropagatorGreatArc.default_altitude: float

Get or set the default altitude used when the first waypoint is added. Uses Distance Dimension.

property PropagatorGreatArc.default_rate: float

Get or set the default rate used when the first waypoint is added. Uses Rate Dimension.

property PropagatorGreatArc.default_turn_radius: float

Get or set the default turn radius used when the first waypoint is added. Uses Distance Dimension.

Method detail

PropagatorGreatArc.propagate(self) → None

Propagates the vehicle’s path using the specified time interval.

Returns:

None

PropagatorGreatArc.set_altitude_reference_type(self, altitude_ref: VehicleAltitudeReference) → None

Specify Waypoint Altitude Reference.

Parameters:

altitude_ref : VehicleAltitudeReference

Returns:

None

PropagatorGreatArc.is_altitude_reference_type_supported(self, altitude_ref: VehicleAltitudeReference) → bool

Get a value indicating whether the specified type can be used.

Parameters:

altitude_ref : VehicleAltitudeReference

Returns:

bool

PropagatorGreatArc.import_waypoints_from_file(self, filename: str) → None

Import waypoints from the filename specified. The filename must be an absolute path.

Parameters:

filename : str

Returns:

None

PropagatorGreatArc.set_points_specify_time_and_propagate(self, array_of_way_points: list) → None

Set waypoints from the array and propagates the route. The array is two-dimensional where each sub-array contains waypoint’s Time, Latitude, Longitude, Altitude and Turn Radius. The array must be in non-decreasing order with respect to time.

Parameters:

array_of_way_points : list

Returns:

None

PropagatorGreatArc.set_points_specify_velocity_and_propagate(self, array_of_way_points: list) → None

Set waypoints from the array and propagates the route. The array is two-dimensional where each sub-array contains waypoint’s Latitude, Longitude, Altitude, Velocity, Acceleration and Turn Radius.

Parameters:

array_of_way_points : list

Returns:

None

PropagatorGreatArc.set_points_smooth_rate_and_propagate(self, array_of_way_points: list) → None

Set waypoints from the array and propagates the route. The array is two-dimensional where each sub-array contains waypoint’s Latitude, Longitude, Altitude, Velocity and Turn Radius.

Parameters:

array_of_way_points : list

Returns:

None