Class: APNavDirector
Defined in: src/sdk/autopilot/directors/APNavDirector.ts:340
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.
Implements
Constructors
Constructor
new APNavDirector(
bus
,apValues
,mode
,options?
):APNavDirector
Defined in: src/sdk/autopilot/directors/APNavDirector.ts:419
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:353
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
navCdi
protected
readonly
navCdi:ConsumerValue
<null
|number
>
Defined in: src/sdk/autopilot/directors/APNavDirector.ts:367
navFrequency
protected
readonly
navFrequency:ConsumerValue
<number
>
Defined in: src/sdk/autopilot/directors/APNavDirector.ts:363
navHasLoc
protected
readonly
navHasLoc:ConsumerValue
<boolean
>
Defined in: src/sdk/autopilot/directors/APNavDirector.ts:368
navHasNav
protected
readonly
navHasNav:ConsumerValue
<boolean
>
Defined in: src/sdk/autopilot/directors/APNavDirector.ts:366
navLla
protected
readonly
navLla:ConsumerValue
<null
|LatLongAlt
>
Defined in: src/sdk/autopilot/directors/APNavDirector.ts:371
navLocCourse
protected
readonly
navLocCourse:ConsumerValue
<number
>
Defined in: src/sdk/autopilot/directors/APNavDirector.ts:369
navMagVar
protected
readonly
navMagVar:ConsumerValue
<number
>
Defined in: src/sdk/autopilot/directors/APNavDirector.ts:370
navObs
protected
readonly
navObs:ConsumerValue
<null
|number
>
Defined in: src/sdk/autopilot/directors/APNavDirector.ts:364
navSignal
protected
readonly
navSignal:ConsumerValue
<number
>
Defined in: src/sdk/autopilot/directors/APNavDirector.ts:365
navSource
protected
navSource:Readonly
<NavSourceId
>
Defined in: src/sdk/autopilot/directors/APNavDirector.ts:355
onActivate()?
optional
onActivate: () =>void
Defined in: src/sdk/autopilot/directors/APNavDirector.ts:344
A callback called when a mode signals it should be activated.
Returns
void
Implementation of
onArm()?
optional
onArm: () =>void
Defined in: src/sdk/autopilot/directors/APNavDirector.ts:347
A callback called when a mode signals it should be armed.
Returns
void
Implementation of
onDeactivate()?
optional
onDeactivate: () =>void
Defined in: src/sdk/autopilot/directors/APNavDirector.ts:350
A callback called when a mode signals it should be deactivated.
Returns
void
Implementation of
phase
protected
phase:undefined
|APNavDirectorPhase
=undefined
Defined in: src/sdk/autopilot/directors/APNavDirector.ts:402
phaseParameters
protected
readonly
phaseParameters:Record
<APNavDirectorPhase
,PhaseParameters
>
Defined in: src/sdk/autopilot/directors/APNavDirector.ts:407
radialErrorSimVar
protected
radialErrorSimVar:string
='NAV RADIAL ERROR:1'
Defined in: src/sdk/autopilot/directors/APNavDirector.ts:361
state
state:
DirectorState
Defined in: src/sdk/autopilot/directors/APNavDirector.ts:341
The current director state.
Implementation of
Methods
activate()
activate():
void
Defined in: src/sdk/autopilot/directors/APNavDirector.ts:605
Activates this director.
Returns
void
Implementation of
arm()
arm():
void
Defined in: src/sdk/autopilot/directors/APNavDirector.ts:620
Arms this director.
Returns
void
Implementation of
deactivate()
deactivate():
void
Defined in: src/sdk/autopilot/directors/APNavDirector.ts:636
Deactivates this director.
Returns
void
Implementation of
getNavDistance()
protected
getNavDistance():number
Defined in: src/sdk/autopilot/directors/APNavDirector.ts:729
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:532
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:646
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:683
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:653
Updates this director.
Returns
void
Implementation of
updateNavData()
protected
updateNavData():void
Defined in: src/sdk/autopilot/directors/APNavDirector.ts:588
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:863
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:838
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.