Skip to main content

Class: GarminSpeedConstraintStore

A store which keeps track of the speed constraints in the active flight plan.

Constructors

constructor

new GarminSpeedConstraintStore(bus, flightPlanner): GarminSpeedConstraintStore

Creates the store.

Parameters

NameTypeDescription
busEventBusThe Event Bus.
flightPlannerFlightPlanner<any>The Flight Planner.

Returns

GarminSpeedConstraintStore

Defined in

src/garminsdk/autopilot/GarminSpeedConstraintStore.ts:41

Methods

getCurrentSpeedConstraint

getCurrentSpeedConstraint(globalLegIndex, flightPhase): undefined | Readonly<SpeedConstraintListItem>

Gets the speed constraint in effect for a given flight plan leg and vertical flight phase.

Parameters

NameTypeDescription
globalLegIndexnumberThe global index of the flight plan leg for which to get the speed constraint in effect.
flightPhaseVerticalFlightPhaseThe vertical flight phase for which to get the speed constraint in effect.

Returns

undefined | Readonly<SpeedConstraintListItem>

The speed constraint in effect for the specified flight plan leg and vertical flight phase, or undefined if there is no speed constraint in effect.

Defined in

src/garminsdk/autopilot/GarminSpeedConstraintStore.ts:113


getNextSpeedConstraint

getNextSpeedConstraint(globalLegIndex, flightPhase): undefined | Readonly<SpeedConstraintListItem>

Gets the next speed constraint to take effect for a given flight plan leg and vertical flight phase.

Parameters

NameTypeDescription
globalLegIndexnumberThe global index of the flight plan leg for which to get the speed constraint in effect.
flightPhaseVerticalFlightPhaseThe vertical flight phase for which to get the speed constraint in effect.

Returns

undefined | Readonly<SpeedConstraintListItem>

The next speed constraint to take effect for the specified flight plan leg and vertical flight phase, or undefined if there is no speed constraint in effect.

Defined in

src/garminsdk/autopilot/GarminSpeedConstraintStore.ts:124