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