Class: G3XObsController
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Navigation/G3XObsController.ts:29
A controller of GPS OBS state for the G3X Touch.
Constructors
Constructor
new G3XObsController(
bus,fplSourceDataProvider,navSources,fplSource):G3XObsController
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Navigation/G3XObsController.ts:49
Creates a new instance of G3XObsController.
Parameters
| Parameter | Type | Description |
|---|---|---|
bus | EventBus | The event bus. |
fplSourceDataProvider | G3XObsControllerFplSourceDataProvider | A provider of flight plan source data. |
navSources | G3XTouchNavSources | A collection of all navigation sources. |
fplSource | G3XFplSource | Subscribable<G3XFplSource> | The flight plan source to control. |
Returns
G3XObsController
Properties
obsSuspDataProvider
readonlyobsSuspDataProvider:ObsSuspDataProvider
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Navigation/G3XObsController.ts:38
A provider of OBS data for this controller's flight plan source.
Methods
activateObs()
activateObs(
course?):Promise<void>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Navigation/G3XObsController.ts:111
Sends commands to activates OBS mode and optionally sets an initial OBS course. This has no effect if OBS mode is not available for this controller's flight plan source.
Parameters
| Parameter | Type | Description |
|---|---|---|
course? | number | The OBS course to set after OBS mode has been activated, in degrees. If not defined, then the OBS course will be set to the bearing to the OBS fix. |
Returns
Promise<void>
A Promise which will fulfill after this method has finished sending all commands to change OBS state. Note that there is no guarantee that OBS state will have been successfully changed as a result of the commands that were sent when the Promise fulfills.
deactivateObs()
deactivateObs():
Promise<void>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Navigation/G3XObsController.ts:211
Sends commands to deactivate OBS mode.
Returns
Promise<void>
A Promise which will fulfill after this method has finished sending all commands to change OBS state. Note that there is no guarantee that OBS state will have been successfully changed as a result of the commands that were sent when the Promise fulfills.
decObsCourse()
decObsCourse():
Promise<void>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Navigation/G3XObsController.ts:179
Sends commands to decrement the OBS course. This has no effect if OBS mode is not active.
Returns
Promise<void>
A Promise which will fulfill after this method has finished sending all commands to change OBS state. Note that there is no guarantee that OBS state will have been successfully changed as a result of the commands that were sent when the Promise fulfills.
destroy()
destroy():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Navigation/G3XObsController.ts:222
Destroys this controller.
Returns
void
incObsCourse()
incObsCourse():
Promise<void>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Navigation/G3XObsController.ts:165
Sends commands to increment the OBS course. This has no effect if OBS mode is not active.
Returns
Promise<void>
A Promise which will fulfill after this method has finished sending all commands to change OBS state. Note that there is no guarantee that OBS state will have been successfully changed as a result of the commands that were sent when the Promise fulfills.
setObsCourse()
setObsCourse(
course):Promise<void>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Navigation/G3XObsController.ts:151
Sends commands to set the OBS course. This has no effect if OBS mode is not active.
Parameters
| Parameter | Type | Description |
|---|---|---|
course | number | The course to set, in degrees. |
Returns
Promise<void>
A Promise which will fulfill after this method has finished sending all commands to change OBS state. Note that there is no guarantee that OBS state will have been successfully changed as a result of the commands that were sent when the Promise fulfills.
syncObsCourse()
syncObsCourse():
Promise<void>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Navigation/G3XObsController.ts:194
Sends commands to sync the OBS course to the current bearing to the OBS fix. This has no effect if OBS mode is not active or if the bearing to the OBS fix cannot be retrieved.
Returns
Promise<void>
A Promise which will fulfill after this method has finished sending all commands to change OBS state. Note that there is no guarantee that OBS state will have been successfully changed as a result of the commands that were sent when the Promise fulfills.