ProcedureFormationRecover#

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

Bases: IProcedure

Class defining a Formation/Recover procedure.

Overview#

Methods

`get_as_procedure`	Get the procedure interface.
`get_minimum_time`	Get the minimum time at which formation might be possible. Opt whether to consider previous procedure(s) for the minimum time.
`find_first_valid_start_time`	Have Aviator calculate the earliest valid formation time.

Properties

`enroute_options`	Get the enroute options.
`delay_cruise_airspeed_options`	Get the delay cruise airspeed options.
`start_time`	Get or set the time at which the formation begins.
`maximum_time`	Get the maximum time at which formation might be possible.
`formation_point`	Get or set the position that the aircraft will be locked onto while in formation.
`interpolate_point_position_velocity`	Get or set the option to use interpolation to determine the formation point’s speed and position.
`altitude_offset`	Get or set the altitude distance between the aircraft and the formation point during the first or second pause.
`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.
`consider_acceleration_for_fuel_flow`	Get or set the option to calculate the fuel flow rate according to the acceleration of the aircraft.
`first_pause`	Get or set the amount of time that the aircraft will pause at the specified altitude offset.
`transition_time`	Get or set the amount of time that the aircraft will spend transitioning from the specified altitude offset to a zero altitude offset.
`second_pause`	Get or set the amount of time that the aircraft will pause at a zero altitude offset.
`display_step_time`	Get or set the time interval at which ephemeris is generated for display purposes.
`flight_mode`	Get or set the type of performance model that the aircraft will use to fly the maneuver.
`flight_path_angle`	Get or set the flight path angle at the beginning of the first pause.
`radius_factor`	Get or set the maximum amount the radius of vertical curve will be increased to minimize the flight path angle required to complete it.
`use_delay`	Get or set the option to insert a delay at the beginning of the procedure.
`delay_turn_direction`	Get or set the turn direction of the delay.

Import detail#

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

Property detail#

property ProcedureFormationRecover.enroute_options: EnrouteOptions#: Get the enroute options.

property ProcedureFormationRecover.delay_cruise_airspeed_options: CruiseAirspeedOptions#: Get the delay cruise airspeed options.

property ProcedureFormationRecover.start_time: Any#: Get or set the time at which the formation begins.

property ProcedureFormationRecover.maximum_time: Any#: Get the maximum time at which formation might be possible.

property ProcedureFormationRecover.formation_point: str#: Get or set the position that the aircraft will be locked onto while in formation.

property ProcedureFormationRecover.interpolate_point_position_velocity: bool#: Get or set the option to use interpolation to determine the formation point’s speed and position.

property ProcedureFormationRecover.altitude_offset: float#: Get or set the altitude distance between the aircraft and the formation point during the first or second pause.

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

property ProcedureFormationRecover.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 ProcedureFormationRecover.consider_acceleration_for_fuel_flow: bool#: Get or set the option to calculate the fuel flow rate according to the acceleration of the aircraft.

property ProcedureFormationRecover.first_pause: Any#: Get or set the amount of time that the aircraft will pause at the specified altitude offset.

property ProcedureFormationRecover.transition_time: float#: Get or set the amount of time that the aircraft will spend transitioning from the specified altitude offset to a zero altitude offset.

property ProcedureFormationRecover.second_pause: Any#: Get or set the amount of time that the aircraft will pause at a zero altitude offset.

property ProcedureFormationRecover.display_step_time: float#: Get or set the time interval at which ephemeris is generated for display purposes.

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

property ProcedureFormationRecover.flight_path_angle: Any#: Get or set the flight path angle at the beginning of the first pause.

property ProcedureFormationRecover.radius_factor: float#: Get or set the maximum amount the radius of vertical curve will be increased to minimize the flight path angle required to complete it.

property ProcedureFormationRecover.use_delay: bool#: Get or set the option to insert a delay at the beginning of the procedure.

property ProcedureFormationRecover.delay_turn_direction: DelayTurnDirection#: Get or set the turn direction of the delay.

Method detail#

ProcedureFormationRecover.get_as_procedure(self) → IProcedure#

Get the procedure interface.

Returns:: IProcedure

ProcedureFormationRecover.get_minimum_time(self, consider_prev_proc: bool) → Any#

Get the minimum time at which formation might be possible. Opt whether to consider previous procedure(s) for the minimum time.

Parameters:: consider_prev_proc : bool
Returns:: Any

ProcedureFormationRecover.find_first_valid_start_time(self, min_time: Any, max_time: Any, step_time: float) → Any#

Have Aviator calculate the earliest valid formation time.

Parameters:

min_time : Any

max_time : Any

step_time : float

Returns:

Any