Class: APVNavPathDirector
A VNAV Path autopilot director.
Implements
Constructors
constructor
• new APVNavPathDirector(bus, options?): APVNavPathDirector
Creates a new instance of APVNavPathDirector.
Parameters
| Name | Type | Description |
|---|---|---|
bus | EventBus | The event bus. |
options? | Readonly<APVNavPathDirectorOptions> | Options with which to configure the director. |
Returns
Defined in
src/sdk/autopilot/directors/APVNavPathDirector.ts:86
Properties
deviationSimVar
• Protected deviationSimVar: string = VNavVars.VerticalDeviation
Defined in
src/sdk/autopilot/directors/APVNavPathDirector.ts:74
drivePitch
• Optional drivePitch: (pitch: number, adjustForAoa?: boolean, adjustForVerticalWind?: boolean) => void
A function used to drive the autopilot commanded pitch angle toward a desired value while optionally correcting for angle of attack and vertical wind.
Param
The desired pitch angle, in degrees. Positive values indicate downward pitch.
Param
Whether to adjust the commanded pitch angle for angle of attack. If true, the provided pitch
angle is treated as a desired flight path angle and a new commanded pitch angle will be calculated to produce the
desired FPA given the airplane's current angle of attack. This correction can be used in conjunction with the
vertical wind correction. Defaults to false.
Param
Whether to adjust the commanded pitch angle for vertical wind velocity. If true,
the provided pitch angle is treated as a desired flight path angle and a new commanded pitch angle will be
calculated to produce the desired FPA given the current vertical wind component. This correction can be used in
conjunction with the angle of attack correction. Defaults to false.
Param
The rate at which to drive the commanded pitch angle, in degrees per second. If not defined, a default rate will be used.
Type declaration
▸ (pitch, adjustForAoa?, adjustForVerticalWind?): void
Parameters
| Name | Type |
|---|---|
pitch | number |
adjustForAoa? | boolean |
adjustForVerticalWind? | boolean |
Returns
void
Inherit Doc
Implementation of
Defined in
src/sdk/autopilot/directors/APVNavPathDirector.ts:66
fpaSimVar
• Protected fpaSimVar: string = VNavVars.FPA
Defined in
src/sdk/autopilot/directors/APVNavPathDirector.ts:75
getDeviationFunc
• Protected Readonly getDeviationFunc: () => number
Type declaration
▸ (): number
Returns
number
Defined in
src/sdk/autopilot/directors/APVNavPathDirector.ts:79
getFpaFunc
• Protected Readonly getFpaFunc: () => number
Type declaration
▸ (): number
Returns
number
Defined in
src/sdk/autopilot/directors/APVNavPathDirector.ts:78
guidance
• Protected Optional Readonly guidance: Accessible<Readonly<APVNavPathDirectorGuidance>>
Defined in
src/sdk/autopilot/directors/APVNavPathDirector.ts:70
isGuidanceValidFunc
• Protected Readonly isGuidanceValidFunc: () => boolean
Type declaration
▸ (): boolean
Returns
boolean
Defined in
src/sdk/autopilot/directors/APVNavPathDirector.ts:77
onActivate
• Optional onActivate: () => void
A callback called when a mode signals it should be activated.
Type declaration
▸ (): void
Returns
void
Inherit Doc
Implementation of
Defined in
src/sdk/autopilot/directors/APVNavPathDirector.ts:57
onArm
• Optional onArm: () => void
A callback called when a mode signals it should be armed.
Type declaration
▸ (): void
Returns
void
Inherit Doc
Implementation of
Defined in
src/sdk/autopilot/directors/APVNavPathDirector.ts:60
onDeactivate
• Optional onDeactivate: () => void
A callback called when a mode signals it should be deactivated.
Type declaration
▸ (): void
Returns
void
Inherit Doc
Implementation of
Defined in
src/sdk/autopilot/directors/APVNavPathDirector.ts:63
state
• state: DirectorState
The current director state.
Implementation of
Defined in
src/sdk/autopilot/directors/APVNavPathDirector.ts:54
verticalWindAverage
• Protected verticalWindAverage: SimpleMovingAverage
Defined in
src/sdk/autopilot/directors/APVNavPathDirector.ts:68
vnavIndex
• Protected Optional Readonly vnavIndex: Subscribable<number>
Defined in
src/sdk/autopilot/directors/APVNavPathDirector.ts:72
Methods
activate
▸ activate(): void
Activates the guidance mode.
Returns
void
Implementation of
Defined in
src/sdk/autopilot/directors/APVNavPathDirector.ts:115
arm
▸ arm(): void
Arms the guidance mode.
Returns
void
Implementation of
Defined in
src/sdk/autopilot/directors/APVNavPathDirector.ts:124
deactivate
▸ deactivate(): void
Deactivates the guidance mode.
Returns
void
Implementation of
Defined in
src/sdk/autopilot/directors/APVNavPathDirector.ts:134
getDesiredPitch
▸ getDesiredPitch(): number
Gets a desired pitch from the FPA, AOA and Deviation.
Returns
number
The desired pitch angle.
Defined in
src/sdk/autopilot/directors/APVNavPathDirector.ts:155
update
▸ update(): void
Updates the guidance mode control loops.
Returns
void
Implementation of
Defined in
src/sdk/autopilot/directors/APVNavPathDirector.ts:140