Skip to main content

Class: APFPADirector

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

A flight path angle autopilot director.

Implements

Constructors

Constructor

new APFPADirector(apValues, options?): APFPADirector

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

Creates an instance of the FPA Director.

Parameters

ParameterTypeDescription
apValuesAPValuesare the ap selected values for the autopilot.
options?Partial<Readonly<APFPADirectorOptions>>Options to configure the new director. Option values default to the following if not defined: * maxFpa: undefined

Returns

APFPADirector

Properties

drivePitch()?

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

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

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


onActivate()?

optional onActivate: () => void

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

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

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

Returns

void

Implementation of

PlaneDirector.onArm


state

state: DirectorState

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

The current director state.

Implementation of

PlaneDirector.state

Methods

activate()

activate(): void

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

Activates this director.

Returns

void

Implementation of

PlaneDirector.activate


arm()

arm(): void

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

Arms this director. This director has no armed mode, so it activates immediately.

Returns

void

Implementation of

PlaneDirector.arm


deactivate()

deactivate(): void

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

Deactivates this director.

Returns

void

Implementation of

PlaneDirector.deactivate


update()

update(): void

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

Updates this director.

Returns

void

Implementation of

PlaneDirector.update