Class: DefaultVNavDataProvider
A default implementation of VNavDataProvider.
Implements
Constructors
constructor
• new DefaultVNavDataProvider(bus, fms, options?): DefaultVNavDataProvider
Creates a new instance of DefaultVNavDataProvider.
Parameters
| Name | Type | Description |
|---|---|---|
bus | EventBus | The event bus. |
fms | Fms<any> | Subscribable<Fms<any>> | The FMS. |
options? | Readonly<DefaultVNavDataProviderOptions> | - |
Returns
Defined in
src/garminsdk/navigation/VNavDataProvider.ts:277
• new DefaultVNavDataProvider(bus, fms, adcIndex?): DefaultVNavDataProvider
Creates a new instance of DefaultVNavDataProvider that sources data from VNAV index 0.
Parameters
| Name | Type | Description |
|---|---|---|
bus | EventBus | The event bus. |
fms | Fms<any> | Subscribable<Fms<any>> | The FMS. |
adcIndex? | number | Subscribable<number> | The index of the ADC that is the source of this provider's data. Defaults to 1. |
Returns
Defined in
src/garminsdk/navigation/VNavDataProvider.ts:288
Properties
activeConstraintLeg
• Readonly activeConstraintLeg: Subscribable<null | LegDefinition>
The flight plan leg that defines the active VNAV constraint.
Implementation of
VNavDataProvider.activeConstraintLeg
Defined in
src/garminsdk/navigation/VNavDataProvider.ts:137
cruiseAltitude
• Readonly cruiseAltitude: Subscribable<null | number>
The current VNAV cruise altitude, in feet.
Implementation of
VNavDataProvider.cruiseAltitude
Defined in
src/garminsdk/navigation/VNavDataProvider.ts:133
distanceToTod
• Readonly distanceToTod: Subscribable<null | number>
The distance remaining to the next top of descent, in nautical miles.
Implementation of
VNavDataProvider.distanceToTod
Defined in
src/garminsdk/navigation/VNavDataProvider.ts:162
fpa
• Readonly fpa: Subscribable<null | number>
The desired flight path angle, in degrees, for the current VNAV leg. Positive angles represent descending paths.
Implementation of
Defined in
src/garminsdk/navigation/VNavDataProvider.ts:146
isVNavDirectToActive
• Readonly isVNavDirectToActive: Subscribable<boolean>
Whether VNAV direct-to is currently active.
Implementation of
VNavDataProvider.isVNavDirectToActive
Defined in
src/garminsdk/navigation/VNavDataProvider.ts:125
pathMode
• Readonly pathMode: Subscribable<VNavPathMode>
The current VNAV path mode.
Implementation of
Defined in
src/garminsdk/navigation/VNavDataProvider.ts:129
phase
• Readonly phase: Subscribable<null | VerticalFlightPhase>
The current VNAV phase.
Implementation of
Defined in
src/garminsdk/navigation/VNavDataProvider.ts:113
targetRestriction
• Readonly targetRestriction: Subscribable<null | VNavTargetAltitudeRestriction>
The target VNAV altitude restriction.
Implementation of
VNavDataProvider.targetRestriction
Defined in
src/garminsdk/navigation/VNavDataProvider.ts:229
timeToBoc
• Readonly timeToBoc: Subscribable<null | number>
The time remaining to the next bottom of climb, in seconds.
Implementation of
Defined in
src/garminsdk/navigation/VNavDataProvider.ts:178
timeToBod
• Readonly timeToBod: Subscribable<null | number>
The time remaining to the next bottom of descent, in seconds.
Implementation of
Defined in
src/garminsdk/navigation/VNavDataProvider.ts:170
timeToToc
• Readonly timeToToc: Subscribable<null | number>
The time remaining to the next top of climb, in seconds.
Implementation of
Defined in
src/garminsdk/navigation/VNavDataProvider.ts:174
timeToTod
• Readonly timeToTod: Subscribable<null | number>
The time remaining to the next top of descent, in seconds.
Implementation of
Defined in
src/garminsdk/navigation/VNavDataProvider.ts:166
verticalDeviation
• Readonly verticalDeviation: Subscribable<null | number>
The vertical deviation, in feet, from the VNAV path profile. Positive values indicate deviation above the profile.
Implementation of
VNavDataProvider.verticalDeviation
Defined in
src/garminsdk/navigation/VNavDataProvider.ts:158
verticalSpeedTarget
• Readonly verticalSpeedTarget: Subscribable<null | number>
The vertical speed target, in feet per minute, for the current VNAV leg.
Implementation of
VNavDataProvider.verticalSpeedTarget
Defined in
src/garminsdk/navigation/VNavDataProvider.ts:150
vnavFlightPhase
• Readonly vnavFlightPhase: Subscribable<GarminVNavFlightPhase>
The current VNAV flight phase.
Implementation of
VNavDataProvider.vnavFlightPhase
Defined in
src/garminsdk/navigation/VNavDataProvider.ts:117
vnavTrackingPhase
• Readonly vnavTrackingPhase: Subscribable<GarminVNavTrackingPhase>
The current VNAV tracking phase.
Implementation of
VNavDataProvider.vnavTrackingPhase
Defined in
src/garminsdk/navigation/VNavDataProvider.ts:121
vsRequired
• Readonly vsRequired: Subscribable<null | number>
The vertical speed required, in feet per minute, to meet the active VNAV restriction.
Implementation of
Defined in
src/garminsdk/navigation/VNavDataProvider.ts:154
Methods
destroy
▸ destroy(): void
Destroys this data provider. Once destroyed, this data provider will no longer update its provided data, and can no longer be paused or resumed.
Returns
void
Defined in
src/garminsdk/navigation/VNavDataProvider.ts:650
init
▸ init(paused?): void
Initializes this data provider. Once initialized, this data provider will continuously update its data until paused or destroyed.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
paused | boolean | false | Whether to initialize this data provider as paused. If true, this data provider will provide an initial set of data but will not update the provided data until it is resumed. Defaults to false. |
Returns
void
Throws
Error if this data provider is dead.
Defined in
src/garminsdk/navigation/VNavDataProvider.ts:327
pause
▸ pause(): void
Pauses this data provider. Once paused, this data provider will not update its data until it is resumed.
Returns
void
Throws
Error if this data provider is dead.
Defined in
src/garminsdk/navigation/VNavDataProvider.ts:627
resume
▸ resume(): void
Resumes this data provider. Once resumed, this data provider will continuously update its data until paused or destroyed.
Returns
void
Throws
Error if this data provider is dead.
Defined in
src/garminsdk/navigation/VNavDataProvider.ts:609