Skip to main content

Interface: TerrainSystem

Defined in: src/garminsdk/terrain/TerrainSystem.ts:6

A Garmin terrain alerting system.

Properties

id

readonly id: string

Defined in: src/garminsdk/terrain/TerrainSystem.ts:8

This system's ID.


type

readonly type: string

Defined in: src/garminsdk/terrain/TerrainSystem.ts:11

This system's type.

Methods

addInhibit()

addInhibit(inhibit): void

Defined in: src/garminsdk/terrain/TerrainSystem.ts:44

Adds an inhibit flag to this system.

Parameters

ParameterTypeDescription
inhibitstringThe flag to add.

Returns

void


addModule()

addModule(module): void

Defined in: src/garminsdk/terrain/TerrainSystem.ts:17

Adds a module to this system.

Parameters

ParameterTypeDescription
moduleTerrainSystemModuleThe module to add.

Returns

void


destroy()

destroy(): void

Defined in: src/garminsdk/terrain/TerrainSystem.ts:65

Destroys this system. Once destroyed, this system can no longer be updated.

Returns

void


init()

init(): void

Defined in: src/garminsdk/terrain/TerrainSystem.ts:23

Initializes this system. Once the system is initialized, it can begin updating its internal state and issuing alerts and will publish its state to the event bus.

Returns

void


removeAllInhibits()

removeAllInhibits(): void

Defined in: src/garminsdk/terrain/TerrainSystem.ts:55

Removes all inhibit flags from this system.

Returns

void


removeInhibit()

removeInhibit(inhibit): void

Defined in: src/garminsdk/terrain/TerrainSystem.ts:50

Removes an inhibit flag from this system.

Parameters

ParameterTypeDescription
inhibitstringThe flag to remove.

Returns

void


startTest()

startTest(): void

Defined in: src/garminsdk/terrain/TerrainSystem.ts:38

Begins a self-test of this system.

Returns

void


turnOff()

turnOff(): void

Defined in: src/garminsdk/terrain/TerrainSystem.ts:33

Turns this system off.

Returns

void


turnOn()

turnOn(): void

Defined in: src/garminsdk/terrain/TerrainSystem.ts:28

Turns this system on.

Returns

void


update()

update(): void

Defined in: src/garminsdk/terrain/TerrainSystem.ts:60

Updates this system.

Returns

void