Class: AbstractFlightPathLegCalculator
Abstract implementation of FlightPathLegCalculator.
Hierarchy
AbstractFlightPathLegCalculator
↳
CircleInterceptLegCalculator
Implements
Constructors
constructor
• new AbstractFlightPathLegCalculator(facilityCache
, skipWhenActive?
): AbstractFlightPathLegCalculator
Constructor.
Parameters
Name | 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
Defined in
src/sdk/flightplan/FlightPathLegCalculator.ts:43
Properties
facilityCache
• Protected
Readonly
facilityCache: Map
<string
, Facility
>
This calculator's cache of facilities.
Defined in
src/sdk/flightplan/FlightPathLegCalculator.ts:43
skipWhenActive
• Protected
Readonly
skipWhenActive: boolean
= false
Whether this calculator will skip calculations for active legs when the leg has already been calculated. False by default.
Defined in
src/sdk/flightplan/FlightPathLegCalculator.ts:43
Methods
calculate
▸ calculate(legs
, calculateIndex
, activeLegIndex
, state
, resolveIngressToEgress?
): LegCalculations
Calculates flight path vectors for a flight plan leg and adds the calculations to the leg.
Parameters
Name | 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
Defined in
src/sdk/flightplan/FlightPathLegCalculator.ts:109
calculateMagVar
▸ calculateMagVar(legs
, calculateIndex
, activeLegIndex
, state
): void
Calculates the magnetic variation for a flight plan leg.
Parameters
Name | 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.
Defined in
src/sdk/flightplan/FlightPathLegCalculator.ts:191
calculateVectors
▸ calculateVectors(legs
, calculateIndex
, activeLegIndex
, state
): void
Calculates flight path vectors for a flight plan leg.
Parameters
Name | 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.
Defined in
src/sdk/flightplan/FlightPathLegCalculator.ts:201
getLegMagVar
▸ getLegMagVar(leg
, point
): number
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
Name | 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.
Defined in
src/sdk/flightplan/FlightPathLegCalculator.ts:81
getLegTrueCourse
▸ getLegTrueCourse(leg
, point
): number
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
Name | 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.
Defined in
src/sdk/flightplan/FlightPathLegCalculator.ts:100
getPositionFromIcao
▸ getPositionFromIcao(icao
, out
): undefined
| GeoPoint
Gets a geographical position from an ICAO string.
Parameters
Name | 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.
Defined in
src/sdk/flightplan/FlightPathLegCalculator.ts:52
getTerminatorPosition
▸ getTerminatorPosition(leg
, icao
, out
): undefined
| GeoPoint
Gets the geographic position for a flight plan leg terminator.
Parameters
Name | 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.
Defined in
src/sdk/flightplan/FlightPathLegCalculator.ts:64
resolveIngressToEgress
▸ resolveIngressToEgress(legCalc
): void
Calculates the ingress to egress vectors for a flight plan leg and adds them to a leg calculation.
Parameters
Name | Type | Description |
---|---|---|
legCalc | LegCalculations | The calculations for a flight plan leg. |
Returns
void
Defined in
src/sdk/flightplan/FlightPathLegCalculator.ts:207
shouldSkipWhenActive
▸ shouldSkipWhenActive(legs
, calculateIndex
, activeLegIndex
, state
): boolean
Checks whether vector calculations should be skipped when the leg to calculate is the active leg.
Parameters
Name | 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.
Defined in
src/sdk/flightplan/FlightPathLegCalculator.ts:178