Class: GarminObsLNavModule

Defined in: src/garminsdk/autopilot/lnav/GarminObsLNavModule.ts:30

An LNAV computer module that calculates lateral navigation for an OBS course to the active flight plan waypoint.

Implements

• LNavOverrideModule

Constructors

Constructor

new GarminObsLNavModule(index, bus, flightPlanner, options?): GarminObsLNavModule

Defined in: src/garminsdk/autopilot/lnav/GarminObsLNavModule.ts:76

Creates a new instance of GarminObsLNavModule.

Parameters

Parameter	Type	Description
index	number	The index of this module's parent computer.
bus	EventBus	The event bus.
flightPlanner	FlightPlanner	The flight planner from which to source the active flight plan.
options?	Readonly<GarminObsLNavModuleOptions>	Options with which to configure the new module.

Returns

GarminObsLNavModule

Properties

index

readonly index: number

Defined in: src/garminsdk/autopilot/lnav/GarminObsLNavModule.ts:77

The index of this module's parent computer.

Methods

activate()

activate(lnavState, aircraftState, eventBusTopicRecord): void

Defined in: src/garminsdk/autopilot/lnav/GarminObsLNavModule.ts:147

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

Parameters

Parameter	Type	Description
lnavState	LNavState	The current LNAV state.
aircraftState	Readonly<LNavAircraftState>	The current state of the airplane.
eventBusTopicRecord	LNavEventBusTopicPublisherRecord	A record of publishers to use to publish data to LNAV event bus topics.

Returns

void

Implementation of

LNavOverrideModule.activate

---

canActivate()

canActivate(): boolean

Defined in: src/garminsdk/autopilot/lnav/GarminObsLNavModule.ts:142

Checks whether this module can be activated.

Returns

boolean

Implementation of

LNavOverrideModule.canActivate

---

deactivate()

deactivate(lnavState): void

Defined in: src/garminsdk/autopilot/lnav/GarminObsLNavModule.ts:166

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

Parameter	Type	Description
lnavState	LNavState	The current LNAV state.

Returns

void

Implementation of

LNavOverrideModule.deactivate

---

getSteerCommand()

getSteerCommand(): Readonly<LNavSteerCommand>

Defined in: src/garminsdk/autopilot/lnav/GarminObsLNavModule.ts:132

Gets this module's generated steering command.

Returns

Readonly<LNavSteerCommand>

This module's generated steering command.

Implementation of

LNavOverrideModule.getSteerCommand

---

isActive()

isActive(): boolean

Defined in: src/garminsdk/autopilot/lnav/GarminObsLNavModule.ts:137

Checks whether this module is active.

Returns

boolean

Whether this module is active.

Implementation of

LNavOverrideModule.isActive

---

update()

update(lnavState, aircraftState, eventBusTopicRecord?): void

Defined in: src/garminsdk/autopilot/lnav/GarminObsLNavModule.ts:177

Updates this module.

Parameters

Parameter	Type	Description
lnavState	LNavState	The current LNAV state.
aircraftState	Readonly<LNavAircraftState>	The current state of the airplane.
eventBusTopicRecord?	LNavEventBusTopicPublisherRecord	A record of publishers to use to publish data to LNAV event bus topics. The record is only provided when the module is active.

Returns

void

Implementation of

LNavOverrideModule.update