Skip to main content

Class: DefaultVsiDataProvider

A default implementation of VsiDataProvider.

Implements

Constructors

constructor

new DefaultVsiDataProvider(bus, adcIndex, vnavDataProvider): DefaultVsiDataProvider

Constructor.

Parameters

NameTypeDescription
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

Defined in

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

Properties

isDataFailed

Readonly isDataFailed: Subscribable<boolean>

Whether vertical speed data is in a failure state.

Implementation of

VsiDataProvider.isDataFailed

Defined in

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


selectedVs

Readonly selectedVs: Subscribable<null | number>

The current selected vertical speed, in feet per minute.

Implementation of

VsiDataProvider.selectedVs

Defined in

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


targetRestriction

Readonly targetRestriction: Subscribable<null | VNavTargetAltitudeRestriction>

The target VNAV altitude restriction.

Implementation of

VsiDataProvider.targetRestriction

Defined in

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


verticalSpeed

Readonly verticalSpeed: Subscribable<number>

The current vertical speed, in feet per minute.

Implementation of

VsiDataProvider.verticalSpeed

Defined in

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


vsRequired

Readonly vsRequired: Subscribable<null | number>

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

Implementation of

VsiDataProvider.vsRequired

Defined in

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

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


init

init(paused?): void

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

Parameters

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

Defined in

src/garminsdk/components/nextgenpfd/vsi/VsiDataProvider.ts:88


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


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