Skip to main content

Class: Epic2ApVorDirector

Defined in: workingtitle-instruments-epic2/shared/Autopilot/directors/Epic2ApVorDirector.ts:4

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.

Extends

Constructors

Constructor

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

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

Creates a new instance of APNavDirector.

Parameters

ParameterTypeDescription
busEventBusThe event bus to use with this instance.
apValuesAPValuesAutopilot values from this director's parent autopilot.
modeAPLateralModesThe APLateralMode for this instance of the director.
options?Readonly<APNavDirectorOptions>Options with which to configure the director.

Returns

Epic2ApVorDirector

Inherited from

APNavDirector.constructor

Properties

driveBank()?

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

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

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

Parameters

ParameterType
banknumber
rate?number

Returns

void

Inherited from

APNavDirector.driveBank


protected readonly navCdi: ConsumerValue<number | null>

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

Inherited from

APNavDirector.navCdi


protected readonly navFrequency: ConsumerValue<number>

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

Inherited from

APNavDirector.navFrequency


protected readonly navHasLoc: ConsumerValue<boolean>

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

Inherited from

APNavDirector.navHasLoc


protected readonly navHasNav: ConsumerValue<boolean>

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

Inherited from

APNavDirector.navHasNav


protected readonly navLla: ConsumerValue<LatLongAlt | null>

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

Inherited from

APNavDirector.navLla


protected readonly navLocCourse: ConsumerValue<number>

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

Inherited from

APNavDirector.navLocCourse


protected readonly navMagVar: ConsumerValue<number>

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

Inherited from

APNavDirector.navMagVar


protected readonly navObs: ConsumerValue<number | null>

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

Inherited from

APNavDirector.navObs


protected readonly navSignal: ConsumerValue<number>

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

Inherited from

APNavDirector.navSignal


protected navSource: Readonly<NavSourceId>

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

Inherited from

APNavDirector.navSource


onActivate()?

optional onActivate: () => void

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

A callback called when this director is activated.

Returns

void

Inherited from

APNavDirector.onActivate


onArm()?

optional onArm: () => void

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

A callback called when this director is armed.

Returns

void

Inherited from

APNavDirector.onArm


onDeactivate()?

optional onDeactivate: () => void

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

A callback that is called when this director is deactivated.

Returns

void

Inherited from

APNavDirector.onDeactivate


phase

protected phase: APNavDirectorPhase | undefined = undefined

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

Inherited from

APNavDirector.phase


phaseParameters

protected readonly phaseParameters: Record<APNavDirectorPhase, PhaseParameters>

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

Inherited from

APNavDirector.phaseParameters


radialErrorSimVar

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

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

Inherited from

APNavDirector.radialErrorSimVar


state

state: DirectorState

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

The current director state.

Inherited from

APNavDirector.state

Methods

activate()

activate(): void

Defined in: workingtitle-instruments-epic2/shared/Autopilot/directors/Epic2ApVorDirector.ts:8

Activates this director.

Returns

void

Overrides

APNavDirector.activate


arm()

arm(): void

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

Arms this director.

Returns

void

Inherited from

APNavDirector.arm


deactivate()

deactivate(): void

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

Deactivates this director.

Returns

void

Inherited from

APNavDirector.deactivate


getNavDistance()

protected getNavDistance(): number

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

Gets the lateral distance from PPOS to the nav signal.

Returns

number

The distance value in nautical miles.

Inherited from

APNavDirector.getNavDistance


initCdiSourceSubs()

protected initCdiSourceSubs(): void

Defined in: 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

Inherited from

APNavDirector.initCdiSourceSubs


setNavLock()

setNavLock(newState): void

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

Sets the NAV1 Lock state.

Parameters

ParameterTypeDescription
newStatebooleanThe new state of the NAV1 lock.

Returns

void

Inherited from

APNavDirector.setNavLock


trackSignal()

protected trackSignal(distanceToSource, isInZoneOfConfusion): void

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

Tracks the active navigation signal received by this director.

Parameters

ParameterTypeDescription
distanceToSourcenumberThe distance to the source of the active navigation signal, in nautical miles.
isInZoneOfConfusionbooleanWhether 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

Inherited from

APNavDirector.trackSignal


update()

update(): void

Defined in: workingtitle-instruments-epic2/shared/Autopilot/directors/Epic2ApVorDirector.ts:14

Updates this director.

Returns

void

Overrides

APNavDirector.update


updateNavData()

protected updateNavData(): void

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

Updates this director's radio navigation data.

Returns

void

Inherited from

APNavDirector.updateNavData