Skip to main content

Class: APVNavPathDirector

Defined in: src/sdk/autopilot/directors/APVNavPathDirector.ts:52

A VNAV Path autopilot director.

Implements​

Constructors​

Constructor​

new APVNavPathDirector(bus, options?): APVNavPathDirector

Defined in: src/sdk/autopilot/directors/APVNavPathDirector.ts:86

Creates a new instance of APVNavPathDirector.

Parameters​

ParameterTypeDescription
busEventBusThe event bus.
options?Readonly<APVNavPathDirectorOptions>Options with which to configure the director.

Returns​

APVNavPathDirector

Properties​

deviationSimVar​

protected deviationSimVar: string = VNavVars.VerticalDeviation

Defined in: src/sdk/autopilot/directors/APVNavPathDirector.ts:74


drivePitch()?​

optional drivePitch: (pitch, adjustForAoa?, adjustForVerticalWind?) => void

Defined in: src/sdk/autopilot/directors/APVNavPathDirector.ts:66

A function used to drive the autopilot commanded pitch angle toward a desired value while optionally correcting for angle of attack and vertical wind.

Parameters​

ParameterType
pitchnumber
adjustForAoa?boolean
adjustForVerticalWind?boolean

Returns​

void

Implementation of​

PlaneDirector.drivePitch


fpaSimVar​

protected fpaSimVar: string = VNavVars.FPA

Defined in: src/sdk/autopilot/directors/APVNavPathDirector.ts:75


getDeviationFunc()​

protected readonly getDeviationFunc: () => number

Defined in: src/sdk/autopilot/directors/APVNavPathDirector.ts:79

Returns​

number


getFpaFunc()​

protected readonly getFpaFunc: () => number

Defined in: src/sdk/autopilot/directors/APVNavPathDirector.ts:78

Returns​

number


guidance?​

protected readonly optional guidance: Accessible<Readonly<APVNavPathDirectorGuidance>>

Defined in: src/sdk/autopilot/directors/APVNavPathDirector.ts:70


isGuidanceValidFunc()​

protected readonly isGuidanceValidFunc: () => boolean

Defined in: src/sdk/autopilot/directors/APVNavPathDirector.ts:77

Returns​

boolean


onActivate()?​

optional onActivate: () => void

Defined in: src/sdk/autopilot/directors/APVNavPathDirector.ts:57

A callback called when a mode signals it should be activated.

Returns​

void

Implementation of​

PlaneDirector.onActivate


onArm()?​

optional onArm: () => void

Defined in: src/sdk/autopilot/directors/APVNavPathDirector.ts:60

A callback called when a mode signals it should be armed.

Returns​

void

Implementation of​

PlaneDirector.onArm


onDeactivate()?​

optional onDeactivate: () => void

Defined in: src/sdk/autopilot/directors/APVNavPathDirector.ts:63

A callback called when a mode signals it should be deactivated.

Returns​

void

Implementation of​

PlaneDirector.onDeactivate


state​

state: DirectorState

Defined in: src/sdk/autopilot/directors/APVNavPathDirector.ts:54

The current director state.

Implementation of​

PlaneDirector.state


verticalWindAverage​

protected verticalWindAverage: SimpleMovingAverage

Defined in: src/sdk/autopilot/directors/APVNavPathDirector.ts:68


vnavIndex?​

protected readonly optional vnavIndex: Subscribable<number>

Defined in: src/sdk/autopilot/directors/APVNavPathDirector.ts:72

Methods​

activate()​

activate(): void

Defined in: src/sdk/autopilot/directors/APVNavPathDirector.ts:115

Activates the guidance mode.

Returns​

void

Implementation of​

PlaneDirector.activate


arm()​

arm(): void

Defined in: src/sdk/autopilot/directors/APVNavPathDirector.ts:124

Arms the guidance mode.

Returns​

void

Implementation of​

PlaneDirector.arm


deactivate()​

deactivate(): void

Defined in: src/sdk/autopilot/directors/APVNavPathDirector.ts:134

Deactivates the guidance mode.

Returns​

void

Implementation of​

PlaneDirector.deactivate


getDesiredPitch()​

protected getDesiredPitch(): number

Defined in: src/sdk/autopilot/directors/APVNavPathDirector.ts:155

Gets a desired pitch from the FPA, AOA and Deviation.

Returns​

number

The desired pitch angle.


update()​

update(): void

Defined in: src/sdk/autopilot/directors/APVNavPathDirector.ts:140

Updates the guidance mode control loops.

Returns​

void

Implementation of​

PlaneDirector.update