Class: DefaultTerrainSystemStateDataProvider

A default implementation of TerrainSystemStateDataProvider.

Implements

• TerrainSystemStateDataProvider

Constructors

constructor

• new DefaultTerrainSystemStateDataProvider(bus, id): DefaultTerrainSystemStateDataProvider

Creates a new instance of DefaultTerrainSystemStateDataProvider.

Parameters

Name	Type	Description
bus	EventBus	The event bus.
id	string	The ID of the terrain alerting system for which to provide data.

Returns

DefaultTerrainSystemStateDataProvider

Defined in

src/garminsdk/terrain/DefaultTerrainSystemStateDataProvider.ts:64

Properties

activeAlerts

• Readonly activeAlerts: SubscribableSet<string>

The terrain system's active alerts.

Implementation of

TerrainSystemStateDataProvider.activeAlerts

Defined in

src/garminsdk/terrain/DefaultTerrainSystemStateDataProvider.ts:34

---

inhibitFlags

• Readonly inhibitFlags: SubscribableSet<string>

The terrain system's active inhibit flags.

Implementation of

TerrainSystemStateDataProvider.inhibitFlags

Defined in

src/garminsdk/terrain/DefaultTerrainSystemStateDataProvider.ts:29

---

operatingMode

• Readonly operatingMode: Subscribable<TerrainSystemOperatingMode>

The terrain system's current operating mode.

Implementation of

TerrainSystemStateDataProvider.operatingMode

Defined in

src/garminsdk/terrain/DefaultTerrainSystemStateDataProvider.ts:19

---

prioritizedAlert

• Readonly prioritizedAlert: Subscribable<null | string>

The terrain system's current prioritized active alert.

Implementation of

TerrainSystemStateDataProvider.prioritizedAlert

Defined in

src/garminsdk/terrain/DefaultTerrainSystemStateDataProvider.ts:38

---

statusFlags

• Readonly statusFlags: SubscribableSet<string>

The terrain system's active status flags.

Implementation of

TerrainSystemStateDataProvider.statusFlags

Defined in

src/garminsdk/terrain/DefaultTerrainSystemStateDataProvider.ts:24

---

type

• Readonly type: Subscribable<undefined | string>

The terrain system's type, or undefined if the type is not yet known.

Implementation of

TerrainSystemStateDataProvider.type

Defined in

src/garminsdk/terrain/DefaultTerrainSystemStateDataProvider.ts:15

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/terrain/DefaultTerrainSystemStateDataProvider.ts:172

---

init

▸ init(paused?): void

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

Parameters

Name	Type	Default value	Description
paused	boolean	false	Whether 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/terrain/DefaultTerrainSystemStateDataProvider.ts:77

---

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/terrain/DefaultTerrainSystemStateDataProvider.ts:152

---

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/terrain/DefaultTerrainSystemStateDataProvider.ts:128