Skip to main content

Interface: TerrainSystem

A Garmin terrain alerting system.

Implemented by​

Properties​

id​

• Readonly id: string

This system's ID.

Defined in​

src/garminsdk/terrain/TerrainSystem.ts:8

type​

• Readonly type: string

This system's type.

Defined in​

src/garminsdk/terrain/TerrainSystem.ts:11

Methods​

addInhibit​

▸ addInhibit(inhibit): void

Adds an inhibit flag to this system.

Parameters​

NameTypeDescription
inhibitstringThe flag to add.

Returns​

void

Defined in​

src/garminsdk/terrain/TerrainSystem.ts:44

addModule​

▸ addModule(module): void

Adds a module to this system.

Parameters​

NameTypeDescription
moduleTerrainSystemModuleThe module to add.

Returns​

void

Defined in​

src/garminsdk/terrain/TerrainSystem.ts:17

destroy​

▸ destroy(): void

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

Returns​

void

Defined in​

src/garminsdk/terrain/TerrainSystem.ts:65

init​

▸ init(): void

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

Defined in​

src/garminsdk/terrain/TerrainSystem.ts:23

removeAllInhibits​

▸ removeAllInhibits(): void

Removes all inhibit flags from this system.

Returns​

void

Defined in​

src/garminsdk/terrain/TerrainSystem.ts:55

removeInhibit​

▸ removeInhibit(inhibit): void

Removes an inhibit flag from this system.

Parameters​

NameTypeDescription
inhibitstringThe flag to remove.

Returns​

void

Defined in​

src/garminsdk/terrain/TerrainSystem.ts:50

startTest​

▸ startTest(): void

Begins a self-test of this system.

Returns​

void

Defined in​

src/garminsdk/terrain/TerrainSystem.ts:38

turnOff​

▸ turnOff(): void

Turns this system off.

Returns​

void

Defined in​

src/garminsdk/terrain/TerrainSystem.ts:33

turnOn​

▸ turnOn(): void

Turns this system on.

Returns​

void

Defined in​

src/garminsdk/terrain/TerrainSystem.ts:28

update​

▸ update(): void

Updates this system.

Returns​

void

Defined in​

src/garminsdk/terrain/TerrainSystem.ts:60