Skip to main content

Type Alias: APGSDirectorOptions

APGSDirectorOptions = object

Defined in: src/sdk/autopilot/directors/APGSDirector.ts:108

Options for APGSDirector.

Properties​

angleClosureRate?​

optional angleClosureRate: APGSDirectorAngleClosureRateFunc

Defined in: src/sdk/autopilot/directors/APGSDirector.ts:147

A function which returns the desired angle closure rate to track a glideslope. The angle closure rate is the rate of reduction of glideslope angle error. If not defined, the director will use a default angle closure rate curve. The output of this function will be overridden by the vsTarget function if the latter is defined.

canActivate()?​

optional canActivate: (apValues, navData) => boolean

Defined in: src/sdk/autopilot/directors/APGSDirector.ts:130

A function that checks whether the director can be activated from an armed state. If not defined, then default logic will be used.

Parameters​

ParameterTypeDescription
apValuesAPValuesAutopilot values from the director's parent autopilot.
navDataReadonly<APGSDirectorNavData>The current radio navigation data received by the director.

Returns​

boolean

Whether the director can be activated from an armed state.

canArm()?​

optional canArm: (apValues, navData) => boolean

Defined in: src/sdk/autopilot/directors/APGSDirector.ts:121

A function that checks whether the director can be armed. If not defined, then default logic will be used.

Parameters​

ParameterTypeDescription
apValuesAPValuesAutopilot values from the director's parent autopilot.
navDataReadonly<APGSDirectorNavData>The current radio navigation data received by the director.

Returns​

boolean

Whether the director can be armed.

canRemainActive()?​

optional canRemainActive: (apValues, navData, activateNavData) => boolean

Defined in: src/sdk/autopilot/directors/APGSDirector.ts:140

A function that checks whether the director can remain in the active state. If not defined, then default logic will be used.

Parameters​

ParameterTypeDescription
apValuesAPValuesAutopilot values from the director's parent autopilot.
navDataReadonly<APGSDirectorNavData>The current radio navigation data received by the director.
activateNavDataReadonly<APGSDirectorActivateNavData>The radio navigation data received by the director at the moment of activation.

Returns​

boolean

Whether the director can remain in the active state.

forceNavSource?​

optional forceNavSource: NavRadioIndex

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

The index of the nav radio to force the director to use. If not defined, the director will use the nav radio specified by the active autopilot navigation source.

maxVs?​

optional maxVs: number

Defined in: src/sdk/autopilot/directors/APGSDirector.ts:159

The maximum vertical speed the director can target, in feet per minute. Defaults to 0.

minVs?​

optional minVs: number

Defined in: src/sdk/autopilot/directors/APGSDirector.ts:156

The minimum vertical speed the director can target, in feet per minute. Defaults to -3000.

vsTarget?​

optional vsTarget: APGSDirectorVsTargetFunc

Defined in: src/sdk/autopilot/directors/APGSDirector.ts:153

A function which returns the desired vertical speed target to track a glideslope. If defined, the output of this function will override that of the angleClosureRate function.