Skip to main content

Class: APAltDirector

Defined in: src/sdk/autopilot/directors/APAltDirector.ts:31

An autopilot director that generates flight director pitch commands to hold an indicated altitude.

The director requires valid pitch, indicated altitude and indicated vertical speed data to arm or activate.

Implements​

Constructors​

Constructor​

new APAltDirector(apValues, options?): APAltDirector

Defined in: src/sdk/autopilot/directors/APAltDirector.ts:61

Creates a new instance of APAltDirector.

Parameters​

ParameterTypeDescription
apValuesAPValuesAutopilot values from this director's parent autopilot.
options?Readonly<APAltDirectorOptions>Options with which to configure the director.

Returns​

APAltDirector

Properties​

drivePitch()?​

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

Defined in: src/sdk/autopilot/directors/APAltDirector.ts:37

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
rate?number
maxNoseDownPitch?number
maxNoseUpPitch?number

Returns​

void

Implementation of​

PlaneDirector.drivePitch


onActivate()?​

optional onActivate: () => void

Defined in: src/sdk/autopilot/directors/APAltDirector.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/APAltDirector.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/APAltDirector.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/APAltDirector.ts:34

The current director state.

Implementation of​

PlaneDirector.state

Methods​

activate()​

activate(): void

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

Activates this director.

Returns​

void

Implementation of​

PlaneDirector.activate


arm()​

arm(): void

Defined in: src/sdk/autopilot/directors/APAltDirector.ts:108

Arms this director.

Returns​

void

Implementation of​

PlaneDirector.arm


deactivate()​

deactivate(): void

Defined in: src/sdk/autopilot/directors/APAltDirector.ts:121

Deactivates this director.

Returns​

void

Implementation of​

PlaneDirector.deactivate


update()​

update(): void

Defined in: src/sdk/autopilot/directors/APAltDirector.ts:136

Updates this director.

Returns​

void

Implementation of​

PlaneDirector.update