Class: GarminExcessiveClosureRateModule
Defined in: src/garminsdk/terrain/modules/ecr/GarminExcessiveClosureRateModule.ts:101
A Garmin terrain alerting system module that handles excessive closure rate (ECR) alerts.
Implements
Constructors
Constructor
new GarminExcessiveClosureRateModule(
options?):GarminExcessiveClosureRateModule
Defined in: src/garminsdk/terrain/modules/ecr/GarminExcessiveClosureRateModule.ts:138
Creates a new instance of GarminExcessiveClosureRateModule.
Parameters
| Parameter | Type | Description |
|---|---|---|
options? | Readonly<GarminExcessiveClosureRateModuleOptions> | Options with which to configure the module. |
Returns
GarminExcessiveClosureRateModule
Methods
onDestroy()
onDestroy():
void
Defined in: src/garminsdk/terrain/modules/ecr/GarminExcessiveClosureRateModule.ts:447
A method that is called when this module's parent system is destroyed.
Returns
void
Implementation of
onInit()
onInit():
void
Defined in: src/garminsdk/terrain/modules/ecr/GarminExcessiveClosureRateModule.ts:158
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
Implementation of
onUpdate()
onUpdate(
operatingMode,statuses,inhibits,data,alertController):void
Defined in: src/garminsdk/terrain/modules/ecr/GarminExcessiveClosureRateModule.ts:163
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> | The parent system's currently active status flags. |
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