Class: APVNavPathDirector

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

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

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

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

---

drivePitch()?

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

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

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

Returns

void

Implementation of

PlaneDirector.drivePitch

---

fpaSimVar

protected fpaSimVar: string = VNavVars.FPA

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

---

getDeviationFunc()

protected readonly getDeviationFunc: () => number

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

Returns

number

---

getFpaFunc()

protected readonly getFpaFunc: () => number

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

Returns

number

---

guidance?

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

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

---

isGuidanceValidFunc()

protected readonly isGuidanceValidFunc: () => boolean

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

Returns

boolean

---

onActivate()?

optional onActivate: () => void

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

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

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

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

The current director state.

Implementation of

PlaneDirector.state

---

verticalWindAverage

protected verticalWindAverage: SimpleMovingAverage

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

---

vnavIndex?

protected readonly optional vnavIndex: Subscribable<number>

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

Methods

activate()

activate(): void

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

Activates this director.

Returns

void

Implementation of

PlaneDirector.activate

---

arm()

arm(): void

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

Arms this director.

Returns

void

Implementation of

PlaneDirector.arm

---

deactivate()

deactivate(): void

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

Deactivates this director.

Returns

void

Implementation of

PlaneDirector.deactivate

---

getDesiredPitch()

protected getDesiredPitch(): number

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

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

Updates this director.

Returns

void

Implementation of

PlaneDirector.update