Class: APHdgDirector

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

An autopilot director that generates flight director bank commands to hold a magnetic heading. Optionally sets the AUTOPILOT HEADING LOCK SimVar state to true (1) when it is armed or activated, and to false (0) when it is deactivated.

The director requires valid bank and magnetic heading data to arm or activate.

Implements

• PlaneDirector

Constructors

Constructor

new APHdgDirector(bus, apValues, options?): APHdgDirector

Defined in: src/sdk/autopilot/directors/APHdgDirector.ts:88

Creates a new instance of APHdgDirector.

Parameters

Parameter	Type	Description
bus	EventBus	The event bus to use with this instance.
apValues	APValues	Autopilot values from this director's parent autopilot.
options?	Readonly<APHdgDirectorOptions>	Options to configure the new director.

Returns

APHdgDirector

Properties

driveBank()?

optional driveBank: (bank, rate?) => void

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

A function used to drive the autopilot commanded bank angle toward a desired value.

Parameters

Parameter	Type
bank	number
rate?	number

Returns

void

Implementation of

PlaneDirector.driveBank

---

onActivate()?

optional onActivate: () => void

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

A callback called when this director is activated.

Returns

void

Implementation of

PlaneDirector.onActivate

---

onArm()?

optional onArm: () => void

Defined in: src/sdk/autopilot/directors/APHdgDirector.ts:59

A callback called when this director is armed.

Returns

void

Implementation of

PlaneDirector.onArm

---

onDeactivate()?

optional onDeactivate: () => void

Defined in: src/sdk/autopilot/directors/APHdgDirector.ts:62

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/APHdgDirector.ts:53

The current director state.

Implementation of

PlaneDirector.state

Methods

activate()

activate(): void

Defined in: src/sdk/autopilot/directors/APHdgDirector.ts:145

Activates this director.

Returns

void

Implementation of

PlaneDirector.activate

---

arm()

arm(): void

Defined in: src/sdk/autopilot/directors/APHdgDirector.ts:164

Arms this director.

Returns

void

Implementation of

PlaneDirector.arm

---

deactivate()

deactivate(): void

Defined in: src/sdk/autopilot/directors/APHdgDirector.ts:171

Deactivates this director.

Returns

void

Implementation of

PlaneDirector.deactivate

---

update()

update(): void

Defined in: src/sdk/autopilot/directors/APHdgDirector.ts:191

Updates this director.

Returns

void

Implementation of

PlaneDirector.update