Class: DefaultVNavDataProvider

Defined in: src/garminsdk/navigation/VNavDataProvider.ts:105

A default implementation of VNavDataProvider.

Implements

• VNavDataProvider

Constructors

Constructor

new DefaultVNavDataProvider(bus, fms, options?): DefaultVNavDataProvider

Defined in: src/garminsdk/navigation/VNavDataProvider.ts:285

Creates a new instance of DefaultVNavDataProvider.

Parameters

Parameter	Type	Description
bus	EventBus	The event bus.
fms	Fms<any> | Subscribable<Fms<any>>	The FMS.
options?	Readonly<DefaultVNavDataProviderOptions>	Options with which to configure the provider.

Returns

DefaultVNavDataProvider

Constructor

new DefaultVNavDataProvider(bus, fms, adcIndex?): DefaultVNavDataProvider

Defined in: src/garminsdk/navigation/VNavDataProvider.ts:296

Creates a new instance of DefaultVNavDataProvider that sources data from VNAV index 0.

Parameters

Parameter	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

DefaultVNavDataProvider

Properties

activeConstraintLeg

readonly activeConstraintLeg: Subscribable<LegDefinition | null>

Defined in: src/garminsdk/navigation/VNavDataProvider.ts:140

The flight plan leg that defines the active VNAV constraint.

Implementation of

VNavDataProvider.activeConstraintLeg

---

cruiseAltitude

readonly cruiseAltitude: Subscribable<number | null>

Defined in: src/garminsdk/navigation/VNavDataProvider.ts:136

The current VNAV cruise altitude, in feet.

Implementation of

VNavDataProvider.cruiseAltitude

---

distanceToTod

readonly distanceToTod: Subscribable<number | null>

Defined in: src/garminsdk/navigation/VNavDataProvider.ts:165

The distance remaining to the next top of descent, in nautical miles.

Implementation of

VNavDataProvider.distanceToTod

---

fpa

readonly fpa: Subscribable<number | null>

Defined in: src/garminsdk/navigation/VNavDataProvider.ts:149

The desired flight path angle, in degrees, for the current VNAV leg. Positive angles represent descending paths.

Implementation of

VNavDataProvider.fpa

---

isVNavDirectToActive

readonly isVNavDirectToActive: Subscribable<boolean>

Defined in: src/garminsdk/navigation/VNavDataProvider.ts:128

Whether VNAV direct-to is currently active.

Implementation of

VNavDataProvider.isVNavDirectToActive

---

pathMode

readonly pathMode: Subscribable<VNavPathMode>

Defined in: src/garminsdk/navigation/VNavDataProvider.ts:132

The current VNAV path mode.

Implementation of

VNavDataProvider.pathMode

---

phase

readonly phase: Subscribable<VerticalFlightPhase | null>

Defined in: src/garminsdk/navigation/VNavDataProvider.ts:116

The current VNAV phase.

Implementation of

VNavDataProvider.phase

---

targetRestriction

readonly targetRestriction: Subscribable<VNavTargetAltitudeRestriction | null>

Defined in: src/garminsdk/navigation/VNavDataProvider.ts:236

The target VNAV altitude restriction.

Implementation of

VNavDataProvider.targetRestriction

---

timeToBoc

readonly timeToBoc: Subscribable<number | null>

Defined in: src/garminsdk/navigation/VNavDataProvider.ts:181

The time remaining to the next bottom of climb, in seconds.

Implementation of

VNavDataProvider.timeToBoc

---

timeToBod

readonly timeToBod: Subscribable<number | null>

Defined in: src/garminsdk/navigation/VNavDataProvider.ts:173

The time remaining to the next bottom of descent, in seconds.

Implementation of

VNavDataProvider.timeToBod

---

timeToToc

readonly timeToToc: Subscribable<number | null>

Defined in: src/garminsdk/navigation/VNavDataProvider.ts:177

The time remaining to the next top of climb, in seconds.

Implementation of

VNavDataProvider.timeToToc

---

timeToTod

readonly timeToTod: Subscribable<number | null>

Defined in: src/garminsdk/navigation/VNavDataProvider.ts:169

The time remaining to the next top of descent, in seconds.

Implementation of

VNavDataProvider.timeToTod

---

trackAlert

readonly trackAlert: ReadonlySubEvent<void, GarminVNavTrackAlertType>

Defined in: src/garminsdk/navigation/VNavDataProvider.ts:185

An event that is fired when a vertical track alert is issued. The event data is the alert type.

Implementation of

VNavDataProvider.trackAlert

---

verticalDeviation

readonly verticalDeviation: Subscribable<number | null>

Defined in: src/garminsdk/navigation/VNavDataProvider.ts:161

The vertical deviation, in feet, from the VNAV path profile. Positive values indicate deviation above the profile.

Implementation of

VNavDataProvider.verticalDeviation

---

verticalSpeedTarget

readonly verticalSpeedTarget: Subscribable<number | null>

Defined in: src/garminsdk/navigation/VNavDataProvider.ts:153

The vertical speed target, in feet per minute, for the current VNAV leg.

Implementation of

VNavDataProvider.verticalSpeedTarget

---

vnavFlightPhase

readonly vnavFlightPhase: Subscribable<GarminVNavFlightPhase>

Defined in: src/garminsdk/navigation/VNavDataProvider.ts:120

The current VNAV flight phase.

Implementation of

VNavDataProvider.vnavFlightPhase

---

vnavTrackingPhase

readonly vnavTrackingPhase: Subscribable<GarminVNavTrackingPhase>

Defined in: src/garminsdk/navigation/VNavDataProvider.ts:124

The current VNAV tracking phase.

Implementation of

VNavDataProvider.vnavTrackingPhase

---

vsRequired

readonly vsRequired: Subscribable<number | null>

Defined in: src/garminsdk/navigation/VNavDataProvider.ts:157

The vertical speed required, in feet per minute, to meet the active VNAV restriction.

Implementation of

VNavDataProvider.vsRequired

Methods

destroy()

destroy(): void

Defined in: src/garminsdk/navigation/VNavDataProvider.ts:675

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

---

init()

init(paused): void

Defined in: src/garminsdk/navigation/VNavDataProvider.ts:335

Initializes this data provider. Once initialized, this data provider will continuously update its data until paused or destroyed.

Parameters

Parameter	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.

---

pause()

pause(): void

Defined in: src/garminsdk/navigation/VNavDataProvider.ts:651

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.

---

resume()

resume(): void

Defined in: src/garminsdk/navigation/VNavDataProvider.ts:632

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.