Skip to main content

Type Alias: APGPDirectorOptions

APGPDirectorOptions = object

Defined in: src/sdk/autopilot/directors/APGPDirector.ts:33

Options for APGPDirector.

Properties

canArm()?

optional canArm: (isGuidanceValid, fpa, deviation) => boolean

Defined in: src/sdk/autopilot/directors/APGPDirector.ts:54

A function that checks whether the director can be armed. If not defined, then the director can always be armed.

Parameters

ParameterTypeDescription
isGuidanceValidbooleanWhether valid glidepath guidance is available.
fpanumberThe flight path angle of the glidepath, in degrees. Positive angles indicate a downward-sloping path.
deviationnumberThe deviation of the glidepath from the airplane, in feet. Positive values indicate the path lies above the airplane.

Returns

boolean

Whether the director can be armed.


canCapture()?

optional canCapture: (fpa, deviation) => boolean

Defined in: src/sdk/autopilot/directors/APGPDirector.ts:65

A function that checks whether the director can capture a glidepath from an armed state. If not defined, then the director will capture if the autopilot's active lateral mode is APLateralModes.GPSS, the glidepath's flight path angle is greater than zero, and deviation is between 100 and -15 feet.

Parameters

ParameterTypeDescription
fpanumberThe flight path angle of the glidepath, in degrees. Positive angles indicate a downward-sloping path.
deviationnumberThe deviation of the glidepath from the airplane, in feet. Positive values indicate the path lies above the airplane.

Returns

boolean

Whether the director can capture a glidepath from an armed state.


canTrack()?

optional canTrack: (fpa, deviation) => boolean

Defined in: src/sdk/autopilot/directors/APGPDirector.ts:75

A function that checks whether the director can continue tracking a glidepath. If not defined, then the director will continue tracking as long as the autopilot's active lateral mode is APLateralModes.GPSS.

Parameters

ParameterTypeDescription
fpanumberThe flight path angle of the glidepath, in degrees. Positive angles indicate a downward-sloping path.
deviationnumberThe deviation of the glidepath from the airplane, in feet. Positive values indicate the path lies above the airplane.

Returns

boolean

Whether the director can continue tracking a glidepath.


guidance?

optional guidance: Accessible<Readonly<APGPDirectorGuidance>>

Defined in: src/sdk/autopilot/directors/APGPDirector.ts:38

The guidance for the director to use. If not defined, then the director will source guidance data from VNAV SimVars at the index defined by vnavIndex.


vnavIndex?

optional vnavIndex: number | Subscribable<number>

Defined in: src/sdk/autopilot/directors/APGPDirector.ts:44

The index of the VNAV from which the director should source guidance data from SimVars. Ignored if guidance is defined. Defaults to 0.