Class: APHdgDirector
Defined in: src/sdk/autopilot/directors/APHdgDirector.ts:46
A heading autopilot director.
Implements
Constructors
Constructor
new APHdgDirector(
bus
,apValues
,options?
):APHdgDirector
Defined in: src/sdk/autopilot/directors/APHdgDirector.ts:76
Creates a new instance of APHdgDirector.
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 <APHdgDirectorOptions > | Options to configure the new director. |
Returns
APHdgDirector
Properties
driveBank()?
optional
driveBank: (bank
,rate?
) =>void
Defined in: src/sdk/autopilot/directors/APHdgDirector.ts:56
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
onActivate()?
optional
onActivate: () =>void
Defined in: src/sdk/autopilot/directors/APHdgDirector.ts:50
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/APHdgDirector.ts:53
A callback called when a mode signals it should be armed.
Returns
void
Implementation of
state
state:
DirectorState
Defined in: src/sdk/autopilot/directors/APHdgDirector.ts:47
The current director state.
Implementation of
Methods
activate()
activate():
void
Defined in: src/sdk/autopilot/directors/APHdgDirector.ts:142
Activates this director.
Returns
void
Implementation of
arm()
arm():
void
Defined in: src/sdk/autopilot/directors/APHdgDirector.ts:160
Arms this director. This director has no armed mode, so it activates immediately.
Returns
void
Implementation of
deactivate()
deactivate():
Promise
<void
>
Defined in: src/sdk/autopilot/directors/APHdgDirector.ts:169
Deactivates this director.
Returns
Promise
<void
>
Implementation of
update()
update():
void
Defined in: src/sdk/autopilot/directors/APHdgDirector.ts:180
Updates this director.
Returns
void