Class: APBackCourseDirector
A BackCourse autopilot director.
Implements
Constructors
constructor
• new APBackCourseDirector(bus, apValues, options?): APBackCourseDirector
Creates a new instance of APBackCourseDirector.
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? | Partial<Readonly<APBackCourseDirectorOptions>> | Options to configure the new director. |
Returns
Defined in
src/sdk/autopilot/directors/APBackCourseDirector.ts:274
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/APBackCourseDirector.ts:245
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/APBackCourseDirector.ts:236
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/APBackCourseDirector.ts:239
onDeactivate
• Optional onDeactivate: () => void
A callback called when a mode signals it should be deactivated.
Type declaration
▸ (): void
Returns
void
Inherit Doc
Implementation of
Defined in
src/sdk/autopilot/directors/APBackCourseDirector.ts:242
state
• state: DirectorState
The current director state.
Implementation of
Defined in
src/sdk/autopilot/directors/APBackCourseDirector.ts:233
Methods
activate
▸ activate(): void
Activates this director.
Returns
void
Implementation of
Defined in
src/sdk/autopilot/directors/APBackCourseDirector.ts:401
arm
▸ arm(): void
Arms this director.
Returns
void
Implementation of
Defined in
src/sdk/autopilot/directors/APBackCourseDirector.ts:415
deactivate
▸ deactivate(): void
Deactivates this director.
Returns
void
Implementation of
Defined in
src/sdk/autopilot/directors/APBackCourseDirector.ts:431
update
▸ update(): void
Updates this director.
Returns
void
Implementation of
Defined in
src/sdk/autopilot/directors/APBackCourseDirector.ts:443