ProcedureBasicManeuver#

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

Bases: IProcedure

Class defining a Basic Maneuver procedure.

Overview#

Methods

get_as_procedure

Get the procedure interface.

Properties

`max_time_of_flight`	Get the max time of flight.
`use_max_time_of_flight`	Get whether to use max time of flight.
`stop_fuel_state`	Get the stop fuel state value.
`use_stop_fuel_state`	Get whether to use stop fuel state.
`max_downrange`	Get the max down range.
`use_max_downrange`	Get whether to use max down range.
`altitude_limit_mode`	Get the altitude limit mode.
`terrain_impact_mode`	Get the terrain impact mode.
`terrain_impact_time_offset`	Get the terrain impact time offset.
`navigation_strategy_type`	Get the navigation strategy type.
`navigation`	Get the interface for the navigation strategy.
`profile_strategy_type`	Get the profile strategy type.
`profile`	Get the interface for the profile strategy.
`flight_mode`	Get or set the type of performance model that the aircraft will use to fly the maneuver.
`fuel_flow_type`	Get or set the source used to calculate the fuel flow for the maneuver.
`override_fuel_flow_value`	Get or set the value used for the Override Fuel Flow type. The fuel flow type must be set to Override to access this value.
`scale_fuel_flow`	Opt whether to scale the fuel flow based on the aircraft’s actual attitude.
`attitude_blend_time`	Get or set the amount of time that the aircraft will spend transitioning from the attitude of the previous maneuver to the attitude at the beginning of the current maneuver.
`control_time_constant`	A smoothing constant for the performance of control surfaces.

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 ProcedureBasicManeuver

Property detail#

property ProcedureBasicManeuver.max_time_of_flight: Any#: Get the max time of flight.

property ProcedureBasicManeuver.use_max_time_of_flight: bool#: Get whether to use max time of flight.

property ProcedureBasicManeuver.stop_fuel_state: float#: Get the stop fuel state value.

property ProcedureBasicManeuver.use_stop_fuel_state: bool#: Get whether to use stop fuel state.

property ProcedureBasicManeuver.max_downrange: float#: Get the max down range.

property ProcedureBasicManeuver.use_max_downrange: bool#: Get whether to use max down range.

property ProcedureBasicManeuver.altitude_limit_mode: BasicManeuverAltitudeLimit#: Get the altitude limit mode.

property ProcedureBasicManeuver.terrain_impact_mode: BasicManeuverAltitudeLimit#: Get the terrain impact mode.

property ProcedureBasicManeuver.terrain_impact_time_offset: float#: Get the terrain impact time offset.

property ProcedureBasicManeuver.navigation_strategy_type: str#: Get the navigation strategy type.

property ProcedureBasicManeuver.navigation: IBasicManeuverStrategy#: Get the interface for the navigation strategy.

property ProcedureBasicManeuver.profile_strategy_type: str#: Get the profile strategy type.

property ProcedureBasicManeuver.profile: IBasicManeuverStrategy#: Get the interface for the profile strategy.

property ProcedureBasicManeuver.flight_mode: PhaseOfFlight#: Get or set the type of performance model that the aircraft will use to fly the maneuver.

property ProcedureBasicManeuver.fuel_flow_type: BasicManeuverFuelFlowType#: Get or set the source used to calculate the fuel flow for the maneuver.

property ProcedureBasicManeuver.override_fuel_flow_value: float#: Get or set the value used for the Override Fuel Flow type. The fuel flow type must be set to Override to access this value.

property ProcedureBasicManeuver.scale_fuel_flow: bool#: Opt whether to scale the fuel flow based on the aircraft’s actual attitude.

property ProcedureBasicManeuver.attitude_blend_time: float#: Get or set the amount of time that the aircraft will spend transitioning from the attitude of the previous maneuver to the attitude at the beginning of the current maneuver.

property ProcedureBasicManeuver.control_time_constant: float#: A smoothing constant for the performance of control surfaces.

Method detail#

ProcedureBasicManeuver.get_as_procedure(self) → IProcedure#

Get the procedure interface.

Returns:: IProcedure