Class: GpwsAlertController
Defined in: workingtitle-instruments-epic2/shared/GPWS/GpwsAlertController.ts:25
A class responsible for controlling GPWS alerts
Constructors
Constructor
new GpwsAlertController(
bus):GpwsAlertController
Defined in: workingtitle-instruments-epic2/shared/GPWS/GpwsAlertController.ts:32
Parameters
| Parameter | Type |
|---|---|
bus | EventBus |
Returns
GpwsAlertController
Inherit Doc
Methods
registerAlert()
registerAlert(
id,definition):void
Defined in: workingtitle-instruments-epic2/shared/GPWS/GpwsAlertController.ts:40
Registers a GPWS alert
Parameters
| Parameter | Type | Description |
|---|---|---|
id | string | The ID of the alert, to be later used to trigger an alert |
definition | GpwsAlertDefinition | The alerts definition |
Returns
void
triggerAlert()
triggerAlert(
id):void
Defined in: workingtitle-instruments-epic2/shared/GPWS/GpwsAlertController.ts:100
Triggers a GPWS alert
Parameters
| Parameter | Type | Description |
|---|---|---|
id | string | The ID of the alert to trigger |
Returns
void
triggerAuralAlert()
triggerAuralAlert(
id):boolean
Defined in: workingtitle-instruments-epic2/shared/GPWS/GpwsAlertController.ts:127
Triggers the aural component of an already triggered GPWS alert
Parameters
| Parameter | Type | Description |
|---|---|---|
id | string | The ID of the alert to play |
Returns
boolean
If the aural alert played
untriggerAlert()
untriggerAlert(
id):void
Defined in: workingtitle-instruments-epic2/shared/GPWS/GpwsAlertController.ts:112
Untriggers a GPWS alert
Parameters
| Parameter | Type | Description |
|---|---|---|
id | string | The ID of the alert to trigger |
Returns
void