Skip to main content

Class: DefaultMarkerBeaconDataProvider

Defined in: src/garminsdk/components/nextgenpfd/marker/MarkerBeaconDataProvider.ts:21

A default implementation of MarkerBeaconDataProvider.

Implements

Constructors

Constructor

new DefaultMarkerBeaconDataProvider(bus, markerBeaconIndex): DefaultMarkerBeaconDataProvider

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

Constructor.

Parameters

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

Returns

DefaultMarkerBeaconDataProvider

Properties

isDataFailed

readonly isDataFailed: Subscribable<boolean>

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

Whether marker beacon data is in a failed state.

Implementation of

MarkerBeaconDataProvider.isDataFailed


markerBeaconState

readonly markerBeaconState: Subscribable<number>

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

The current marker beacon receiving state.

Implementation of

MarkerBeaconDataProvider.markerBeaconState

Methods

destroy()

destroy(): void

Defined in: src/garminsdk/components/nextgenpfd/marker/MarkerBeaconDataProvider.ts:133

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

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

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

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.