Class: APVSDirector

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

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, vsIncrement): APVSDirector

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

Creates a new instance of APVSDirector.

Parameters

Parameter	Type	Default value	Description
apValues	APValues	undefined	are the ap selected values for the autopilot.
vsIncrement	number | undefined	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:39

are the ap selected values for the autopilot.

---

drivePitch()?

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

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

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 this director is activated.

Returns

void

Implementation of

PlaneDirector.onActivate

---

onArm()?

optional onArm: () => void

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

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

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

The current director state.

Implementation of

PlaneDirector.state

---

vsIncrement

protected readonly vsIncrement: number | undefined = undefined

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

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

Activates this director.

Returns

void

Implementation of

PlaneDirector.activate

---

arm()

arm(): void

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

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

Deactivates this director.

Returns

void

Implementation of

PlaneDirector.deactivate

---

getDesiredPitch()

protected getDesiredPitch(): number

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

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

Updates this director.

Returns

void

Implementation of

PlaneDirector.update