Interface: TerrainSystemModule
Defined in: src/garminsdk/terrain/TerrainSystemModule.ts:7
A module for a Garmin terrain alerting system. Modules are attached to a parent system, which update the modules and provide them with data.
Methods
onDestroy()
onDestroy():
void
Defined in: src/garminsdk/terrain/TerrainSystemModule.ts:35
A method that is called when this module's parent system is destroyed.
Returns
void
onInit()
onInit():
void
Defined in: src/garminsdk/terrain/TerrainSystemModule.ts:12
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
onUpdate()
onUpdate(
operatingMode,statuses,inhibits,data,alertController):void
Defined in: src/garminsdk/terrain/TerrainSystemModule.ts:24
A method that is called every time this module's parent system is updated.
Parameters
| Parameter | 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