Class: APHdgDirector
A heading autopilot director.
Implements
Constructors
constructor
• new APHdgDirector(bus, apValues, options?): APHdgDirector
Creates a new instance of APHdgDirector.
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<APHdgDirectorOptions> | Options to configure the new director. |
Returns
Defined in
src/sdk/autopilot/directors/APHdgDirector.ts:76
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/APHdgDirector.ts:56
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/APHdgDirector.ts:50
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/APHdgDirector.ts:53
state
• state: DirectorState
The current director state.
Implementation of
Defined in
src/sdk/autopilot/directors/APHdgDirector.ts:47
Methods
activate
▸ activate(): void
Activates this director.
Returns
void
Implementation of
Defined in
src/sdk/autopilot/directors/APHdgDirector.ts:142
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/APHdgDirector.ts:160
deactivate
▸ deactivate(): Promise<void>
Deactivates this director.
Returns
Promise<void>
Implementation of
Defined in
src/sdk/autopilot/directors/APHdgDirector.ts:169
update
▸ update(): void
Updates this director.
Returns
void
Implementation of
Defined in
src/sdk/autopilot/directors/APHdgDirector.ts:180