ProcedureHover#

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

Class defining a hover procedure.

Overview#

Methods

`set_relative_course`	Set the relative heading change.
`set_absolute_course`	Set the absolute heading and reference.
`set_final_translation_course`	Set the option to have the final heading to match the translation bearing.
`get_as_procedure`	Get the procedure interface.

Properties

`altitude_options`	Get the altitude options.
`hover_mode`	Get or set the option to have the aircraft hover in place for a fixed time or to perform a hovering maneuver.
`fixed_time`	Get or set the time to hover in place.
`heading_mode`	Get or set the heading mode for the aircraft.
`final_heading_mode`	Get the mode to define the heading at the end of the hover.
`absolute_course`	Get the absolute course for the heading.
`relative_course`	Get the relative heading change.
`use_magnetic_heading`	Get the option to use a magnetic heading for the heading course.
`final_heading_rate`	Get or set the options to define the heading rate of the aircraft at the end of the procedure.
`translation_mode`	Define how the aircraft will translate during the hover.
`bearing`	Get or set the bearing of the translation during the hover.
`use_magnetic_bearing`	Get or set the option to use a magnetic heading for the translation bearing.
`range`	Get or set the range to translate during the hover.
`final_course_mode`	Get or set the mode to specify the final course at the end of the hover.
`smooth_translation_mode`	Get or set the translation mode of the aircraft at the end of the procedure.
`radius_factor`	Get or set the turn radius factor.

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

property ProcedureHover.altitude_options: HoverAltitudeOptions#: Get the altitude options.

property ProcedureHover.hover_mode: HoverMode#: Get or set the option to have the aircraft hover in place for a fixed time or to perform a hovering maneuver.

property ProcedureHover.fixed_time: Any#: Get or set the time to hover in place.

property ProcedureHover.heading_mode: VTOLHeadingMode#: Get or set the heading mode for the aircraft.

property ProcedureHover.final_heading_mode: VTOLFinalHeadingMode#: Get the mode to define the heading at the end of the hover.

property ProcedureHover.absolute_course: Any#: Get the absolute course for the heading.

property ProcedureHover.relative_course: Any#: Get the relative heading change.

property ProcedureHover.use_magnetic_heading: bool#: Get the option to use a magnetic heading for the heading course.

property ProcedureHover.final_heading_rate: VTOLRateMode#: Get or set the options to define the heading rate of the aircraft at the end of the procedure.

property ProcedureHover.translation_mode: VTOLTranslationMode#: Define how the aircraft will translate during the hover.

property ProcedureHover.bearing: Any#: Get or set the bearing of the translation during the hover.

property ProcedureHover.use_magnetic_bearing: bool#: Get or set the option to use a magnetic heading for the translation bearing.

property ProcedureHover.range: float#: Get or set the range to translate during the hover.

property ProcedureHover.final_course_mode: VTOLTranslationFinalCourseMode#: Get or set the mode to specify the final course at the end of the hover.

property ProcedureHover.smooth_translation_mode: VTOLRateMode#: Get or set the translation mode of the aircraft at the end of the procedure.

property ProcedureHover.radius_factor: float#: Get or set the turn radius factor.

ProcedureHover.set_relative_course(self, heading_change: Any) → None#

Set the relative heading change.

ProcedureHover.set_absolute_course(self, course: Any, is_magnetic: bool) → None#

Set the absolute heading and reference.

Parameters:

course : Any

is_magnetic : bool

Returns:

None

ProcedureHover.set_final_translation_course(self) → None#

Set the option to have the final heading to match the translation bearing.

ProcedureHover.get_as_procedure(self) → IProcedure#

Get the procedure interface.