Class: APFPADirector

Defined in: src/sdk/autopilot/directors/APFPADirector.ts:35

An autopilot director that generates flight director pitch commands to hold a flight path angle.

The director requires valid pitch, ground speed, and positional vertical speed data to arm or activate.

Implements

• PlaneDirector

Constructors

Constructor

new APFPADirector(apValues, options?): APFPADirector

Defined in: src/sdk/autopilot/directors/APFPADirector.ts:65

Creates a new instance of APFPADirector.

Parameters

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

Returns

APFPADirector

Properties

drivePitch()?

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

Defined in: src/sdk/autopilot/directors/APFPADirector.ts:49

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

---

onActivate()?

optional onActivate: () => void

Defined in: src/sdk/autopilot/directors/APFPADirector.ts:40

A callback called when this director is activated.

Returns

void

Implementation of

PlaneDirector.onActivate

---

onArm()?

optional onArm: () => void

Defined in: src/sdk/autopilot/directors/APFPADirector.ts:43

A callback called when this director is armed.

Returns

void

Implementation of

PlaneDirector.onArm

---

onDeactivate()?

optional onDeactivate: () => void

Defined in: src/sdk/autopilot/directors/APFPADirector.ts:46

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/APFPADirector.ts:37

The current director state.

Implementation of

PlaneDirector.state

Methods

activate()

activate(): void

Defined in: src/sdk/autopilot/directors/APFPADirector.ts:109

Activates this director.

Returns

void

Implementation of

PlaneDirector.activate

---

arm()

arm(): void

Defined in: src/sdk/autopilot/directors/APFPADirector.ts:126

Arms this director.

Returns

void

Implementation of

PlaneDirector.arm

---

deactivate()

deactivate(): void

Defined in: src/sdk/autopilot/directors/APFPADirector.ts:133

Deactivates this director.

Returns

void

Implementation of

PlaneDirector.deactivate

---

update()

update(): void

Defined in: src/sdk/autopilot/directors/APFPADirector.ts:148

Updates this director.

Returns

void

Implementation of

PlaneDirector.update