Class: APAltCapDirector

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

An altitude capture autopilot director.

Implements

• PlaneDirector

Constructors

Constructor

new APAltCapDirector(apValues, options?): APAltCapDirector

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

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?) => void

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

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

Returns

void

Implementation of

PlaneDirector.drivePitch

---

onActivate()?

optional onActivate: () => void

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

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:81

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:75

The current director state.

Implementation of

PlaneDirector.state

Methods

activate()

activate(vs?, alt?): void

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

Activates this director.

Parameters

Parameter	Type	Description
vs?	number	Optionally, the current vertical speed, in FPM.
alt?	number	Optionally, the current indicated altitude, in Feet.

Returns

void

Implementation of

PlaneDirector.activate

---

arm()

arm(): void

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

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:164

Deactivates this director.

Parameters

Parameter	Type	Default value	Description
captured	boolean	false	is whether the altitude was captured.

Returns

void

Implementation of

PlaneDirector.deactivate

---

update()

update(): void

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

Updates this director.

Returns

void

Implementation of

PlaneDirector.update