Skip to main content

Class: DefaultMarkerBeaconDataProvider

A default implementation of MarkerBeaconDataProvider.

Implements

Constructors

constructor

new DefaultMarkerBeaconDataProvider(bus, markerBeaconIndex): DefaultMarkerBeaconDataProvider

Constructor.

Parameters

NameTypeDescription
busEventBusThe event bus.
markerBeaconIndexnumber | Subscribable<number>The index of the AoA computer that is the source of this provider's data.

Returns

DefaultMarkerBeaconDataProvider

Defined in

src/garminsdk/components/nextgenpfd/marker/MarkerBeaconDataProvider.ts:44

Properties

isDataFailed

Readonly isDataFailed: Subscribable<boolean>

Whether marker beacon data is in a failed state.

Implementation of

MarkerBeaconDataProvider.isDataFailed

Defined in

src/garminsdk/components/nextgenpfd/marker/MarkerBeaconDataProvider.ts:28


markerBeaconState

Readonly markerBeaconState: Subscribable<number>

The current marker beacon receiving state.

Implementation of

MarkerBeaconDataProvider.markerBeaconState

Defined in

src/garminsdk/components/nextgenpfd/marker/MarkerBeaconDataProvider.ts:24

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/marker/MarkerBeaconDataProvider.ts:133


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/marker/MarkerBeaconDataProvider.ts:58


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/marker/MarkerBeaconDataProvider.ts:114


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/marker/MarkerBeaconDataProvider.ts:95