Skip to main content

Class: DefaultHsiDataProvider

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HSI/HsiDataProvider.ts:77

A default implementation of HsiDataProvider.

Implements

Constructors

Constructor

new DefaultHsiDataProvider(bus, ahrsIndex, fmsPosIndex, activeNavIndicator, bearing1Indicator, bearing2Indicator, fplSourceDataProvider, settingManager, supportAutopilot): DefaultHsiDataProvider

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HSI/HsiDataProvider.ts:188

Creates a new instance of DefaultHsiDataProvider.

Parameters

ParameterTypeDescription
busEventBusThe event bus.
ahrsIndexnumber | Subscribable<number>The index of the AHRS from which to source data.
fmsPosIndexnumber | Subscribable<number>The index of the FMS geo-positioning system from which to source data.
activeNavIndicatorG3XTouchNavIndicatorThe nav indicator for the active nav source.
bearing1IndicatorG3XTouchNavIndicatorThe nav indicator for bearing pointer 1.
bearing2IndicatorG3XTouchNavIndicatorThe nav indicator for bearing pointer 2.
fplSourceDataProviderG3XFplSourceDataProviderA provider of flight plan source data.
settingManagerUserSettingManager<PfdHsiUserSettingTypes>A manager for HSI user settings.
supportAutopilotbooleanWhether autopilot mode sensing is supported.

Returns

DefaultHsiDataProvider

Properties

activeNavIndicator

readonly activeNavIndicator: G3XTouchNavIndicator

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HSI/HsiDataProvider.ts:192

The nav indicator for the active nav source.

Implementation of

HsiDataProvider.activeNavIndicator


bearing1Indicator

readonly bearing1Indicator: G3XTouchNavIndicator

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HSI/HsiDataProvider.ts:193

The nav indicator for bearing pointer 1.

Implementation of

HsiDataProvider.bearing1Indicator


bearing2Indicator

readonly bearing2Indicator: G3XTouchNavIndicator

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HSI/HsiDataProvider.ts:194

The nav indicator for bearing pointer 2.

Implementation of

HsiDataProvider.bearing2Indicator


externalFplSourceCount

readonly externalFplSourceCount: 0 | 1 | 2

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HSI/HsiDataProvider.ts:137

The number of supported external flight plan sources.

Implementation of

HsiDataProvider.externalFplSourceCount


fplSource

readonly fplSource: Subscribable<G3XFplSource>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HSI/HsiDataProvider.ts:139

The current flight plan source.

Implementation of

HsiDataProvider.fplSource


headingMag

readonly headingMag: Subscribable<number>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HSI/HsiDataProvider.ts:95

The current magnetic heading, in degrees.

Implementation of

HsiDataProvider.headingMag


isAhrsAligning

readonly isAhrsAligning: Subscribable<boolean>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HSI/HsiDataProvider.ts:147

Whether the AHRS that is this provider's source of heading data is aligning.

Implementation of

HsiDataProvider.isAhrsAligning


isGpsDataFailed

readonly isGpsDataFailed: Subscribable<boolean>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HSI/HsiDataProvider.ts:151

Whether GPS data is in a failure state.

Implementation of

HsiDataProvider.isGpsDataFailed


isHeadingDataFailed

readonly isHeadingDataFailed: Subscribable<boolean>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HSI/HsiDataProvider.ts:143

Whether heading data is in a failure state.

Implementation of

HsiDataProvider.isHeadingDataFailed


readonly lnavXtk: Subscribable<null | number>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HSI/HsiDataProvider.ts:127

The current LNAV cross-track error, in nautical miles, or null if LNAV is not tracking a path.

Implementation of

HsiDataProvider.lnavXtk


magVar

readonly magVar: Subscribable<number>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HSI/HsiDataProvider.ts:109

The magnetic variation at the plane's current position, in degrees.

Implementation of

HsiDataProvider.magVar


obsCourse

readonly obsCourse: Subscribable<number>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HSI/HsiDataProvider.ts:134

The current magnetic OBS course, in degrees.

Implementation of

HsiDataProvider.obsCourse


obsSuspMode

readonly obsSuspMode: Subscribable<ObsSuspModes>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HSI/HsiDataProvider.ts:132

The current LNAV OBS/suspend mode.

Implementation of

HsiDataProvider.obsSuspMode


orientationMode

readonly orientationMode: Subscribable<HsiOrientationMode>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HSI/HsiDataProvider.ts:91

The current active orientation mode.

Implementation of

HsiDataProvider.orientationMode


selectedHeadingMag

readonly selectedHeadingMag: Subscribable<number>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HSI/HsiDataProvider.ts:113

The current selected magnetic heading, in degrees.

Implementation of

HsiDataProvider.selectedHeadingMag


trackMag

readonly trackMag: Subscribable<null | number>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HSI/HsiDataProvider.ts:105

The current magnetic ground track, in degrees, or null if ground track is not available.

Implementation of

HsiDataProvider.trackMag


turnRate

readonly turnRate: Subscribable<number>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HSI/HsiDataProvider.ts:99

The current turn rate, in degrees per second.

Implementation of

HsiDataProvider.turnRate

Methods

destroy()

destroy(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HSI/HsiDataProvider.ts:370

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/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HSI/HsiDataProvider.ts:210

Initializes this data provider. Once initialized, this data provider will continuously update its data until paused or destroyed.

Parameters

ParameterTypeDefault valueDescription
pausedbooleanfalseWhether 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/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HSI/HsiDataProvider.ts:331

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/workingtitle-instruments-g3x-touch/html_ui/PFD/Components/HSI/HsiDataProvider.ts:292

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.