Class: APHdgHoldDirector
An autopilot heading hold director. Levels the wings upon activation, and then holds the captured heading
Implements
Constructors
constructor
• new APHdgHoldDirector(bus, apValues, options?): APHdgHoldDirector
Creates an instance of the heading hold director.
Parameters
| Name | Type | Description |
|---|---|---|
bus | EventBus | The event bus to use with this instance. |
apValues | APValues | Autopilot values from this director's parent autopilot. |
options? | Readonly<APHdgHoldDirectorOptions> | Options to configure the new director. |
Returns
Defined in
src/sdk/autopilot/directors/APHdgHoldDirector.ts:63
Properties
driveBank
• Optional driveBank: (bank: number, rate?: number) => void
A function used to drive the autopilot commanded bank angle toward a desired value.
Param
The desired bank angle, in degrees. Positive values indicate left bank.
Param
The rate at which to drive the commanded bank angle, in degrees per second. If not defined, a default rate will be used.
Type declaration
▸ (bank, rate?): void
Parameters
| Name | Type |
|---|---|
bank | number |
rate? | number |
Returns
void
Inherit Doc
Implementation of
Defined in
src/sdk/autopilot/directors/APHdgHoldDirector.ts:43
drivePitch
• Optional drivePitch: (pitch: number, adjustForAoa?: boolean, adjustForVerticalWind?: boolean, rate?: number) => 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?, rate?): void
Parameters
| Name | Type |
|---|---|
pitch | number |
adjustForAoa? | boolean |
adjustForVerticalWind? | boolean |
rate? | number |
Returns
void
Implementation of
Defined in
src/sdk/autopilot/directors/APHdgHoldDirector.ts:113
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/APHdgHoldDirector.ts:37
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/APHdgHoldDirector.ts:40
onDeactivate
• Optional onDeactivate: () => void
A callback called when a mode signals it should be deactivated.
Type declaration
▸ (): void
Returns
void
Implementation of
Defined in
src/sdk/autopilot/directors/APHdgHoldDirector.ts:111
setPitch
• Optional setPitch: (pitch: number) => void
A callback called to set an exact AP pitch target.
Param
The pitch in degrees (positive = down, negative = up).
Type declaration
▸ (pitch): void
Parameters
| Name | Type |
|---|---|
pitch | number |
Returns
void
Implementation of
Defined in
src/sdk/autopilot/directors/APHdgHoldDirector.ts:112
state
• state: DirectorState
The current director state.
Implementation of
Defined in
src/sdk/autopilot/directors/APHdgHoldDirector.ts:34
Methods
activate
▸ activate(): void
Activates this director.
Returns
void
Implementation of
Defined in
src/sdk/autopilot/directors/APHdgHoldDirector.ts:130
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/APHdgHoldDirector.ts:144
deactivate
▸ deactivate(): void
Deactivates this director.
Returns
void
Implementation of
Defined in
src/sdk/autopilot/directors/APHdgHoldDirector.ts:153
update
▸ update(): void
Updates this director.
Returns
void
Implementation of
Defined in
src/sdk/autopilot/directors/APHdgHoldDirector.ts:163