Class: APVNavPathDirector

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

An autopilot director that generates flight director pitch commands to track a VNAV path.

If the director is created with access to an APValues object, then the director requires valid pitch data to arm or activate.

Implements

• PlaneDirector

Constructors

Constructor

new APVNavPathDirector(apValues, options?): APVNavPathDirector

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

Creates a new instance of APVNavPathDirector.

Parameters

Parameter	Type	Description
apValues	APValues	Autopilot values from this director's parent autopilot.
options?	Readonly<APVNavPathDirectorOptions>	Options with which to configure the director.

Returns

APVNavPathDirector

Constructor

new APVNavPathDirector(bus, options?): APVNavPathDirector

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

Creates a new instance of APVNavPathDirector.

Parameters

Parameter	Type	Description
bus	EventBus	The event bus.
options?	Readonly<APVNavPathDirectorOptions>	Options with which to configure the director.

Returns

APVNavPathDirector

Deprecated

Please use the overload that takes an APValues object instead.

Properties

deviationSimVar

protected deviationSimVar: string = VNavVars.VerticalDeviation

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

---

drivePitch()?

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

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

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

Parameter	Type
pitch	number
adjustForAoa?	boolean
adjustForVerticalWind?	boolean
rate?	number
maxNoseDownPitch?	number
maxNoseUpPitch?	number

Returns

void

Implementation of

PlaneDirector.drivePitch

---

fpaSimVar

protected fpaSimVar: string = VNavVars.FPA

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

---

getDeviationFunc()

protected readonly getDeviationFunc: () => number

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

Returns

number

---

getFpaFunc()

protected readonly getFpaFunc: () => number

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

Returns

number

---

guidance?

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

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

---

isGuidanceValidFunc()

protected readonly isGuidanceValidFunc: () => boolean

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

Returns

boolean

---

onActivate()?

optional onActivate: () => void

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

A callback called when this director is activated.

Returns

void

Implementation of

PlaneDirector.onActivate

---

onArm()?

optional onArm: () => void

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

A callback called when this director is armed.

Returns

void

Implementation of

PlaneDirector.onArm

---

onDeactivate()?

optional onDeactivate: () => void

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

A callback that is called when this director is deactivated.

Returns

void

Implementation of

PlaneDirector.onDeactivate

---

state

state: DirectorState

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

The current director state.

Implementation of

PlaneDirector.state

---

verticalWindAverage

protected verticalWindAverage: SimpleMovingAverage

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

---

vnavIndex?

protected readonly optional vnavIndex: Subscribable<number>

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

Methods

activate()

activate(): void

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

Activates this director.

Returns

void

Implementation of

PlaneDirector.activate

---

arm()

arm(): void

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

Arms this director.

Returns

void

Implementation of

PlaneDirector.arm

---

deactivate()

deactivate(): void

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

Deactivates this director.

Returns

void

Implementation of

PlaneDirector.deactivate

---

getDesiredPitch()

protected getDesiredPitch(): number

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

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:224

Updates this director.

Returns

void

Implementation of

PlaneDirector.update