Skip to main content

Class: DefaultVsiDataProvider

Defined in: src/garminsdk/components/nextgenpfd/vsi/VsiDataProvider.ts:32

A default implementation of VsiDataProvider.

Implements

Constructors

Constructor

new DefaultVsiDataProvider(bus, adcIndex, vnavDataProvider): DefaultVsiDataProvider

Defined in: src/garminsdk/components/nextgenpfd/vsi/VsiDataProvider.ts:73

Constructor.

Parameters

ParameterTypeDescription
busEventBusThe event bus.
adcIndexnumber | Subscribable<number>The index of the ADC that is the source of this provider's data.
vnavDataProviderVNavDataProviderA provider of VNAV data.

Returns

DefaultVsiDataProvider

Properties

isDataFailed

readonly isDataFailed: Subscribable<boolean>

Defined in: src/garminsdk/components/nextgenpfd/vsi/VsiDataProvider.ts:57

Whether vertical speed data is in a failure state.

Implementation of

VsiDataProvider.isDataFailed


selectedVs

readonly selectedVs: Subscribable<null | number>

Defined in: src/garminsdk/components/nextgenpfd/vsi/VsiDataProvider.ts:47

The current selected vertical speed, in feet per minute.

Implementation of

VsiDataProvider.selectedVs


targetRestriction

readonly targetRestriction: Subscribable<null | VNavTargetAltitudeRestriction>

Defined in: src/garminsdk/components/nextgenpfd/vsi/VsiDataProvider.ts:50

The target VNAV altitude restriction.

Implementation of

VsiDataProvider.targetRestriction


verticalSpeed

readonly verticalSpeed: Subscribable<number>

Defined in: src/garminsdk/components/nextgenpfd/vsi/VsiDataProvider.ts:35

The current vertical speed, in feet per minute.

Implementation of

VsiDataProvider.verticalSpeed


vsRequired

readonly vsRequired: Subscribable<null | number>

Defined in: src/garminsdk/components/nextgenpfd/vsi/VsiDataProvider.ts:53

The current vertical speed required to meet the next VNAV altitude restriction, in feet per minute.

Implementation of

VsiDataProvider.vsRequired

Methods

destroy()

destroy(): void

Defined in: src/garminsdk/components/nextgenpfd/vsi/VsiDataProvider.ts:166

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/components/nextgenpfd/vsi/VsiDataProvider.ts:88

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

Parameters

ParameterTypeDefault valueDescription
pausedbooleanfalseWhether 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/components/nextgenpfd/vsi/VsiDataProvider.ts:143

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/components/nextgenpfd/vsi/VsiDataProvider.ts:120

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.