Class: GarminSpeedConstraintStore
Defined in: src/garminsdk/autopilot/GarminSpeedConstraintStore.ts:28
A store which keeps track of the speed constraints in the active flight plan.
Constructors
Constructor
new GarminSpeedConstraintStore(
bus,flightPlanner):GarminSpeedConstraintStore
Defined in: src/garminsdk/autopilot/GarminSpeedConstraintStore.ts:41
Creates the store.
Parameters
| Parameter | Type | Description |
|---|---|---|
bus | EventBus | The Event Bus. |
flightPlanner | FlightPlanner | The Flight Planner. |
Returns
GarminSpeedConstraintStore
Methods
getCurrentSpeedConstraint()
getCurrentSpeedConstraint(
globalLegIndex,flightPhase):undefined|Readonly<SpeedConstraintListItem>
Defined in: src/garminsdk/autopilot/GarminSpeedConstraintStore.ts:113
Gets the speed constraint in effect for a given flight plan leg and vertical flight phase.
Parameters
| Parameter | Type | Description |
|---|---|---|
globalLegIndex | number | The global index of the flight plan leg for which to get the speed constraint in effect. |
flightPhase | VerticalFlightPhase | The 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.
getNextSpeedConstraint()
getNextSpeedConstraint(
globalLegIndex,flightPhase):undefined|Readonly<SpeedConstraintListItem>
Defined in: src/garminsdk/autopilot/GarminSpeedConstraintStore.ts:124
Gets the next speed constraint to take effect for a given flight plan leg and vertical flight phase.
Parameters
| Parameter | Type | Description |
|---|---|---|
globalLegIndex | number | The global index of the flight plan leg for which to get the speed constraint in effect. |
flightPhase | VerticalFlightPhase | The 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.