Class: APNavDirector

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:342

An autopilot director that generates flight director bank commands to tracking a signal from a VOR or localizer radio navigation aid.

The director requires valid bank data to arm or activate.

Requires that the navigation radio topics defined in NavComEvents be published to the event bus in order to function properly.

Extended by

• Epic2ApVorDirector

Implements

• PlaneDirector

Constructors

Constructor

new APNavDirector(bus, apValues, mode, options?): APNavDirector

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:428

Creates a new instance of APNavDirector.

Parameters

Parameter	Type	Description
bus	EventBus	The event bus to use with this instance.
apValues	APValues	Autopilot values from this director's parent autopilot.
mode	APLateralModes	The APLateralMode for this instance of the director.
options?	Readonly<APNavDirectorOptions>	Options with which to configure the director.

Returns

APNavDirector

Properties

driveBank()?

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

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:356

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

---

navCdi

protected readonly navCdi: ConsumerValue<number | null>

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:370

---

navFrequency

protected readonly navFrequency: ConsumerValue<number>

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:366

---

navHasLoc

protected readonly navHasLoc: ConsumerValue<boolean>

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:371

---

navHasNav

protected readonly navHasNav: ConsumerValue<boolean>

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:369

---

navLla

protected readonly navLla: ConsumerValue<LatLongAlt | null>

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:374

---

navLocCourse

protected readonly navLocCourse: ConsumerValue<number>

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:372

---

navMagVar

protected readonly navMagVar: ConsumerValue<number>

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:373

---

navObs

protected readonly navObs: ConsumerValue<number | null>

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:367

---

navSignal

protected readonly navSignal: ConsumerValue<number>

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:368

---

navSource

protected navSource: Readonly<NavSourceId>

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:358

---

onActivate()?

optional onActivate: () => void

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:347

A callback called when this director is activated.

Returns

void

Implementation of

PlaneDirector.onActivate

---

onArm()?

optional onArm: () => void

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:350

A callback called when this director is armed.

Returns

void

Implementation of

PlaneDirector.onArm

---

onDeactivate()?

optional onDeactivate: () => void

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:353

A callback that is called when this director is deactivated.

Returns

void

Implementation of

PlaneDirector.onDeactivate

---

phase

protected phase: APNavDirectorPhase | undefined = undefined

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:405

---

phaseParameters

protected readonly phaseParameters: Record<APNavDirectorPhase, PhaseParameters>

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:410

---

radialErrorSimVar

protected radialErrorSimVar: string = 'NAV RADIAL ERROR:1'

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:364

---

state

state: DirectorState

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:344

The current director state.

Implementation of

PlaneDirector.state

Methods

activate()

activate(): void

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:620

Activates this director.

Returns

void

Implementation of

PlaneDirector.activate

---

arm()

arm(): void

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:639

Arms this director.

Returns

void

Implementation of

PlaneDirector.arm

---

deactivate()

deactivate(): void

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:657

Deactivates this director.

Returns

void

Implementation of

PlaneDirector.deactivate

---

getNavDistance()

protected getNavDistance(): number

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:766

Gets the lateral distance from PPOS to the nav signal.

Returns

number

The distance value in nautical miles.

---

initCdiSourceSubs()

protected initCdiSourceSubs(): void

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:541

Initializes this director's subscription to the autopilot's CDI source. If this director is forced to use a specific CDI source, then the autopilot's CDI source will be ignored.

Returns

void

---

setNavLock()

setNavLock(newState): void

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:676

Sets the NAV1 Lock state.

Parameters

Parameter	Type	Description
newState	boolean	The new state of the NAV1 lock.

Returns

void

---

trackSignal()

protected trackSignal(distanceToSource, isInZoneOfConfusion): void

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:720

Tracks the active navigation signal received by this director.

Parameters

Parameter	Type	Description
distanceToSource	number	The distance to the source of the active navigation signal, in nautical miles.
isInZoneOfConfusion	boolean	Whether the source of the active navigation signal is a VOR and the airplane's position is close enough to the VOR to render lateral deviation values unreliable.

Returns

void

---

update()

update(): void

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:681

Updates this director.

Returns

void

Implementation of

PlaneDirector.update

---

updateNavData()

protected updateNavData(): void

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:605

Updates this director's radio navigation data.

Returns

void