ReferenceStateHoverOptions#

class ansys.stk.core.stkobjects.aviator.ReferenceStateHoverOptions#: Class defining the Hover options for a Reference State procedure.

Overview#

Methods

`set_longitudinal_acceleration`	Set the longitudinal acceleration.
`set_attitude_rate`	Set the vertical attitude rate.

Properties

`groundspeed`	Get or set the aircraft’s speed relative to the ground.
`altitude_rate`	Get or set the rate at which the aircraft will climb or descend.
`tas_dot`	Get the true airspeed acceleration.
`groundspeed_dot`	Get the groundspeed acceleration.
`longitudinal_acceleration_type`	Get the mode to specify the longitudinal acceleration.
`heading`	Get or set the direction the aircraft is pointing.
`heading_is_magnetic`	Opt whether to specify the heading using magnetic North.
`course`	Get or set the direction the aircraft is traveling.
`course_is_magnetic`	Opt whether to specify the course using magnetic North.
`heading_dot`	Get or set the heading rate of change.
`course_dot`	Get or set the course rate of change.
`roll_angle`	Get or set the aircraft’s bank angle.
`aoa`	Get or set the aircraft’s angle of attack.
`pitch_rate`	Get the aircraft’s pitch rate.
`push_pull_g`	Get the G force on the aircraft resulting from its attitude.
`attitude_rate_type`	Get the mode to specify the vertical attitude rate.

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

property ReferenceStateHoverOptions.groundspeed: float#: Get or set the aircraft’s speed relative to the ground.

property ReferenceStateHoverOptions.altitude_rate: float#: Get or set the rate at which the aircraft will climb or descend.

property ReferenceStateHoverOptions.tas_dot: float#: Get the true airspeed acceleration.

property ReferenceStateHoverOptions.groundspeed_dot: float#: Get the groundspeed acceleration.

property ReferenceStateHoverOptions.longitudinal_acceleration_type: ReferenceStateLongitudinalAccelerationMode#: Get the mode to specify the longitudinal acceleration.

property ReferenceStateHoverOptions.heading: Any#: Get or set the direction the aircraft is pointing.

property ReferenceStateHoverOptions.heading_is_magnetic: bool#: Opt whether to specify the heading using magnetic North.

property ReferenceStateHoverOptions.course: Any#: Get or set the direction the aircraft is traveling.

property ReferenceStateHoverOptions.course_is_magnetic: bool#: Opt whether to specify the course using magnetic North.

property ReferenceStateHoverOptions.heading_dot: Any#: Get or set the heading rate of change.

property ReferenceStateHoverOptions.course_dot: Any#: Get or set the course rate of change.

property ReferenceStateHoverOptions.roll_angle: Any#: Get or set the aircraft’s bank angle.

property ReferenceStateHoverOptions.aoa: Any#: Get or set the aircraft’s angle of attack.

property ReferenceStateHoverOptions.pitch_rate: Any#: Get the aircraft’s pitch rate.

property ReferenceStateHoverOptions.push_pull_g: float#: Get the G force on the aircraft resulting from its attitude.

property ReferenceStateHoverOptions.attitude_rate_type: ReferenceStateAttitudeMode#: Get the mode to specify the vertical attitude rate.

ReferenceStateHoverOptions.set_longitudinal_acceleration(self, accel_type: ReferenceStateLongitudinalAccelerationMode, value: float) → None#

Set the longitudinal acceleration.

Parameters:

accel_type : ReferenceStateLongitudinalAccelerationMode

value : float

Returns:

None

ReferenceStateHoverOptions.set_attitude_rate(self, attitude_rate_type: ReferenceStateAttitudeMode, value: Any) → None#

Set the vertical attitude rate.

Parameters:

attitude_rate_type : ReferenceStateAttitudeMode

value : Any

Returns:

None