Skip to main content

Class: Epic2ApVorDirector

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

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.

Extends

Constructors

Constructor

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

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

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

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

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

Inherited from

APNavDirector.navCdi


protected readonly navFrequency: ConsumerValue<number>

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

Inherited from

APNavDirector.navFrequency


protected readonly navHasLoc: ConsumerValue<boolean>

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

Inherited from

APNavDirector.navHasLoc


protected readonly navHasNav: ConsumerValue<boolean>

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

Inherited from

APNavDirector.navHasNav


protected readonly navLla: ConsumerValue<null | LatLongAlt>

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

Inherited from

APNavDirector.navLla


protected readonly navLocCourse: ConsumerValue<number>

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

Inherited from

APNavDirector.navLocCourse


protected readonly navMagVar: ConsumerValue<number>

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

Inherited from

APNavDirector.navMagVar


protected readonly navObs: ConsumerValue<null | number>

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

Inherited from

APNavDirector.navObs


protected readonly navSignal: ConsumerValue<number>

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

Inherited from

APNavDirector.navSignal


protected navSource: Readonly<NavSourceId>

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

Inherited from

APNavDirector.navSource


onActivate()?

optional onActivate: () => void

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

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

Returns

void

Inherited from

APNavDirector.onActivate


onArm()?

optional onArm: () => void

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

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

Returns

void

Inherited from

APNavDirector.onArm


onDeactivate()?

optional onDeactivate: () => void

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

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

Returns

void

Inherited from

APNavDirector.onDeactivate


phase

protected phase: undefined | APNavDirectorPhase = undefined

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

Inherited from

APNavDirector.phase


phaseParameters

protected readonly phaseParameters: Record<APNavDirectorPhase, PhaseParameters>

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

Inherited from

APNavDirector.phaseParameters


radialErrorSimVar

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

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

Inherited from

APNavDirector.radialErrorSimVar


state

state: DirectorState

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

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

Arms this director.

Returns

void

Inherited from

APNavDirector.arm


deactivate()

deactivate(): void

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

Deactivates this director.

Returns

void

Inherited from

APNavDirector.deactivate


getNavDistance()

protected getNavDistance(): number

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

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

Inherited from

APNavDirector.initCdiSourceSubs


setNavLock()

setNavLock(newState): void

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

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

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

Updates this director's radio navigation data.

Returns

void

Inherited from

APNavDirector.updateNavData


defaultCanActivate()

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

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

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

Parameters

ParameterTypeDescription
modeAPLateralModesThe director's lateral mode.
apValuesAPValuesAutopilot values from the director's parent autopilot.
navDataReadonly<APNavDirectorNavData>The current radio navigation data received by the director.

Returns

boolean

Whether the director can be activated from an armed state.

Inherited from

APNavDirector.defaultCanActivate


defaultCanArm()

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

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

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

Parameters

ParameterTypeDescription
modeAPLateralModesThe director's lateral mode.
apValuesAPValuesAutopilot values from the director's parent autopilot.
navDataReadonly<APNavDirectorNavData>The current radio navigation data received by the director.

Returns

boolean

Whether the director can be armed.

Inherited from

APNavDirector.defaultCanArm