ProcedureInFormation#

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

Bases: IProcedure

Class defining an In Formation procedure.

Overview#

get_as_procedure

Get the procedure interface.

flight_mode

Get or set the type of performance model that the aircraft will use to fly the maneuver.

formation_point

Get or set the position that the aircraft will be locked onto while in formation.

transition_time

Get or set the amount of time that the aircraft will spend transitioning from the altitude offset to a zero altitude offset.

hold_time

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.

trajectory_blending

Get or set the interpolation mode to determine the aircraft’s position and velocity.

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.

Import detail#

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

Property detail#

property ProcedureInFormation.flight_mode: PhaseOfFlight#

Get or set the type of performance model that the aircraft will use to fly the maneuver.

property ProcedureInFormation.formation_point: str#

Get or set the position that the aircraft will be locked onto while in formation.

property ProcedureInFormation.transition_time: float#

Get or set the amount of time that the aircraft will spend transitioning from the altitude offset to a zero altitude offset.

property ProcedureInFormation.hold_time: Any#

Get or set the amount of time that the aircraft will pause at a zero altitude offset.

property ProcedureInFormation.display_step_time: float#

Get or set the time interval at which ephemeris is generated for display purposes.

property ProcedureInFormation.trajectory_blending: TrajectoryBlendMode#

Get or set the interpolation mode to determine the aircraft’s position and velocity.

property ProcedureInFormation.fuel_flow_type: FuelFlowType#

Get or set the source used to calculate the fuel flow for the maneuver.

property ProcedureInFormation.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 ProcedureInFormation.consider_acceleration_for_fuel_flow: bool#

Get or set the option to calculate the fuel flow rate according to the acceleration of the aircraft.

Method detail#

ProcedureInFormation.get_as_procedure(self) IProcedure#

Get the procedure interface.

Returns:

IProcedure