Class: DefaultRadarAltimeterDataProvider
Defined in: src/garminsdk/components/nextgenpfd/altimeter/RadarAltimeterDataProvider.ts:19
A default implementation of RadarAltimeterDataProvider.
Implements
Constructors
Constructor
new DefaultRadarAltimeterDataProvider(
bus
):DefaultRadarAltimeterDataProvider
Defined in: src/garminsdk/components/nextgenpfd/altimeter/RadarAltimeterDataProvider.ts:64
Constructor.
Parameters
Parameter | Type | Description |
---|---|---|
bus | EventBus | The event bus. |
Returns
DefaultRadarAltimeterDataProvider
Properties
isDataFailed
readonly
isDataFailed:Subscribable
<boolean
>
Defined in: src/garminsdk/components/nextgenpfd/altimeter/RadarAltimeterDataProvider.ts:47
Whether radar altitude data is in a failure state.
Implementation of
RadarAltimeterDataProvider
.isDataFailed
radarAlt
readonly
radarAlt:Subscribable
<number
>
Defined in: src/garminsdk/components/nextgenpfd/altimeter/RadarAltimeterDataProvider.ts:43
The current radar altitude, in feet, or NaN
if the radar altitude is above the maximum threshold (2500 feet).
Implementation of
RadarAltimeterDataProvider
.radarAlt
Methods
destroy()
destroy():
void
Defined in: src/garminsdk/components/nextgenpfd/altimeter/RadarAltimeterDataProvider.ts:180
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/components/nextgenpfd/altimeter/RadarAltimeterDataProvider.ts:74
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/components/nextgenpfd/altimeter/RadarAltimeterDataProvider.ts:158
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/components/nextgenpfd/altimeter/RadarAltimeterDataProvider.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.