Class: DefaultObsSuspDataProvider

Defined in: src/garminsdk/navigation/Obs.ts:42

A default implementation of ObsSuspDataProvider.

Implements

• ObsSuspDataProvider

Constructors

Constructor

new DefaultObsSuspDataProvider(bus, options?): DefaultObsSuspDataProvider

Defined in: src/garminsdk/navigation/Obs.ts:84

Creates a new instance of DefaultObsSuspDataProvider.

Parameters

Parameter	Type	Description
bus	EventBus	The event bus.
options?	Readonly<DefaultObsSuspDataProviderOptions>	Options with which to configure the data provider.

Returns

DefaultObsSuspDataProvider

Properties

isObsAvailable

readonly isObsAvailable: Subscribable<boolean>

Defined in: src/garminsdk/navigation/Obs.ts:67

Whether OBS mode can be activated.

Implementation of

ObsSuspDataProvider.isObsAvailable

---

mode

readonly mode: Subscribable<ObsSuspModes>

Defined in: src/garminsdk/navigation/Obs.ts:50

The current LNAV OBS/suspend mode.

Implementation of

ObsSuspDataProvider.mode

---

obsCourse

readonly obsCourse: Subscribable<number>

Defined in: src/garminsdk/navigation/Obs.ts:71

The current magnetic OBS course, in degrees.

Implementation of

ObsSuspDataProvider.obsCourse

Methods

destroy()

destroy(): void

Defined in: src/garminsdk/navigation/Obs.ts:188

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/navigation/Obs.ts:98

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/navigation/Obs.ts:163

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/navigation/Obs.ts:138

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.