Interface: TerrainSystemModule
A module for a Garmin terrain alerting system. Modules are attached to a parent system, which update the modules and provide them with data.
Implemented by
GarminExcessiveClosureRateModuleGarminExcessiveDescentRateModuleGarminNegativeClimbRateModuleGarminPrematureDescentModuleGarminVoiceCalloutModule
Methods
onDestroy
▸ onDestroy(): void
A method that is called when this module's parent system is destroyed.
Returns
void
Defined in
src/garminsdk/terrain/TerrainSystemModule.ts:35
onInit
▸ onInit(): void
A method that is called when this module is attached to an initialized system, or when this module's parent system is initialized.
Returns
void
Defined in
src/garminsdk/terrain/TerrainSystemModule.ts:12
onUpdate
▸ onUpdate(operatingMode, statuses, inhibits, data, alertController): void
A method that is called every time this module's parent system is updated.
Parameters
| Name | Type | Description |
|---|---|---|
operatingMode | TerrainSystemOperatingMode | The parent system's current operating mode. |
statuses | ReadonlySet<string> | - |
inhibits | ReadonlySet<string> | The parent system's currently active inhibits. |
data | Readonly<TerrainSystemData> | The data provided by the parent system. |
alertController | TerrainSystemAlertController | A controller for alerts issued by the parent system. |
Returns
void
Defined in
src/garminsdk/terrain/TerrainSystemModule.ts:24