Class: APHdgHoldDirector
Defined in: src/sdk/autopilot/directors/APHdgHoldDirector.ts:30
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
Defined in: src/sdk/autopilot/directors/APHdgHoldDirector.ts:63
Creates an instance of the heading hold director.
Parameters
Parameter | 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
APHdgHoldDirector
Properties
driveBank()?
optional
driveBank: (bank
,rate?
) =>void
Defined in: src/sdk/autopilot/directors/APHdgHoldDirector.ts:43
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
drivePitch()?
optional
drivePitch: (pitch
,adjustForAoa?
,adjustForVerticalWind?
,rate?
) =>void
Defined in: src/sdk/autopilot/directors/APHdgHoldDirector.ts:113
A function used to drive the autopilot commanded pitch angle toward a desired value while optionally correcting for angle of attack and vertical wind.
Parameters
Parameter | Type | Description |
---|---|---|
pitch | number | The desired pitch angle, in degrees. Positive values indicate downward pitch. |
adjustForAoa? | boolean | 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 . |
adjustForVerticalWind? | boolean | 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 . |
rate? | number | The rate at which to drive the commanded pitch angle, in degrees per second. If not defined, a default rate will be used. |
Returns
void
Implementation of
onActivate()?
optional
onActivate: () =>void
Defined in: src/sdk/autopilot/directors/APHdgHoldDirector.ts:37
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/APHdgHoldDirector.ts:40
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/APHdgHoldDirector.ts:111
A callback called when a mode signals it should be deactivated.
Returns
void
Implementation of
setPitch()?
optional
setPitch: (pitch
) =>void
Defined in: src/sdk/autopilot/directors/APHdgHoldDirector.ts:112
A callback called to set an exact AP pitch target.
Parameters
Parameter | Type | Description |
---|---|---|
pitch | number | The pitch in degrees (positive = down, negative = up). |
Returns
void
Implementation of
state
state:
DirectorState
Defined in: src/sdk/autopilot/directors/APHdgHoldDirector.ts:34
The current director state.
Implementation of
Methods
activate()
activate():
void
Defined in: src/sdk/autopilot/directors/APHdgHoldDirector.ts:130
Activates this director.
Returns
void
Implementation of
arm()
arm():
void
Defined in: src/sdk/autopilot/directors/APHdgHoldDirector.ts:144
Arms this director. This director has no armed mode, so it activates immediately.
Returns
void
Implementation of
deactivate()
deactivate():
void
Defined in: src/sdk/autopilot/directors/APHdgHoldDirector.ts:153
Deactivates this director.
Returns
void
Implementation of
update()
update():
void
Defined in: src/sdk/autopilot/directors/APHdgHoldDirector.ts:163
Updates this director.
Returns
void