Abstract Class: AbstractFlightPathLegCalculator
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:36
Abstract implementation of FlightPathLegCalculator.
Extended by
NoPathLegCalculatorTrackToFixLegCalculatorDirectToFixLegCalculatorTurnToFixLegCalculatorCircleInterceptLegCalculatorFixToDmeLegCalculatorTrackFromFixLegCalculatorCourseToFixLegCalculatorProcedureTurnLegCalculatorCourseToManualLegCalculatorCourseToAltitudeLegCalculatorHoldLegCalculator
Implements
Constructors
Constructor
new AbstractFlightPathLegCalculator(
facilityCache,skipWhenActive):AbstractFlightPathLegCalculator
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:43
Constructor.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
facilityCache | Map<string, Facility> | undefined | This calculator's cache of facilities. |
skipWhenActive | boolean | false | Whether this calculator will skip calculations for active legs when the leg has already been calculated. False by default. |
Returns
AbstractFlightPathLegCalculator
Properties
facilityCache
protectedreadonlyfacilityCache:Map<string,Facility>
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:43
This calculator's cache of facilities.
skipWhenActive
protectedreadonlyskipWhenActive:boolean=false
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:43
Whether this calculator will skip calculations for active legs when the leg has already been calculated. False by default.
Methods
calculate()
calculate(
legs,calculateIndex,activeLegIndex,state,resolveIngressToEgress):LegCalculations
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:109
Calculates flight path vectors for a flight plan leg and adds the calculations to the leg.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
legs | LegDefinition[] | undefined | A sequence of flight plan legs. |
calculateIndex | number | undefined | The index of the leg to calculate. |
activeLegIndex | number | undefined | The index of the active leg. |
state | FlightPathState | undefined | The current flight path state. |
resolveIngressToEgress | boolean | true | - |
Returns
The flight plan leg calculations.
Implementation of
FlightPathLegCalculator.calculate
calculateMagVar()
abstractprotectedcalculateMagVar(legs,calculateIndex,activeLegIndex,state):void
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:191
Calculates the magnetic variation for a flight plan leg.
Parameters
| Parameter | Type | Description |
|---|---|---|
legs | LegDefinition[] | A sequence of flight plan legs. |
calculateIndex | number | The index of the leg to calculate. |
activeLegIndex | number | The index of the active leg. |
state | FlightPathState | The current flight path state. |
Returns
void
The number of vectors added to the sequence.
calculateVectors()
abstractprotectedcalculateVectors(legs,calculateIndex,activeLegIndex,state):void
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:201
Calculates flight path vectors for a flight plan leg.
Parameters
| Parameter | Type | Description |
|---|---|---|
legs | LegDefinition[] | A sequence of flight plan legs. |
calculateIndex | number | The index of the leg to calculate. |
activeLegIndex | number | The index of the active leg. |
state | FlightPathState | The current flight path state. |
Returns
void
The number of vectors added to the sequence.
getLegMagVar()
protectedgetLegMagVar(leg,point):number
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:81
Gets the magnetic variation, in degrees, to use when calculating a flight plan leg's course. If the leg defines an origin or fix VOR facility, then the magnetic variation defined at the VOR is used. Otherwise the computed magnetic variation for the specified point is used.
Parameters
| Parameter | Type | Description |
|---|---|---|
leg | FlightPlanLeg | A flight plan leg. |
point | LatLonInterface | The location from which to get magnetic variation, if an origin VOR is not found. |
Returns
number
The magnetic variation, in degrees, to use when calculating the specified flight plan leg's course.
getLegTrueCourse()
protectedgetLegTrueCourse(leg,point):number
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:100
Gets the true course, in degrees, for a flight plan leg. If the leg defines an origin or fix VOR facility, then the magnetic variation defined at the VOR is used to adjust magnetic course. Otherwise the computed magnetic variation for the specified point is used.
Parameters
| Parameter | Type | Description |
|---|---|---|
leg | FlightPlanLeg | A flight plan leg. |
point | LatLonInterface | The location from which to get magnetic variation, if an origin VOR is not found. |
Returns
number
The true course, in degrees, for the flight plan leg.
getPositionFromIcao()
protectedgetPositionFromIcao(icao,out):undefined|GeoPoint
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:52
Gets a geographical position from an ICAO string.
Parameters
| Parameter | Type | Description |
|---|---|---|
icao | string | An ICAO string. |
out | GeoPoint | A GeoPoint object to which to write the result. |
Returns
undefined | GeoPoint
The geographical position corresponding to the ICAO string, or undefined if one could not be obtained.
getTerminatorPosition()
protectedgetTerminatorPosition(leg,icao,out):undefined|GeoPoint
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:64
Gets the geographic position for a flight plan leg terminator.
Parameters
| Parameter | Type | Description |
|---|---|---|
leg | FlightPlanLeg | A flight plan leg. |
icao | string | The ICAO string of the leg's terminator fix. |
out | GeoPoint | A GeoPoint object to which to write the result. |
Returns
undefined | GeoPoint
The position of the leg terminator, or undefined if it could not be determined.
resolveIngressToEgress()
protectedresolveIngressToEgress(legCalc):void
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:207
Calculates the ingress to egress vectors for a flight plan leg and adds them to a leg calculation.
Parameters
| Parameter | Type | Description |
|---|---|---|
legCalc | LegCalculations | The calculations for a flight plan leg. |
Returns
void
shouldSkipWhenActive()
protectedshouldSkipWhenActive(legs,calculateIndex,activeLegIndex,state):boolean
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:178
Checks whether vector calculations should be skipped when the leg to calculate is the active leg.
Parameters
| Parameter | Type | Description |
|---|---|---|
legs | LegDefinition[] | A sequence of flight plan legs. |
calculateIndex | number | The index of the leg to calculate. |
activeLegIndex | number | The index of the active leg. |
state | FlightPathState | The current flight path state. |
Returns
boolean
Whether to skip vector calculations.