Abstract Class: AltitudeLegCalculator

Defined in: src/sdk/flightplan/flightpath/legcalculators/AltitudeLegCalculator.ts:26

Calculates flight path vectors for legs that terminate at a target altitude.

Extends

• AbstractFlightPathLegCalculator

Extended by

• CourseToAltitudeLegCalculator
• FixToAltitudeLegCalculator
• HeadingToAltitudeLegCalculator

Constructors

Constructor

new AltitudeLegCalculator(facilityCache): AltitudeLegCalculator

Defined in: src/sdk/flightplan/flightpath/legcalculators/AltitudeLegCalculator.ts:41

Creates a new instance of AltitudeLegCalculator.

Parameters

Parameter	Type	Description
facilityCache	FlightPathCalculatorFacilityCache	This calculator's cache of facilities.

Returns

AltitudeLegCalculator

Overrides

AbstractFlightPathLegCalculator.constructor

Properties

canSkipWhenActive

protected readonly canSkipWhenActive: boolean

Defined in: src/sdk/flightplan/flightpath/legcalculators/AbstractFlightPathLegCalculator.ts:29

Whether this calculator can skip leg calculations when the leg to calculate is the active flight plan leg.

Inherited from

AbstractFlightPathLegCalculator.canSkipWhenActive

---

circleVectorBuilder

protected readonly circleVectorBuilder: CircleVectorBuilder

Defined in: src/sdk/flightplan/flightpath/legcalculators/AltitudeLegCalculator.ts:33

---

facilityCache

protected readonly facilityCache: FlightPathCalculatorFacilityCache

Defined in: src/sdk/flightplan/flightpath/legcalculators/AbstractFlightPathLegCalculator.ts:28

This calculator's cache of facilities.

Inherited from

AbstractFlightPathLegCalculator.facilityCache

---

interceptCircleToPointVectorBuilder

protected readonly interceptCircleToPointVectorBuilder: InterceptCircleToPointVectorBuilder

Defined in: src/sdk/flightplan/flightpath/legcalculators/AltitudeLegCalculator.ts:35

---

procTurnVectorBuilder

protected readonly procTurnVectorBuilder: ProcedureTurnVectorBuilder

Defined in: src/sdk/flightplan/flightpath/legcalculators/AltitudeLegCalculator.ts:34

Methods

buildDistanceToAltitudeVector()

protected buildDistanceToAltitudeVector(vectors, index, legIndex, leg, isActiveLeg, state, path, start, flags, heading, isHeadingTrue): number

Defined in: src/sdk/flightplan/flightpath/legcalculators/AltitudeLegCalculator.ts:63

Builds a flight path vector representing the path the airplane must fly to climb to the target altitude of a flight plan leg.

Parameters

Parameter	Type	Default value	Description
vectors	FlightPathVector[]	undefined	The flight path vector array to which to add the vector.
index	number	undefined	The index in the array at which to add the vector.
legIndex	number	undefined	The index of the flight plan leg for which the vector is to be built.
leg	LegDefinition	undefined	The flight plan leg for which the vector is to be built.
isActiveLeg	boolean	undefined	Whether the vector is to be built for the active flight plan leg.
state	FlightPathState	undefined	The current flight path state.
path	GeoCircle	undefined	A GeoCircle that defines the path of the vector to build.
start	ReadonlyFloat64Array	undefined	The start point of the vector to build.
flags	number	undefined	The flags to set on the vector.
heading	null | number	null	The heading-to-fly to assign to the vector, in degrees, or null if no heading is to be assigned. Defaults to null.
isHeadingTrue	boolean	false	Whether the heading-to-fly assigned to the vector is relative to true north instead of magnetic north. Defaults to false.

Returns

number

The number of vectors that were built and added to the array.

---

buildFallbackVectorsToInterceptPath()

protected buildFallbackVectorsToInterceptPath(vectors, index, legIndex, isActiveLeg, state, options, pathToInterceptCourse, path, origin, requireJoinCourse): number

Defined in: src/sdk/flightplan/flightpath/legcalculators/AltitudeLegCalculator.ts:124

Builds a sequence of flight path vectors representing a path that intercepts a desired great-circle path. The intercept path begins at the flight path state's current position and course. If an intercept path can be calculated, then it is guaranteed to end at or past a specified origin point along the path to intercept. If an intercept path cannot be calculated, then vectors will be built that represent a constant-radius turn toward the path to intercept's initial course.

