BasicManeuverStrategyAutopilotProf#

class ansys.stk.core.stkobjects.aviator.BasicManeuverStrategyAutopilotProf#

Bases: IBasicManeuverStrategy

Class defining the autopiloc - vertical plane strategy for a basic maneuver procedure.

Overview#

altitude_mode

Get or set the altitude mode of the autopilot - vertical plane strategy.

absolute_altitude

Get or set the absolute altitude for the specify altitude mode.

relative_altitude_change

Get or set the relative altitude change for the specify altitude change mode.

altitude_rate

Get or set the altitude rate for the specify altitude rate mode.

flight_path_angle

Get or set the flight path angle for the specify wind frame flight path angle mode.

altitude_control_mode

Get or set the altitude control mode for the hold initial altitude, specify altitude, and specify altitude change modes.

control_altitude_rate_value

Get or set the altitude rate control value for the hold initial altitude, specify altitude, and specify altitude change modes.

control_flight_path_angle_value

Get or set the control flight path angle value for the hold initial altitude, specify altitude, and specify altitude change modes.

control_limit_mode

Get or set the control limits mode.

max_pitch_rate

Get or set the max pitch rate for the control limits.

fly_ballistic

Get or set the option to fly a ballistic trajectory when the performance is insufficient.

damping_ratio

Get or set the damping ratio of the control law.

airspeed_options

Get the airspeed options.

compensate_for_coriolis_acceleration

Get or set the option to compensate for the acceleration due to the Coriolis effect.

stop_when_conditions_met

Stop when conditions are met.

Examples#

Add and configure a basic maneuver procedure

# IProcedureCollection procedures: Procedure Collection object
# Add a basic maneuver procedure
basicManeuver = procedures.add(SiteType.SITE_END_OF_PREV_PROCEDURE, ProcedureType.PROCEDURE_BASIC_MANEUVER)

# Set the navigation to use a Straight Ahead strategy
basicManeuver.navigation_strategy_type = "Straight Ahead"
# Get the options for the straight ahead strategy
straightAhead = basicManeuver.navigation
# Opt to maintain course (as opposed to maintain heading)
straightAhead.reference_frame = StraightAheadReferenceFrame.MAINTAIN_COURSE

# Set the profile to use a Autopilot - Vertical Plane strategy
basicManeuver.profile_strategy_type = "Autopilot - Vertical Plane"
# Get the options for the profile strategy
autopilot = basicManeuver.profile
# Opt to maintain the initial altitude
autopilot.altitude_mode = AutopilotAltitudeMode.AUTOPILOT_HOLD_INIT_ALTITUDE
airspeedOptions = autopilot.airspeed_options
# Opt to maintain a specified airspeed
airspeedOptions.airspeed_mode = BasicManeuverAirspeedMode.MAINTAIN_SPECIFIED_AIRSPEED
# Specify the airspeed
airspeedOptions.specified_airspeed = 250

# Configure the options on the Attitude / Performance / Fuel page
basicManeuver.flight_mode = PhaseOfFlight.FLIGHT_PHASE_CRUISE
# Override the fuel flow
basicManeuver.fuel_flow_type = BasicManeuverFuelFlowType.BASIC_MANEUVER_FUEL_FLOW_OVERRIDE
basicManeuver.override_fuel_flow_value = 1000

# Set the basic stopping conditions
basicManeuver.use_max_downrange = True
basicManeuver.max_downrange = 10
basicManeuver.use_stop_fuel_state = False
basicManeuver.use_max_time_of_flight = False

Import detail#

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

Property detail#

property BasicManeuverStrategyAutopilotProf.altitude_mode: AutopilotAltitudeMode#

Get or set the altitude mode of the autopilot - vertical plane strategy.

property BasicManeuverStrategyAutopilotProf.absolute_altitude: float#

Get or set the absolute altitude for the specify altitude mode.

property BasicManeuverStrategyAutopilotProf.relative_altitude_change: float#

Get or set the relative altitude change for the specify altitude change mode.

property BasicManeuverStrategyAutopilotProf.altitude_rate: float#

Get or set the altitude rate for the specify altitude rate mode.

property BasicManeuverStrategyAutopilotProf.flight_path_angle: Any#

Get or set the flight path angle for the specify wind frame flight path angle mode.

property BasicManeuverStrategyAutopilotProf.altitude_control_mode: AutopilotAltitudeControlMode#

Get or set the altitude control mode for the hold initial altitude, specify altitude, and specify altitude change modes.

property BasicManeuverStrategyAutopilotProf.control_altitude_rate_value: float#

Get or set the altitude rate control value for the hold initial altitude, specify altitude, and specify altitude change modes.

property BasicManeuverStrategyAutopilotProf.control_flight_path_angle_value: Any#

Get or set the control flight path angle value for the hold initial altitude, specify altitude, and specify altitude change modes.

property BasicManeuverStrategyAutopilotProf.control_limit_mode: PerformanceModelOverride#

Get or set the control limits mode.

property BasicManeuverStrategyAutopilotProf.max_pitch_rate: Any#

Get or set the max pitch rate for the control limits.

property BasicManeuverStrategyAutopilotProf.fly_ballistic: bool#

Get or set the option to fly a ballistic trajectory when the performance is insufficient.

property BasicManeuverStrategyAutopilotProf.damping_ratio: float#

Get or set the damping ratio of the control law.

property BasicManeuverStrategyAutopilotProf.airspeed_options: BasicManeuverAirspeedOptions#

Get the airspeed options.

property BasicManeuverStrategyAutopilotProf.compensate_for_coriolis_acceleration: bool#

Get or set the option to compensate for the acceleration due to the Coriolis effect.

property BasicManeuverStrategyAutopilotProf.stop_when_conditions_met: bool#

Stop when conditions are met.