Skip to main content

Class: APRollSteerDirector

Defined in: src/sdk/autopilot/directors/APRollSteerDirector.ts:100

An autopilot roll-steering director. This director uses roll-steering commands to drive flight director bank commands.

Implements

Constructors

Constructor

new APRollSteerDirector(apValues, steerCommand, options?): APRollSteerDirector

Defined in: src/sdk/autopilot/directors/APRollSteerDirector.ts:137

Creates a new instance of APRollSteerDirector.

Parameters

ParameterTypeDescription
apValuesAPValuesAutopilot values from this director's parent autopilot.
steerCommandAccessible<Readonly<APRollSteerDirectorSteerCommand>>The steering command used by this director.
options?Readonly<APRollSteerDirectorOptions>Options to configure the new director.

Returns

APRollSteerDirector

Properties

driveBank()?

optional driveBank: (bank, rate?) => void

Defined in: src/sdk/autopilot/directors/APRollSteerDirector.ts:113

A function used to drive the autopilot commanded bank angle toward a desired value.

Parameters

ParameterType
banknumber
rate?number

Returns

void

Implementation of

PlaneDirector.driveBank


onActivate()?

optional onActivate: () => void

Defined in: src/sdk/autopilot/directors/APRollSteerDirector.ts:104

A callback called when a mode signals it should be activated.

Returns

void

Implementation of

PlaneDirector.onActivate


onArm()?

optional onArm: () => void

Defined in: src/sdk/autopilot/directors/APRollSteerDirector.ts:107

A callback called when a mode signals it should be armed.

Returns

void

Implementation of

PlaneDirector.onArm


onDeactivate()?

optional onDeactivate: () => void

Defined in: src/sdk/autopilot/directors/APRollSteerDirector.ts:110

A callback called when a mode signals it should be deactivated.

Returns

void

Implementation of

PlaneDirector.onDeactivate


state

state: DirectorState

Defined in: src/sdk/autopilot/directors/APRollSteerDirector.ts:101

The current director state.

Implementation of

PlaneDirector.state

Methods

activate()

activate(): void

Defined in: src/sdk/autopilot/directors/APRollSteerDirector.ts:192

Activates the guidance mode.

Returns

void

Implementation of

PlaneDirector.activate


arm()

arm(): void

Defined in: src/sdk/autopilot/directors/APRollSteerDirector.ts:200

Arms the guidance mode.

Returns

void

Implementation of

PlaneDirector.arm


deactivate()

deactivate(): void

Defined in: src/sdk/autopilot/directors/APRollSteerDirector.ts:212

Deactivates the guidance mode.

Returns

void

Implementation of

PlaneDirector.deactivate


update()

update(): void

Defined in: src/sdk/autopilot/directors/APRollSteerDirector.ts:220

Updates the guidance mode control loops.

Returns

void

Implementation of

PlaneDirector.update