Class: APAltCapDirector
An altitude capture autopilot director.
Implements
Constructors
constructor
• new APAltCapDirector(apValues, options?): APAltCapDirector
Creates an instance of the APAltCapDirector.
Parameters
| Name | Type | Description |
|---|---|---|
apValues | APValues | Autopilot data for this director. |
options? | Partial<Readonly<APAltCapDirectorOptions>> | Optional options object with these: --> shouldActivate: An optional function which returns true if the capturing shall be activated. If not defined, a default function is used. --> captureAltitude: An optional function which calculates desired pitch angles to capture a target altitude. If not defined, a default function is used. |
Returns
Defined in
src/sdk/autopilot/directors/APAltCapDirector.ts:85
Properties
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/APAltCapDirector.ts:70
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/APAltCapDirector.ts:64
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/APAltCapDirector.ts:67
state
• state: DirectorState
The current director state.
Implementation of
Defined in
src/sdk/autopilot/directors/APAltCapDirector.ts:61
Methods
activate
▸ activate(vs?, alt?): void
Activates this director.
Parameters
| Name | Type | Description |
|---|---|---|
vs? | number | Optionally, the current vertical speed, in FPM. |
alt? | number | Optionally, the current indicated altitude, in Feet. |
Returns
void
Implementation of
Defined in
src/sdk/autopilot/directors/APAltCapDirector.ts:104
arm
▸ arm(): void
Arms this director. This director has no armed mode, so it activates immediately.
Returns
void
Implementation of
Defined in
src/sdk/autopilot/directors/APAltCapDirector.ts:120
deactivate
▸ deactivate(captured?): void
Deactivates this director.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
captured | boolean | false | is whether the altitude was captured. |
Returns
void
Implementation of
Defined in
src/sdk/autopilot/directors/APAltCapDirector.ts:131
update
▸ update(): void
Updates this director.
Returns
void
Implementation of
Defined in
src/sdk/autopilot/directors/APAltCapDirector.ts:141