ProcedureHoldingCircular#

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

Bases: IProcedure

Class defining a holding circular procedure.

Overview#

get_minimum_diameter

Get the aircraft’s minimum diameter at this altitude.

get_as_procedure

Get the procedure interface.

altitude_options

Get the altitude options.

profile_mode

Get or set the mode defines how the aircraft will perform the holding pattern.

level_off_mode

Get or set the mode for the level off maneuver.

bearing

Get or set the bearing of the holding point from the site.

use_magnetic_heading

Get or set the option to use a magnetic heading.

range

Get or set the distance to the holding point from the site.

diameter

Get or set the diameter of the holding pattern.

use_alternate_entry_points

Get or set the option to enter the holding pattern from an alternate point.

turn_direction

Get or set the turn direction to enter the holding pattern.

turns

Get or set the number of full turns.

refuel_dump_mode

Get or set the mode that defines when the aircraft will leave the holding pattern for a Refuel/Dump operation.

hold_cruise_airspeed_options

Get the hold cruise airspeed options.

enroute_options

Get the enroute options.

enroute_cruise_airspeed_options

Get the enroute cruise airspeed options.

enroute_turn_direction_options

Get the enroute turn direction options.

Import detail#

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

Property detail#

property ProcedureHoldingCircular.altitude_options: AltitudeMSLOptions#

Get the altitude options.

property ProcedureHoldingCircular.profile_mode: HoldingProfileMode#

Get or set the mode defines how the aircraft will perform the holding pattern.

property ProcedureHoldingCircular.level_off_mode: AltitudeConstraintManeuverMode#

Get or set the mode for the level off maneuver.

property ProcedureHoldingCircular.bearing: Any#

Get or set the bearing of the holding point from the site.

property ProcedureHoldingCircular.use_magnetic_heading: bool#

Get or set the option to use a magnetic heading.

property ProcedureHoldingCircular.range: float#

Get or set the distance to the holding point from the site.

property ProcedureHoldingCircular.diameter: float#

Get or set the diameter of the holding pattern.

property ProcedureHoldingCircular.use_alternate_entry_points: bool#

Get or set the option to enter the holding pattern from an alternate point.

property ProcedureHoldingCircular.turn_direction: HoldingDirection#

Get or set the turn direction to enter the holding pattern.

property ProcedureHoldingCircular.turns: int#

Get or set the number of full turns.

property ProcedureHoldingCircular.refuel_dump_mode: HoldRefuelDumpMode#

Get or set the mode that defines when the aircraft will leave the holding pattern for a Refuel/Dump operation.

property ProcedureHoldingCircular.hold_cruise_airspeed_options: CruiseAirspeedOptions#

Get the hold cruise airspeed options.

property ProcedureHoldingCircular.enroute_options: IEnrouteAndDelayOptions#

Get the enroute options.

property ProcedureHoldingCircular.enroute_cruise_airspeed_options: CruiseAirspeedOptions#

Get the enroute cruise airspeed options.

property ProcedureHoldingCircular.enroute_turn_direction_options: EnrouteTurnDirectionOptions#

Get the enroute turn direction options.

Method detail#

ProcedureHoldingCircular.get_minimum_diameter(self) float#

Get the aircraft’s minimum diameter at this altitude.

Returns:

float

ProcedureHoldingCircular.get_as_procedure(self) IProcedure#

Get the procedure interface.

Returns:

IProcedure