Class: DefaultTerrainSystemStateDataProvider

Defined in: src/garminsdk/terrain/DefaultTerrainSystemStateDataProvider.ts:11

A default implementation of TerrainSystemStateDataProvider.

Implements

• TerrainSystemStateDataProvider

Constructors

Constructor

new DefaultTerrainSystemStateDataProvider(bus, id): DefaultTerrainSystemStateDataProvider

Defined in: src/garminsdk/terrain/DefaultTerrainSystemStateDataProvider.ts:74

Creates a new instance of DefaultTerrainSystemStateDataProvider.

Parameters

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

Returns

DefaultTerrainSystemStateDataProvider

Properties

activeAlerts

readonly activeAlerts: SubscribableSet<string> & Subscribable<ReadonlySet<string>>

Defined in: src/garminsdk/terrain/DefaultTerrainSystemStateDataProvider.ts:44

The terrain system's active alerts.

Implementation of

TerrainSystemStateDataProvider.activeAlerts

---

inhibitedAlerts

readonly inhibitedAlerts: SubscribableSet<string> & Subscribable<ReadonlySet<string>>

Defined in: src/garminsdk/terrain/DefaultTerrainSystemStateDataProvider.ts:39

The terrain system's inhibited alerts.

Implementation of

TerrainSystemStateDataProvider.inhibitedAlerts

---

inhibitFlags

readonly inhibitFlags: SubscribableSet<string> & Subscribable<ReadonlySet<string>>

Defined in: src/garminsdk/terrain/DefaultTerrainSystemStateDataProvider.ts:29

The terrain system's active inhibit flags.

Implementation of

TerrainSystemStateDataProvider.inhibitFlags

---

operatingMode

readonly operatingMode: Subscribable<TerrainSystemOperatingMode>

Defined in: src/garminsdk/terrain/DefaultTerrainSystemStateDataProvider.ts:19

The terrain system's current operating mode.

Implementation of

TerrainSystemStateDataProvider.operatingMode

---

prioritizedAlert

readonly prioritizedAlert: Subscribable<null | string>

Defined in: src/garminsdk/terrain/DefaultTerrainSystemStateDataProvider.ts:48

The terrain system's current prioritized active alert.

Implementation of

TerrainSystemStateDataProvider.prioritizedAlert

---

statusFlags

readonly statusFlags: SubscribableSet<string> & Subscribable<ReadonlySet<string>>

Defined in: src/garminsdk/terrain/DefaultTerrainSystemStateDataProvider.ts:24

The terrain system's active status flags.

Implementation of

TerrainSystemStateDataProvider.statusFlags

---

triggeredAlerts

readonly triggeredAlerts: SubscribableSet<string> & Subscribable<ReadonlySet<string>>

Defined in: src/garminsdk/terrain/DefaultTerrainSystemStateDataProvider.ts:34

The terrain system's triggered alerts.

Implementation of

TerrainSystemStateDataProvider.triggeredAlerts

---

type

readonly type: Subscribable<undefined | string>

Defined in: src/garminsdk/terrain/DefaultTerrainSystemStateDataProvider.ts:15

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

Implementation of

TerrainSystemStateDataProvider.type

Methods

destroy()

destroy(): void

Defined in: src/garminsdk/terrain/DefaultTerrainSystemStateDataProvider.ts:190

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

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

Parameters

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

---

pause()

pause(): void

Defined in: src/garminsdk/terrain/DefaultTerrainSystemStateDataProvider.ts:170

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

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.