Skip to main content

Class: APRollSteerDirector

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

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

The director requires valid bank data to arm or activate.

Implements​

Constructors​

Constructor​

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

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

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:116

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:107

A callback called when this director is activated.

Returns​

void

Implementation of​

PlaneDirector.onActivate


onArm()?​

optional onArm: () => void

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

A callback called when this director is armed.

Returns​

void

Implementation of​

PlaneDirector.onArm


onDeactivate()?​

optional onDeactivate: () => void

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

A callback that is called when this director is deactivated.

Returns​

void

Implementation of​

PlaneDirector.onDeactivate


state​

state: DirectorState

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

The current director state.

Implementation of​

PlaneDirector.state

Methods​

activate()​

activate(): void

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

Activates this director.

Returns​

void

Implementation of​

PlaneDirector.activate


arm()​

arm(): void

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

Arms this director.

Returns​

void

Implementation of​

PlaneDirector.arm


deactivate()​

deactivate(): void

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

Deactivates this director.

Returns​

void

Implementation of​

PlaneDirector.deactivate


update()​

update(): void

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

Updates this director.

Returns​

void

Implementation of​

PlaneDirector.update