Class: DefaultWindDataProvider
A default implementation of WindDataProvider.
Implements
Constructors
constructor
• new DefaultWindDataProvider(bus
, adcIndex
, ahrsIndex
, fmsPosIndex
, smoothingTau?
, accumulateTime?
): DefaultWindDataProvider
Constructor.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
bus | EventBus | undefined | The event bus. |
adcIndex | number | Subscribable <number > | undefined | The index of the ADC that is the source of this provider's data. |
ahrsIndex | number | Subscribable <number > | undefined | The index of the AHRS that is the source of this provider's data. |
fmsPosIndex | number | Subscribable <number > | undefined | The index of the FMS geo-positioning system that is the source of this provider's data. |
smoothingTau | number | DefaultWindDataProvider.DEFAULT_SMOOTHING_TAU | The smoothing time constant, in milliseconds, used to apply smoothing to wind speed and direction. Defaults to DefaultWindDataProvider.DEFAULT_SMOOTHING_TAU. |
accumulateTime | number | DefaultWindDataProvider.DEFAULT_ACCUMULATE_TIME | The time required for this provider to accumulate enough source data to generate valid wind data. |
Returns
Defined in
src/garminsdk/wind/WindDataProvider.ts:140
Properties
crosswind
• Readonly
crosswind: Subscribable
<number
>
The current crosswind component, in knots. Positive values indicate wind from the right, negative values indicate wind from the left.
Implementation of
Defined in
src/garminsdk/wind/WindDataProvider.ts:72
headwind
• Readonly
headwind: Subscribable
<number
>
The current headwind component, in knots. Positive values indicate headwind, negative values indicate tailwind.
Implementation of
Defined in
src/garminsdk/wind/WindDataProvider.ts:68
isDataFailed
• Readonly
isDataFailed: Subscribable
<boolean
>
Whether this provider's wind data is in a failed state.
Implementation of
Defined in
src/garminsdk/wind/WindDataProvider.ts:84
isGpsDeadReckoning
• Readonly
isGpsDeadReckoning: Subscribable
<boolean
>
Whether GPS position is in dead reckoning mode.
Implementation of
WindDataProvider.isGpsDeadReckoning
Defined in
src/garminsdk/wind/WindDataProvider.ts:80
magVar
• Readonly
magVar: Subscribable
<number
>
The magnetic variation, in degrees, at the airplane's location.
Implementation of
Defined in
src/garminsdk/wind/WindDataProvider.ts:76
windDirection
• Readonly
windDirection: Subscribable
<number
>
The current wind direction, in degrees true.
Implementation of
WindDataProvider.windDirection
Defined in
src/garminsdk/wind/WindDataProvider.ts:56
windDirectionRelative
• Readonly
windDirectionRelative: Subscribable
<number
>
The current wind direction relative to airplane heading, in degrees. A value of zero degrees indicates a direct headwind, with positive angles proceeding clockwise.
Implementation of
WindDataProvider.windDirectionRelative
Defined in
src/garminsdk/wind/WindDataProvider.ts:60
windSpeed
• Readonly
windSpeed: Subscribable
<number
>
The current wind speed, in knots.
Implementation of
Defined in
src/garminsdk/wind/WindDataProvider.ts:64
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/wind/WindDataProvider.ts:306
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/wind/WindDataProvider.ts:160
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/wind/WindDataProvider.ts:227
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/wind/WindDataProvider.ts:205