Class: APAltCapDirector

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

An autopilot director that generates flight director pitch commands to capture a target indicated altitude.

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

Implements

• PlaneDirector

Constructors

Constructor

new APAltCapDirector(apValues, options?): APAltCapDirector

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

Creates an instance of the APAltCapDirector.

Parameters

Parameter	Type	Description
apValues	APValues	Autopilot 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. --> targetChangeInhibitTime: The time to inhibit altitude capture when the target altitude is changed, in ms. Setting the time to null disables inhibition. Defaults to 500 ms. Note that if alt capture is already active when the target is changed, this will have no effect.

Returns

APAltCapDirector

Properties

drivePitch()?

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

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

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

A callback called when this director is activated.

Returns

void

Implementation of

PlaneDirector.onActivate

---

onArm()?

optional onArm: () => void

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

A callback called when this director is armed.

Returns

void

Implementation of

PlaneDirector.onArm

---

onDeactivate()?

optional onDeactivate: () => void

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

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

The current director state.

Implementation of

PlaneDirector.state

Methods

activate()

activate(): void

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

Activates this director.

Returns

void

Implementation of

PlaneDirector.activate

---

arm()

arm(): void

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

Arms this director.

Returns

void

Implementation of

PlaneDirector.arm

---

deactivate()

deactivate(): void

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

Deactivates this director.

Returns

void

Implementation of

PlaneDirector.deactivate

---

update()

update(): void

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

Updates this director.

Returns

void

Implementation of

PlaneDirector.update