Skip to main content

Class: GarminNegativeClimbRateModule

Defined in: src/garminsdk/terrain/modules/ncr/GarminNegativeClimbRateModule.ts:51

A Garmin terrain alerting system module that handles negative climb rate after takeoff (NCR) alerts.

Implements

Constructors

Constructor

new GarminNegativeClimbRateModule(options?): GarminNegativeClimbRateModule

Defined in: src/garminsdk/terrain/modules/ncr/GarminNegativeClimbRateModule.ts:83

Creates a new instance of GarminNegativeClimbRateModule.

Parameters

ParameterTypeDescription
options?Readonly<GarminNegativeClimbRateModuleOptions>Options with which to configure the module.

Returns

GarminNegativeClimbRateModule

Methods

onDestroy()

onDestroy(): void

Defined in: src/garminsdk/terrain/modules/ncr/GarminNegativeClimbRateModule.ts:302

A method that is called when this module's parent system is destroyed.

Returns

void

Implementation of

TerrainSystemModule.onDestroy


onInit()

onInit(): void

Defined in: src/garminsdk/terrain/modules/ncr/GarminNegativeClimbRateModule.ts:93

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

TerrainSystemModule.onInit


onUpdate()

onUpdate(operatingMode, statuses, inhibits, data, alertController): void

Defined in: src/garminsdk/terrain/modules/ncr/GarminNegativeClimbRateModule.ts:98

A method that is called every time this module's parent system is updated.

Parameters

ParameterTypeDescription
operatingModeTerrainSystemOperatingModeThe parent system's current operating mode.
statusesReadonlySet<string>-
inhibitsReadonlySet<string>The parent system's currently active inhibits.
dataReadonly<TerrainSystemData>The data provided by the parent system.
alertControllerTerrainSystemAlertControllerA controller for alerts issued by the parent system.

Returns

void

Implementation of

TerrainSystemModule.onUpdate