ProcedureReferenceState#

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

Class defining a reference state procedure.

Overview#

Methods

Get the procedure interface.

Properties

`start_time`	Get or set the start time of the reference state.
`latitude`	Get or set the waypoint latitude.
`longitude`	Get or set the waypoint longitude.
`use_default_cruise_altitude`	Opt whether to use the default cruise altitude.
`msl_altitude`	Get the MSL altitude. Can only be used when the option to use the default cruise altitude is off.
`performance_mode`	Get or set the type of motion the aircraft is engaged in.
`reference_frame`	Get or set the reference frame the aircraft will use.
`fuel_flow`	Get or set the rate of fuel consumption.
`mode_as_forward_flight`	Get the forward flight options.
`mode_as_takeoff_landing`	Get the takeoff and landing options.
`mode_as_hover`	Get the hover options.
`mode_as_weight_on_wheels`	Get the weight on wheels options.

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

property ProcedureReferenceState.start_time: Any#: Get or set the start time of the reference state.

property ProcedureReferenceState.latitude: Any#: Get or set the waypoint latitude.

property ProcedureReferenceState.longitude: Any#: Get or set the waypoint longitude.

property ProcedureReferenceState.use_default_cruise_altitude: bool#: Opt whether to use the default cruise altitude.

property ProcedureReferenceState.msl_altitude: float#: Get the MSL altitude. Can only be used when the option to use the default cruise altitude is off.

property ProcedureReferenceState.performance_mode: ReferenceStatePerformanceMode#: Get or set the type of motion the aircraft is engaged in.

property ProcedureReferenceState.reference_frame: BasicManeuverReferenceFrame#: Get or set the reference frame the aircraft will use.

property ProcedureReferenceState.fuel_flow: float#: Get or set the rate of fuel consumption.

property ProcedureReferenceState.mode_as_forward_flight: ReferenceStateForwardFlightOptions#: Get the forward flight options.

property ProcedureReferenceState.mode_as_takeoff_landing: ReferenceStateTakeoffLandingOptions#: Get the takeoff and landing options.

property ProcedureReferenceState.mode_as_hover: ReferenceStateHoverOptions#: Get the hover options.

property ProcedureReferenceState.mode_as_weight_on_wheels: ReferenceStateWeightOnWheelsOptions#: Get the weight on wheels options.

ProcedureReferenceState.get_as_procedure(self) → IProcedure#

Get the procedure interface.