Interface: FlightPathState
Defined in: src/sdk/flightplan/flightpath/FlightPathState.ts:7
A description of the state of a lateral flight path during flight path calculations.
Properties
currentCourse
currentCourse:
undefined|number
Defined in: src/sdk/flightplan/flightpath/FlightPathState.ts:12
The current true course bearing of the flight path.
currentPosition
readonlycurrentPosition:GeoPoint
Defined in: src/sdk/flightplan/flightpath/FlightPathState.ts:9
The current position of the flight path.
desiredCourseReversalTurnRadius
readonlydesiredCourseReversalTurnRadius:NumberUnitReadOnly<Distance>
Defined in: src/sdk/flightplan/flightpath/FlightPathState.ts:57
The desired radius for turns in course reversals.
Deprecated
Please use getDesiredCourseReversalTurnRadius(..) instead
desiredHoldTurnRadius
readonlydesiredHoldTurnRadius:NumberUnitReadOnly<Distance>
Defined in: src/sdk/flightplan/flightpath/FlightPathState.ts:54
The desired radius for turns in holds.
Deprecated
Please use getDesiredHoldTurnRadius(..) instead
desiredTurnAnticipationTurnRadius
readonlydesiredTurnAnticipationTurnRadius:NumberUnitReadOnly<Distance>
Defined in: src/sdk/flightplan/flightpath/FlightPathState.ts:60
The desired radius for anticipated leg-to-leg turns.
Deprecated
Please use getDesiredTurnAnticipationTurnRadius(..) instead
desiredTurnRadius
readonlydesiredTurnRadius:NumberUnitReadOnly<Distance>
Defined in: src/sdk/flightplan/flightpath/FlightPathState.ts:51
The desired radius for general turns.
Deprecated
Please use getDesiredTurnRadius(..) instead
isDiscontinuity
isDiscontinuity:
boolean
Defined in: src/sdk/flightplan/flightpath/FlightPathState.ts:15
Whether there is a discontinuity at the flight path's current position.
isFallback
isFallback:
boolean
Defined in: src/sdk/flightplan/flightpath/FlightPathState.ts:18
Whether the flight path is in a fallback state.
planeAltitude
readonlyplaneAltitude:NumberUnitReadOnly<Distance>
Defined in: src/sdk/flightplan/flightpath/FlightPathState.ts:30
The current altitude of the airplane to use for flight path calculations.
planeClimbRate
readonlyplaneClimbRate:NumberUnitReadOnly<Speed>
Defined in: src/sdk/flightplan/flightpath/FlightPathState.ts:33
The current climb rate of the airplane to use for flight path calculations.
planeHeading
readonlyplaneHeading:number
Defined in: src/sdk/flightplan/flightpath/FlightPathState.ts:27
The current true heading of the airplane, in degrees, or NaN if heading data are not available.
planePosition
readonlyplanePosition:GeoPointReadOnly
Defined in: src/sdk/flightplan/flightpath/FlightPathState.ts:24
The current position of the airplane. If position data are not available, then both latitude and longitude will be
equal to NaN.
planeSpeed
readonlyplaneSpeed:NumberUnitReadOnly<Speed>
Defined in: src/sdk/flightplan/flightpath/FlightPathState.ts:36
The current ground speed of the airplane to use for flight path calculations.
planeTrueAirspeed
readonlyplaneTrueAirspeed:NumberUnitReadOnly<Speed>
Defined in: src/sdk/flightplan/flightpath/FlightPathState.ts:39
The current true airspeed of the airplane to use for flight path calculations.
planeWindDirection
readonlyplaneWindDirection:number
Defined in: src/sdk/flightplan/flightpath/FlightPathState.ts:45
The wind direction at the airplane's current position to use for flight path calculations, in degrees relative to true north. Wind direction is defined as the bearing from which the wind is blowing.
planeWindSpeed
readonlyplaneWindSpeed:NumberUnitReadOnly<Speed>
Defined in: src/sdk/flightplan/flightpath/FlightPathState.ts:48
The wind speed at the airplane's current position to use for flight path calculations.
Methods
getDesiredCourseReversalTurnRadius()
getDesiredCourseReversalTurnRadius(
legIndex):number
Defined in: src/sdk/flightplan/flightpath/FlightPathState.ts:134
Returns the desired course reversal radius based on the current speed or the anticipated speed (if enabled and index is provided):
Parameters
| Parameter | Type | Description |
|---|---|---|
legIndex | number | waypoint index. |
Returns
number
the desired turn radius in Meters.
getDesiredHoldTurnRadius()
getDesiredHoldTurnRadius(
legIndex):number
Defined in: src/sdk/flightplan/flightpath/FlightPathState.ts:127
Returns the desired hold radius based on the current speed or the anticipated speed (if enabled and index is provided):
Parameters
| Parameter | Type | Description |
|---|---|---|
legIndex | number | waypoint index. |
Returns
number
the desired turn radius in Meters.
getDesiredTurnAnticipationTurnRadius()
getDesiredTurnAnticipationTurnRadius(
legIndex):number
Defined in: src/sdk/flightplan/flightpath/FlightPathState.ts:141
Returns the desired turn anticipation radius based on the current speed or the anticipated speed (if enabled and index is provided):
Parameters
| Parameter | Type | Description |
|---|---|---|
legIndex | number | waypoint index. |
Returns
number
the desired turn radius in Meters.
getDesiredTurnRadius()
getDesiredTurnRadius(
legIndex):number
Defined in: src/sdk/flightplan/flightpath/FlightPathState.ts:120
Returns the desired turn radius based on the current speed or the anticipated speed (if enabled and index is provided):
Parameters
| Parameter | Type | Description |
|---|---|---|
legIndex | number | waypoint index. |
Returns
number
the desired turn radius in Meters.
getPlaneAltitude()
getPlaneAltitude(
legIndex):number
Defined in: src/sdk/flightplan/flightpath/FlightPathState.ts:67
Gets the airplane's altitude to use for flight path calculations, in feet, at a given flight plan leg.
Parameters
| Parameter | Type | Description |
|---|---|---|
legIndex | number | The global index of the flight plan leg for which to get the plane's altitude. |
Returns
number
The plane's altitude, in feet, at the specified flight plan leg.
getPlaneClimbRate()
getPlaneClimbRate(
legIndex):number
Defined in: src/sdk/flightplan/flightpath/FlightPathState.ts:75
Gets the airplane's climb rate to use for flight path calculations, in feet per minute, at a given flight plan leg.
Parameters
| Parameter | Type | Description |
|---|---|---|
legIndex | number | The global index of the flight plan leg for which to get the plane's climb rate. |
Returns
number
The plane's climb rate, in feet per minute, at the specified flight plan leg.
getPlaneSpeed()
getPlaneSpeed(
legIndex):number
Defined in: src/sdk/flightplan/flightpath/FlightPathState.ts:82
Gets the airplane's ground speed to use for flight path calculations, in knots, at a given flight plan leg.
Parameters
| Parameter | Type | Description |
|---|---|---|
legIndex | number | The global index of the flight plan leg for which to get the plane's ground speed. |
Returns
number
The plane's ground speed, in knots, at the specified flight plan leg.
getPlaneTrueAirspeed()
getPlaneTrueAirspeed(
legIndex):number
Defined in: src/sdk/flightplan/flightpath/FlightPathState.ts:89
Gets the airplane's true airspeed to use for flight path calculations, in knots, at a given flight plan leg.
Parameters
| Parameter | Type | Description |
|---|---|---|
legIndex | number | The global index of the flight plan leg for which to get the plane's true airspeed. |
Returns
number
The plane's true airspeed, in knots, at the specified flight plan leg.
getTurnAnticipationLimit()
getTurnAnticipationLimit(
legIndex):number
Defined in: src/sdk/flightplan/flightpath/FlightPathState.ts:113
The maximum along-track distance, in meters, that can be anticipated for a leg-to-leg turn at the end of a given flight plan leg.
Parameters
| Parameter | Type | Description |
|---|---|---|
legIndex | number | The global index of the flight plan leg for which to get the limit. |
Returns
number
The maximum along-track distance, in meters, that can be anticipated for a leg-to-leg turn at the end of the specified flight plan leg.
getWindDirection()
getWindDirection(
legIndex):number
Defined in: src/sdk/flightplan/flightpath/FlightPathState.ts:97
Gets the wind direction to use for flight path calculations, in degrees relative to true north, at a given flight plan leg. Wind direction is defined as the bearing from which the wind is blowing.
Parameters
| Parameter | Type | Description |
|---|---|---|
legIndex | number | The global index of the flight plan leg for which to get the wind direction. |
Returns
number
The wind direction, in degrees relative to true north, at the specified flight plan leg.
getWindSpeed()
getWindSpeed(
legIndex):number
Defined in: src/sdk/flightplan/flightpath/FlightPathState.ts:104
Gets the wind speed to use for flight path calculations, in knots, at a given flight plan leg.
Parameters
| Parameter | Type | Description |
|---|---|---|
legIndex | number | The global index of the flight plan leg for which to get the wind speed. |
Returns
number
The wind speed, in knots, at the specified flight plan leg.