Skip to main content

Class: AltitudeAlerter

Defined in: src/garminsdk/components/nextgenpfd/altimeter/AltitudeAlerter.ts:39

Maintains an altitude alert state based on the relationship between indicated altitude and selected altitude.

Constructors

Constructor

new AltitudeAlerter(index, bus, adcIndex): AltitudeAlerter

Defined in: src/garminsdk/components/nextgenpfd/altimeter/AltitudeAlerter.ts:95

Creates an instance of AltitudeAlerter.

Parameters

ParameterTypeDescription
indexnumberThe index of this alerter.
busEventBusThe event bus.
adcIndexnumber | Subscribable<number>The index of the ADC from which this alerter sources indicated altitude data.

Returns

AltitudeAlerter

Properties

index

readonly index: number

Defined in: src/garminsdk/components/nextgenpfd/altimeter/AltitudeAlerter.ts:95

The index of this alerter.


state

readonly state: Subscribable<AltitudeAlertState>

Defined in: src/garminsdk/components/nextgenpfd/altimeter/AltitudeAlerter.ts:43

Methods

destroy()

destroy(): void

Defined in: src/garminsdk/components/nextgenpfd/altimeter/AltitudeAlerter.ts:293

Destroys this alerter. Once destroyed, this alerter will no longer update its alert state.

Returns

void


init()

init(): void

Defined in: src/garminsdk/components/nextgenpfd/altimeter/AltitudeAlerter.ts:103

Initializes this alerter. Once initialized, this alerter will continuously update its alert state until destroyed.

Returns

void

Throws

Error if this alerter is dead.