Skip to main content

Class: APAltCapDirector

Defined in: src/sdk/autopilot/directors/APAltCapDirector.ts:59

An altitude capture autopilot director.

Implements

Constructors

Constructor

new APAltCapDirector(apValues, options?): APAltCapDirector

Defined in: src/sdk/autopilot/directors/APAltCapDirector.ts:85

Creates an instance of the APAltCapDirector.

Parameters

ParameterTypeDescription
apValuesAPValuesAutopilot data for this director.
options?Partial<Readonly<APAltCapDirectorOptions>>Optional options object with these: --> shouldActivate: An optional function which returns true if the capturing shall be activated. If not defined, a default function is used. --> captureAltitude: An optional function which calculates desired pitch angles to capture a target altitude. If not defined, a default function is used.

Returns

APAltCapDirector

Properties

drivePitch()?

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

Defined in: src/sdk/autopilot/directors/APAltCapDirector.ts:70

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/APAltCapDirector.ts:64

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/APAltCapDirector.ts:67

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/APAltCapDirector.ts:61

The current director state.

Implementation of

PlaneDirector.state

Methods

activate()

activate(vs?, alt?): void

Defined in: src/sdk/autopilot/directors/APAltCapDirector.ts:104

Activates this director.

Parameters

ParameterTypeDescription
vs?numberOptionally, the current vertical speed, in FPM.
alt?numberOptionally, the current indicated altitude, in Feet.

Returns

void

Implementation of

PlaneDirector.activate


arm()

arm(): void

Defined in: src/sdk/autopilot/directors/APAltCapDirector.ts:120

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

Returns

void

Implementation of

PlaneDirector.arm


deactivate()

deactivate(captured): void

Defined in: src/sdk/autopilot/directors/APAltCapDirector.ts:131

Deactivates this director.

Parameters

ParameterTypeDefault valueDescription
capturedbooleanfalseis whether the altitude was captured.

Returns

void

Implementation of

PlaneDirector.deactivate


update()

update(): void

Defined in: src/sdk/autopilot/directors/APAltCapDirector.ts:141

Updates this director.

Returns

void

Implementation of

PlaneDirector.update