ReferenceStateForwardFlightOptions

class ansys.stk.core.stkobjects.aviator.ReferenceStateForwardFlightOptions

Class defining the Forward Flight options for a Reference State procedure.

Overview

Methods

set_airspeed	Set the launch airspeed.
set_longitudinal_acceleration	Set the longitudinal acceleration.
set_lateral_acceleration	Set the lateral acceleration.
set_attitude_rate	Set the vertical attitude rate.

Properties

airspeed_type	Get the airspeed type.
airspeed	Get the goal airspeed for the launch.
altitude_rate	Get or set the rate at which the aircraft will climb or descend.
flight_path_angle	Get or set the initial pitch angle of the flight path.
tas_dot	Get the true airspeed acceleration.
groundspeed_dot	Get the groundspeed acceleration.
longitudinal_acceleration_type	Get the mode to specify the longitudinal acceleration.
heading	Get or set the direction the aircraft is pointing.
heading_is_magnetic	Opt whether to specify the heading using magnetic North.
course	Get or set the direction the aircraft is traveling.
course_is_magnetic	Opt whether to specify the course using magnetic North.
heading_dot	Get the heading rate of change.
course_dot	Get the course rate of change.
lateral_acceleration_type	Get the mode to specify the lateral acceleration.
roll_angle	Get or set the aircraft’s bank angle.
aoa	Get or set the aircraft’s angle of attack.
sideslip	Get or set the aircraft’s yaw angle.
pitch_rate	Get the aircraft’s pitch rate.
push_pull_g	Get the G force on the aircraft resulting from its attitude.
attitude_rate_type	Get the mode to specify the vertical attitude rate.

Import detail

from ansys.stk.core.stkobjects.aviator import ReferenceStateForwardFlightOptions

Property detail

property ReferenceStateForwardFlightOptions.airspeed_type: AirspeedType

Get the airspeed type.

property ReferenceStateForwardFlightOptions.airspeed: float

Get the goal airspeed for the launch.

property ReferenceStateForwardFlightOptions.altitude_rate: float

Get or set the rate at which the aircraft will climb or descend.

property ReferenceStateForwardFlightOptions.flight_path_angle: Any

Get or set the initial pitch angle of the flight path.

property ReferenceStateForwardFlightOptions.tas_dot: float

Get the true airspeed acceleration.

property ReferenceStateForwardFlightOptions.groundspeed_dot: float

Get the groundspeed acceleration.

property ReferenceStateForwardFlightOptions.longitudinal_acceleration_type: ReferenceStateLongitudinalAccelerationMode

Get the mode to specify the longitudinal acceleration.

property ReferenceStateForwardFlightOptions.heading: Any

Get or set the direction the aircraft is pointing.

property ReferenceStateForwardFlightOptions.heading_is_magnetic: bool

Opt whether to specify the heading using magnetic North.

property ReferenceStateForwardFlightOptions.course: Any

Get or set the direction the aircraft is traveling.

property ReferenceStateForwardFlightOptions.course_is_magnetic: bool

Opt whether to specify the course using magnetic North.

property ReferenceStateForwardFlightOptions.heading_dot: Any

Get the heading rate of change.

property ReferenceStateForwardFlightOptions.course_dot: Any

Get the course rate of change.

property ReferenceStateForwardFlightOptions.lateral_acceleration_type: ReferenceStateLateralAccelerationMode

Get the mode to specify the lateral acceleration.

property ReferenceStateForwardFlightOptions.roll_angle: Any

Get or set the aircraft’s bank angle.

property ReferenceStateForwardFlightOptions.aoa: Any

Get or set the aircraft’s angle of attack.

property ReferenceStateForwardFlightOptions.sideslip: Any

Get or set the aircraft’s yaw angle.

property ReferenceStateForwardFlightOptions.pitch_rate: Any

Get the aircraft’s pitch rate.

property ReferenceStateForwardFlightOptions.push_pull_g: float

Get the G force on the aircraft resulting from its attitude.

property ReferenceStateForwardFlightOptions.attitude_rate_type: ReferenceStateAttitudeMode

Get the mode to specify the vertical attitude rate.

Method detail

ReferenceStateForwardFlightOptions.set_airspeed(self, airspeed_type: AirspeedType, airspeed: float) → None

Set the launch airspeed.

Parameters:

airspeed_type : AirspeedType

airspeed : float

Returns:

None

ReferenceStateForwardFlightOptions.set_longitudinal_acceleration(self, accel_type: ReferenceStateLongitudinalAccelerationMode, value: float) → None

Set the longitudinal acceleration.

Parameters:

accel_type : ReferenceStateLongitudinalAccelerationMode

value : float

Returns:

None

ReferenceStateForwardFlightOptions.set_lateral_acceleration(self, accel_type: ReferenceStateLateralAccelerationMode, value: Any) → None

Set the lateral acceleration.

Parameters:

accel_type : ReferenceStateLateralAccelerationMode

value : Any

Returns:

None

ReferenceStateForwardFlightOptions.set_attitude_rate(self, attitude_rate_type: ReferenceStateAttitudeMode, value: Any) → None

Set the vertical attitude rate.

Parameters:

attitude_rate_type : ReferenceStateAttitudeMode

value : Any

Returns:

None