Class: APVSDirector

Defined in: src/sdk/autopilot/directors/APVSDirector.ts:36

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

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

Implements

• PlaneDirector

Constructors

Constructor

new APVSDirector(apValues, options?): APVSDirector

Defined in: src/sdk/autopilot/directors/APVSDirector.ts:67

Creates a new instance of APVSDirector.

Parameters

Parameter	Type	Description
apValues	APValues	Autopilot values from this director's parent autopilot.
options?	Readonly<APVSDirectorOptions>	Options with which to configure the director.

Returns

APVSDirector

Constructor

new APVSDirector(apValues, vsIncrement): APVSDirector

Defined in: src/sdk/autopilot/directors/APVSDirector.ts:75

Creates a new instance of APVSDirector.

Parameters

Parameter	Type	Description
apValues	APValues	Autopilot values from this director's parent autopilot.
vsIncrement	number | undefined	The increment, in feet per minute, to use to round the target vertical speed set by the director on activation. If not defined, then the target vertical speed will not be rounded.

Returns

APVSDirector

Deprecated

Please use the constructor that takes an options object instead.

Properties

apValues

protected readonly apValues: APValues

Defined in: src/sdk/autopilot/directors/APVSDirector.ts:77

---

drivePitch()?

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

Defined in: src/sdk/autopilot/directors/APVSDirector.ts:51

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/APVSDirector.ts:42

A callback called when this director is activated.

Returns

void

Implementation of

PlaneDirector.onActivate

---

onArm()?

optional onArm: () => void

Defined in: src/sdk/autopilot/directors/APVSDirector.ts:45

A callback called when this director is armed.

Returns

void

Implementation of

PlaneDirector.onArm

---

onDeactivate()?

optional onDeactivate: () => void

Defined in: src/sdk/autopilot/directors/APVSDirector.ts:48

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/APVSDirector.ts:39

The current director state.

Implementation of

PlaneDirector.state

---

vsIncrement

protected readonly vsIncrement: number | undefined

Defined in: src/sdk/autopilot/directors/APVSDirector.ts:56

Methods

activate()

activate(): void

Defined in: src/sdk/autopilot/directors/APVSDirector.ts:118

Activates this director.

Returns

void

Implementation of

PlaneDirector.activate

---

arm()

arm(): void

Defined in: src/sdk/autopilot/directors/APVSDirector.ts:140

Arms this director. If the director is not already active, then this will immediately attempt to activate the director.

Returns

void

Implementation of

PlaneDirector.arm

---

deactivate()

deactivate(): void

Defined in: src/sdk/autopilot/directors/APVSDirector.ts:147

Deactivates this director.

Returns

void

Implementation of

PlaneDirector.deactivate

---

getDesiredPitch()

protected getDesiredPitch(): number

Defined in: src/sdk/autopilot/directors/APVSDirector.ts:178

Gets a desired pitch from the selected vs value.

Returns

number

The desired pitch angle.

---

update()

update(): void

Defined in: src/sdk/autopilot/directors/APVSDirector.ts:162

Updates this director.

Returns

void

Implementation of

PlaneDirector.update