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
| 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
Epic2ApVorDirector
Inherited from
Properties
driveBank()?
optionaldriveBank: (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
| Parameter | Type |
|---|---|
bank | number |
rate? | number |
Returns
void
Inherited from
navCdi
protectedreadonlynavCdi:ConsumerValue<null|number>
Defined in: sdk/autopilot/directors/APNavDirector.ts:368
Inherited from
navFrequency
protectedreadonlynavFrequency:ConsumerValue<number>
Defined in: sdk/autopilot/directors/APNavDirector.ts:364
Inherited from
navHasLoc
protectedreadonlynavHasLoc:ConsumerValue<boolean>
Defined in: sdk/autopilot/directors/APNavDirector.ts:369
Inherited from
navHasNav
protectedreadonlynavHasNav:ConsumerValue<boolean>
Defined in: sdk/autopilot/directors/APNavDirector.ts:367
Inherited from
navLla
protectedreadonlynavLla:ConsumerValue<null|LatLongAlt>
Defined in: sdk/autopilot/directors/APNavDirector.ts:372
Inherited from
navLocCourse
protectedreadonlynavLocCourse:ConsumerValue<number>
Defined in: sdk/autopilot/directors/APNavDirector.ts:370
Inherited from
navMagVar
protectedreadonlynavMagVar:ConsumerValue<number>
Defined in: sdk/autopilot/directors/APNavDirector.ts:371
Inherited from
navObs
protectedreadonlynavObs:ConsumerValue<null|number>
Defined in: sdk/autopilot/directors/APNavDirector.ts:365
Inherited from
navSignal
protectedreadonlynavSignal:ConsumerValue<number>
Defined in: sdk/autopilot/directors/APNavDirector.ts:366
Inherited from
navSource
protectednavSource:Readonly<NavSourceId>
Defined in: sdk/autopilot/directors/APNavDirector.ts:356
Inherited from
onActivate()?
optionalonActivate: () =>void
Defined in: sdk/autopilot/directors/APNavDirector.ts:345
A callback called when a mode signals it should be activated.
Returns
void
Inherited from
onArm()?
optionalonArm: () =>void
Defined in: sdk/autopilot/directors/APNavDirector.ts:348
A callback called when a mode signals it should be armed.
Returns
void
Inherited from
onDeactivate()?
optionalonDeactivate: () =>void
Defined in: sdk/autopilot/directors/APNavDirector.ts:351
A callback called when a mode signals it should be deactivated.
Returns
void
Inherited from
phase
protectedphase:undefined|APNavDirectorPhase=undefined
Defined in: sdk/autopilot/directors/APNavDirector.ts:403
Inherited from
phaseParameters
protectedreadonlyphaseParameters:Record<APNavDirectorPhase,PhaseParameters>
Defined in: sdk/autopilot/directors/APNavDirector.ts:408
Inherited from
radialErrorSimVar
protectedradialErrorSimVar: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
Methods
activate()
activate():
void
Defined in: workingtitle-instruments-epic2/shared/Autopilot/directors/Epic2ApVorDirector.ts:8
Activates this director.
Returns
void
Overrides
arm()
arm():
void
Defined in: sdk/autopilot/directors/APNavDirector.ts:621
Arms this director.
Returns
void
Inherited from
deactivate()
deactivate():
void
Defined in: sdk/autopilot/directors/APNavDirector.ts:637
Deactivates this director.
Returns
void
Inherited from
getNavDistance()
protectedgetNavDistance():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
initCdiSourceSubs()
protectedinitCdiSourceSubs():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
| Parameter | Type | Description |
|---|---|---|
newState | boolean | The new state of the NAV1 lock. |
Returns
void
Inherited from
trackSignal()
protectedtrackSignal(distanceToSource,isInZoneOfConfusion):void
Defined in: 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
Inherited from
update()
update():
void
Defined in: workingtitle-instruments-epic2/shared/Autopilot/directors/Epic2ApVorDirector.ts:14
Updates this director.
Returns
void
Overrides
updateNavData()
protectedupdateNavData():void
Defined in: sdk/autopilot/directors/APNavDirector.ts:589
Updates this director's radio navigation data.
Returns
void
Inherited from
defaultCanActivate()
protectedstaticdefaultCanActivate(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
| 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.
Inherited from
APNavDirector.defaultCanActivate
defaultCanArm()
protectedstaticdefaultCanArm(mode,apValues,navData):boolean
Defined in: 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.