Class: DefaultMinimumsDataProvider
Defined in: src/garminsdk/minimums/MinimumsDataProvider.ts:23
A default implementation of MinimumsDataProvider.
Implements
Constructors
Constructor
new DefaultMinimumsDataProvider(
bus
,supportRadarMinimums
):DefaultMinimumsDataProvider
Defined in: src/garminsdk/minimums/MinimumsDataProvider.ts:48
Constructor.
Parameters
Parameter | Type | Description |
---|---|---|
bus | EventBus | The event bus. |
supportRadarMinimums | boolean | Whether to support radar minimums. |
Returns
DefaultMinimumsDataProvider
Properties
baroMinimums
readonly
baroMinimums:Subscribable
<number
>
Defined in: src/garminsdk/minimums/MinimumsDataProvider.ts:33
The current baro minimums, in feet.
Implementation of
MinimumsDataProvider
.baroMinimums
minimums
readonly
minimums:Subscribable
<null
|number
>
Defined in: src/garminsdk/minimums/MinimumsDataProvider.ts:29
The current active minimums, in feet, or null
if no such value exists.
Implementation of
mode
readonly
mode:Subscribable
<MinimumsMode
>
Defined in: src/garminsdk/minimums/MinimumsDataProvider.ts:25
The current minimums mode.
Implementation of
radarMinimums
readonly
radarMinimums:Subscribable
<number
>
Defined in: src/garminsdk/minimums/MinimumsDataProvider.ts:37
The current radar minimums, in feet.
Implementation of
MinimumsDataProvider
.radarMinimums
Methods
destroy()
destroy():
void
Defined in: src/garminsdk/minimums/MinimumsDataProvider.ts:173
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/minimums/MinimumsDataProvider.ts:58
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/minimums/MinimumsDataProvider.ts:153
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/minimums/MinimumsDataProvider.ts:133
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.