Class: APNavDirector

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

An autopilot director that provides lateral guidance by tracking a signal from a VOR or localizer radio navigation aid.

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

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

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<null | number>

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

---

navFrequency

protected readonly navFrequency: ConsumerValue<number>

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

---

navHasLoc

protected readonly navHasLoc: ConsumerValue<boolean>

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

---

navHasNav

protected readonly navHasNav: ConsumerValue<boolean>

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

---

navLla

protected readonly navLla: ConsumerValue<null | LatLongAlt>

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

---

navLocCourse

protected readonly navLocCourse: ConsumerValue<number>

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

---

navMagVar

protected readonly navMagVar: ConsumerValue<number>

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

---

navObs

protected readonly navObs: ConsumerValue<null | number>

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

---

navSignal

protected readonly navSignal: ConsumerValue<number>

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

---

navSource

protected navSource: Readonly<NavSourceId>

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

---

onActivate()?

optional onActivate: () => void

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

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/APNavDirector.ts:348

A callback called when a mode signals it should be armed.

Returns

void

Implementation of

PlaneDirector.onArm

---

onDeactivate()?

optional onDeactivate: () => void

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

A callback called when a mode signals it should be deactivated.

Returns

void

Implementation of

PlaneDirector.onDeactivate

---

phase

protected phase: undefined | APNavDirectorPhase = undefined

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

---

phaseParameters

protected readonly phaseParameters: Record<APNavDirectorPhase, PhaseParameters>

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

---

radialErrorSimVar

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

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

---

state

state: DirectorState

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

The current director state.

Implementation of

PlaneDirector.state

Methods

activate()

activate(): void

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

Activates this director.

Returns

void

Implementation of

PlaneDirector.activate

---

arm()

arm(): void

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

Arms this director.

Returns

void

Implementation of

PlaneDirector.arm

---

deactivate()

deactivate(): void

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

Deactivates this director.

Returns

void

Implementation of

PlaneDirector.deactivate

---

getNavDistance()

protected getNavDistance(): number

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

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

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

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

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

Updates this director.

Returns

void

Implementation of

PlaneDirector.update

---

updateNavData()

protected updateNavData(): void

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

Updates this director's radio navigation data.

Returns

void

---

defaultCanActivate()

protected static defaultCanActivate(mode, apValues, navData): boolean

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

A default function that checks whether the director can be activated from an armed state.

Parameters

Parameter	Type	Description
mode	APLateralModes	The director's lateral mode.
apValues	APValues	Autopilot values from the director's parent autopilot.
navData	Readonly<APNavDirectorNavData>	The current radio navigation data received by the director.

Returns

boolean

Whether the director can be activated from an armed state.

---

defaultCanArm()

protected static defaultCanArm(mode, apValues, navData): boolean

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

A default function that checks whether the director can be armed.

Parameters

Parameter	Type	Description
mode	APLateralModes	The director's lateral mode.
apValues	APValues	Autopilot values from the director's parent autopilot.
navData	Readonly<APNavDirectorNavData>	The current radio navigation data received by the director.

Returns

boolean

Whether the director can be armed.