Skip to main content

Interface: LNavOverrideModule

Defined in: src/sdk/autopilot/lnav/LNavOverrideModule.ts:6

A module that can optionally override an LNAV computer's default tracking behavior.

Methods

activate()

activate(lnavState, aircraftState): void

Defined in: src/sdk/autopilot/lnav/LNavOverrideModule.ts:32

Activates this module. When this module is activated, it is responsible for generating steering commands and publishing LNAV data to the event bus.

Parameters

ParameterTypeDescription
lnavStateLNavStateThe current LNAV state.
aircraftStateReadonly<LNavAircraftState>The current state of the airplane.

Returns

void


canActivate()

canActivate(lnavState, aircraftState): boolean

Defined in: src/sdk/autopilot/lnav/LNavOverrideModule.ts:24

Checks whether this module can be activated.

Parameters

ParameterTypeDescription
lnavStateLNavStateThe current LNAV state.
aircraftStateReadonly<LNavAircraftState>The current state of the airplane.

Returns

boolean


deactivate()

deactivate(lnavState): void

Defined in: src/sdk/autopilot/lnav/LNavOverrideModule.ts:39

Deactivates this module. When this module is deactivated, it is no longer responsible for generating steering commands or publishing LNAV data to the event bus.

Parameters

ParameterTypeDescription
lnavStateLNavStateThe current LNAV state.

Returns

void


getSteerCommand()

getSteerCommand(): Readonly<LNavSteerCommand>

Defined in: src/sdk/autopilot/lnav/LNavOverrideModule.ts:11

Gets this module's generated steering command.

Returns

Readonly<LNavSteerCommand>

This module's generated steering command.


isActive()

isActive(): boolean

Defined in: src/sdk/autopilot/lnav/LNavOverrideModule.ts:17

Checks whether this module is active.

Returns

boolean

Whether this module is active.


update()

update(lnavState, aircraftState): void

Defined in: src/sdk/autopilot/lnav/LNavOverrideModule.ts:46

Updates this module.

Parameters

ParameterTypeDescription
lnavStateLNavStateThe current LNAV state.
aircraftStateReadonly<LNavAircraftState>The current state of the airplane.

Returns

void