Class: APVSDirector

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

A vertical speed autopilot director.

Implements

• PlaneDirector

Constructors

Constructor

new APVSDirector(apValues, vsIncrement): APVSDirector

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

Creates an instance of the LateralDirector.

Parameters

Parameter	Type	Default value	Description
apValues	APValues	undefined	are the ap selected values for the autopilot.
vsIncrement	undefined | number	undefined	The number that vertical speed can be incremented by, in feet per minute. Upon activation, the actual vs will be rounded using this increment. If undefined, the value will not be rounded before passed to the sim. Defaults to undefined.

Returns

APVSDirector

Properties

apValues

protected readonly apValues: APValues

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

are the ap selected values for the autopilot.

---

drivePitch()?

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

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

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

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

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

The current director state.

Implementation of

PlaneDirector.state

---

vsIncrement

protected readonly vsIncrement: undefined | number = undefined

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

The number that vertical speed can be incremented by, in feet per minute. Upon activation, the actual vs will be rounded using this increment. If undefined, the value will not be rounded before passed to the sim. Defaults to undefined.

Methods

activate()

activate(): void

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

Activates this director.

Returns

void

Implementation of

PlaneDirector.activate

---

arm()

arm(): void

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

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

Returns

void

Implementation of

PlaneDirector.arm

---

deactivate()

deactivate(): void

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

Deactivates this director.

Returns

void

Implementation of

PlaneDirector.deactivate

---

getDesiredPitch()

protected getDesiredPitch(): number

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

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

Updates this director.

Returns

void

Implementation of

PlaneDirector.update