Class: DefaultHsiDataProvider

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

A default implementation of HsiDataProvider.

Implements

• HsiDataProvider

Constructors

Constructor

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

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

Creates a new instance of DefaultHsiDataProvider.

Parameters

Parameter	Type	Description
bus	EventBus	The event bus.
ahrsIndex	number | Subscribable<number>	The index of the AHRS from which to source data.
fmsPosIndex	number | Subscribable<number>	The index of the FMS geo-positioning system from which to source data.
navSources	G3XTouchNavSources	A collection of all navigation sources.
activeNavIndicator	G3XTouchNavIndicator	The nav indicator for the active nav source.
bearing1Indicator	G3XTouchNavIndicator	The nav indicator for bearing pointer 1.
bearing2Indicator	G3XTouchNavIndicator	The nav indicator for bearing pointer 2.
fplSourceDataProvider	G3XFplSourceDataProvider	A provider of flight plan source data.
settingManager	UserSettingManager<PfdHsiUserSettingTypes>	A manager for HSI user settings.
supportAutopilot	boolean	Whether 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:215

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:216

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:217

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:154

The number of supported external flight plan sources.

Implementation of

HsiDataProvider.externalFplSourceCount

---

externalSourceDefs

readonly externalSourceDefs: readonly (Readonly<G3XFplSourceDataProviderSourceDef> | undefined)[]

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

Definitions describing the external flight plan sources. The index of each definition corresponds to the index of the source's parent external navigator.

Implementation of

HsiDataProvider.externalSourceDefs

---

fplSource

readonly fplSource: Subscribable<G3XFplSource>

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

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:110

The current magnetic heading, in degrees.

Implementation of

HsiDataProvider.headingMag

---

internalSourceDef

readonly internalSourceDef: Readonly<G3XFplSourceDataProviderSourceDef>

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

The definition describing the internal flight plan source.

Implementation of

HsiDataProvider.internalSourceDef

---

isAhrsAligning

readonly isAhrsAligning: Subscribable<boolean>

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

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:172

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:164

Whether heading data is in a failure state.

Implementation of

HsiDataProvider.isHeadingDataFailed

---

isObsAvailable

readonly isObsAvailable: Subscribable<boolean>

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

Whether OBS mode can be activated.

Implementation of

HsiDataProvider.isObsAvailable

---

lnavXtk

readonly lnavXtk: Subscribable<number | null>

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

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:124

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

Implementation of

HsiDataProvider.magVar

---

navSources

readonly navSources: G3XTouchNavSources

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

A collection of all navigation sources.

Implementation of

HsiDataProvider.navSources

---

obsCourse

readonly obsCourse: Subscribable<number>

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

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:147

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:106

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:128

The current selected magnetic heading, in degrees.

Implementation of

HsiDataProvider.selectedHeadingMag

---

trackMag

readonly trackMag: Subscribable<number | null>

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

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:114

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:393

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:233

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

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:315

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.