Skip to main content

Class: APAltDirector

An altitude hold autopilot director.

Implements

Constructors

constructor

new APAltDirector(apValues): APAltDirector

Creates an instance of the LateralDirector.

Parameters

NameTypeDescription
apValuesAPValuesare the ap selected values for the autopilot.

Returns

APAltDirector

Defined in

src/sdk/autopilot/directors/APAltDirector.ts:39

Properties

drivePitch

Optional drivePitch: (pitch: number, adjustForAoa?: boolean, adjustForVerticalWind?: boolean) => void

A function used to drive the autopilot commanded pitch angle toward a desired value while optionally correcting for angle of attack and vertical wind.

Param

The desired pitch angle, in degrees. Positive values indicate downward pitch.

Param

Whether to adjust the commanded pitch angle for angle of attack. If true, the provided pitch angle is treated as a desired flight path angle and a new commanded pitch angle will be calculated to produce the desired FPA given the airplane's current angle of attack. This correction can be used in conjunction with the vertical wind correction. Defaults to false.

Param

Whether to adjust the commanded pitch angle for vertical wind velocity. If true, the provided pitch angle is treated as a desired flight path angle and a new commanded pitch angle will be calculated to produce the desired FPA given the current vertical wind component. This correction can be used in conjunction with the angle of attack correction. Defaults to false.

Param

The rate at which to drive the commanded pitch angle, in degrees per second. If not defined, a default rate will be used.

Type declaration

▸ (pitch, adjustForAoa?, adjustForVerticalWind?): void

Parameters
NameType
pitchnumber
adjustForAoa?boolean
adjustForVerticalWind?boolean
Returns

void

Inherit Doc

Implementation of

PlaneDirector.drivePitch

Defined in

src/sdk/autopilot/directors/APAltDirector.ts:19


onActivate

Optional onActivate: () => void

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

Type declaration

▸ (): void

Returns

void

Inherit Doc

Implementation of

PlaneDirector.onActivate

Defined in

src/sdk/autopilot/directors/APAltDirector.ts:22


onArm

Optional onArm: () => void

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

Type declaration

▸ (): void

Returns

void

Inherit Doc

Implementation of

PlaneDirector.onArm

Defined in

src/sdk/autopilot/directors/APAltDirector.ts:25


state

state: DirectorState

The current director state.

Implementation of

PlaneDirector.state

Defined in

src/sdk/autopilot/directors/APAltDirector.ts:16

Methods

activate

activate(): void

Activates this director.

Returns

void

Implementation of

PlaneDirector.activate

Defined in

src/sdk/autopilot/directors/APAltDirector.ts:59


arm

arm(): void

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

Returns

void

Implementation of

PlaneDirector.arm

Defined in

src/sdk/autopilot/directors/APAltDirector.ts:72


deactivate

deactivate(): void

Deactivates this director.

Returns

void

Implementation of

PlaneDirector.deactivate

Defined in

src/sdk/autopilot/directors/APAltDirector.ts:83


update

update(): void

Updates this director.

Returns

void

Implementation of

PlaneDirector.update

Defined in

src/sdk/autopilot/directors/APAltDirector.ts:92