Parameters

Parameter	Type	Description
vectors	FlightPathVector[]	The flight path vector array to which to add the vectors.
index	number	The index in the array at which to add the vectors.
legIndex	number	The leg index to calculate
isActiveLeg	boolean	Whether the vectors are to be built for the active flight plan leg.
state	FlightPathState	The current flight path state. If an intercept is successfully calculated, then the state's fallback flag will be set to false. If an intercept could not be calculated, then the fallback flag will not be changed.
options	Readonly<FlightPathLegCalculationOptions>	Options to use for the leg calculations.
pathToInterceptCourse	number	The initial true course of the path to intercept, in degrees.
path	GeoCircle	A GeoCircle that defines the path to intercept. If an intercept cannot be calculated, then the circle will be changed to the great-circle that defines the course along which the last calculated fallback vector ends.
origin	Float64Array	The origin point of the path to intercept. The point will be changed, if necessary, to the point at which the built vectors actually intercept the path if the vectors intercept the path past the original origin point (as measured along the path to intercept).
requireJoinCourse	boolean	Whether the path to build must join (i.e. end parallel to) the desired great-circle path to intercept.

Returns

number

The number of vectors that were built and added to the array.

---

calculate()

calculate(legs, calculateIndex, activeLegIndex, state, options): LegCalculations

Defined in: src/sdk/flightplan/flightpath/legcalculators/AbstractFlightPathLegCalculator.ts:223

Calculates flight path vectors for a flight plan leg and adds the calculations to the 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.
options	Readonly<FlightPathLegCalculationOptions>	Options to use for the calculation.

Returns

LegCalculations

The flight plan leg calculations.

Inherited from

AbstractFlightPathLegCalculator.calculate

---

calculateMagVar()

abstract protected calculateMagVar(legs, calculateIndex, activeLegIndex, state, options): void

Defined in: src/sdk/flightplan/flightpath/legcalculators/AbstractFlightPathLegCalculator.ts:363

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.
options	Readonly<FlightPathLegCalculationOptions>	Options to use for the leg calculations.

Returns

void

The number of vectors added to the sequence.

Inherited from

AbstractFlightPathLegCalculator.calculateMagVar

---

calculateVectors()

abstract protected calculateVectors(legs, calculateIndex, activeLegIndex, state, options): void

Defined in: src/sdk/flightplan/flightpath/legcalculators/AbstractFlightPathLegCalculator.ts:380

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.
options	Readonly<FlightPathLegCalculationOptions>	Options to use for the leg calculations.

Returns

void

The number of vectors added to the sequence.

Inherited from

AbstractFlightPathLegCalculator.calculateVectors

---

getLegMagVar()

Call Signature

protected getLegMagVar(leg): undefined | number

Defined in: src/sdk/flightplan/flightpath/legcalculators/AbstractFlightPathLegCalculator.ts:134

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 database magnetic variation defined for the VOR is used (the origin facility takes priority).

Parameters

Parameter	Type	Description
leg	FlightPlanLeg	A flight plan leg.

Returns

undefined | number

The magnetic variation, in degrees, to use when calculating the specified flight plan leg's course, or undefined if the leg does not define an origin or fix VOR facility.

Inherited from

AbstractFlightPathLegCalculator.getLegMagVar

Call Signature

protected getLegMagVar(leg, defaultPoint): number

Defined in: src/sdk/flightplan/flightpath/legcalculators/AbstractFlightPathLegCalculator.ts:143

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 database magnetic variation defined for the VOR is used (the origin facility takes priority). Otherwise, the model magnetic variation for the specified point is used.

Parameters

Parameter	Type	Description
leg	FlightPlanLeg	A flight plan leg.
defaultPoint	LatLonInterface	The location from which to get magnetic variation if an origin or fix VOR is not found.

Returns

number

The magnetic variation, in degrees, to use when calculating the specified flight plan leg's course.

Inherited from

AbstractFlightPathLegCalculator.getLegMagVar

Call Signature

protected getLegMagVar(leg, defaultPoint?): undefined | number

Defined in: src/sdk/flightplan/flightpath/legcalculators/AbstractFlightPathLegCalculator.ts:153

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 database magnetic variation defined for the VOR is used (the origin facility takes priority). Otherwise, the model magnetic variation for the specified point, if defined, is used.

Parameters

Parameter	Type	Description
leg	FlightPlanLeg	A flight plan leg.
defaultPoint?	LatLonInterface	The location from which to get magnetic variation if an origin or fix VOR is not found.

Returns

undefined | number

The magnetic variation, in degrees, to use when calculating the specified flight plan leg's course, or undefined if the leg does not define an origin or fix VOR facility and a default point was not provided.

Inherited from

AbstractFlightPathLegCalculator.getLegMagVar

---

getLegTrueCourse()

protected getLegTrueCourse(leg): undefined | number

Defined in: src/sdk/flightplan/flightpath/legcalculators/AbstractFlightPathLegCalculator.ts:175

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.

Returns

undefined | number

The true course, in degrees, for the flight plan leg.

Inherited from

AbstractFlightPathLegCalculator.getLegTrueCourse

---

getMagVarFromIcao()

protected getMagVarFromIcao(icao): undefined | number

Defined in: src/sdk/flightplan/flightpath/legcalculators/AbstractFlightPathLegCalculator.ts:52

Gets the magnetic variation, in degrees, at a facility. If the facility is a VOR and it has a nominal database magnetic variation, then that value will be returned. Otherwise, the model magnetic variation at the facility's position will be returned.

Parameters

Parameter	Type	Description
icao	IcaoValue	The ICAO value of the facility.

Returns

undefined | number

The magnetic variation, in degrees, at the specified facility, or undefined if the specified facility could not be retrieved.

Inherited from

AbstractFlightPathLegCalculator.getMagVarFromIcao

---

getPositionFromIcao()

protected getPositionFromIcao(icao, out): undefined | GeoPoint

Defined in: src/sdk/flightplan/flightpath/legcalculators/AbstractFlightPathLegCalculator.ts:39

Gets a geographical position from an ICAO value.

Parameters

Parameter	Type	Description
icao	IcaoValue	An ICAO value.
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.

Inherited from

AbstractFlightPathLegCalculator.getPositionFromIcao

---

getTerminatorMagVar()

protected getTerminatorMagVar(leg): undefined | number

Defined in: src/sdk/flightplan/flightpath/legcalculators/AbstractFlightPathLegCalculator.ts:118

Gets the magnetic variation, in degrees, at a flight plan leg's terminator fix. If the fix is a VOR and it has a nominal database magnetic variation, then that value will be returned. Otherwise, the model magnetic variation at the fix's position will be returned.

Parameters

Parameter	Type	Description
leg	FlightPlanLeg	A flight plan leg.

Returns

undefined | number

The magnetic variation, in degrees, at the specified flight plan leg's terminator fix, or undefined if the magnetic variation could not be determined.

Inherited from

AbstractFlightPathLegCalculator.getTerminatorMagVar

---

getTerminatorPosition()

protected getTerminatorPosition(leg, out, icao?): undefined | GeoPoint

Defined in: src/sdk/flightplan/flightpath/legcalculators/AbstractFlightPathLegCalculator.ts:75

Gets the geographic position for a flight plan leg terminator.

Parameters

Parameter	Type	Description
leg	FlightPlanLeg	A flight plan leg.
out	GeoPoint	A GeoPoint object to which to write the result.
icao?	IcaoValue	The ICAO value of the leg's terminator fix. If not defined, then the terminator fix will be retrieved from the flight plan leg, if necessary.

Returns

undefined | GeoPoint

The position of the leg terminator, or undefined if it could not be determined.

Inherited from

AbstractFlightPathLegCalculator.getTerminatorPosition

---

resolveIngressToEgress()

protected resolveIngressToEgress(legCalc): void

Defined in: src/sdk/flightplan/flightpath/legcalculators/AbstractFlightPathLegCalculator.ts:392

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

Inherited from

AbstractFlightPathLegCalculator.resolveIngressToEgress

---

shouldSkipWhenActive()

protected shouldSkipWhenActive(legs, calculateIndex, activeLegIndex, state, options): boolean

Defined in: src/sdk/flightplan/flightpath/legcalculators/AbstractFlightPathLegCalculator.ts:341

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.
options	Readonly<FlightPathLegCalculationOptions>	Options to use for the leg calculations.

Returns

boolean

Whether to skip vector calculations.

Inherited from

AbstractFlightPathLegCalculator.shouldSkipWhenActive