Skip to main content

Type Alias: APNavDirectorOptions

APNavDirectorOptions = object

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:176

Options for APNavDirector.

Properties​

bankRate?​

optional bankRate: number | () => number

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:202

The bank rate to enforce when the director commands changes in bank angle, in degrees per second, or a function which returns it. If not defined, a default bank rate will be used. Defaults to undefined.

bankRateIntercept?​

optional bankRateIntercept: number | () => number

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:209

The bank rate to enforce when the director commands changes in bank angle during intercept phase, in degrees per second, or a function which returns it. If not defined, the bank rate defined by bankRate will be used. Defaults to undefined.

bankRateTracking?​

optional bankRateTracking: number | () => number

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:216

The bank rate to enforce when the director commands changes in bank angle during tracking phase, in degrees per second, or a function which returns it. If not defined, the bank rate defined by bankRate will be used. Defaults to undefined.

canActivate()?​

optional canActivate: (mode, apValues, navData) => boolean

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:235

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
modeAPLateralModesThe director's lateral mode.
apValuesAPValuesAutopilot values from the director's parent autopilot.
navDataReadonly<APNavDirectorNavData>The current radio navigation data received by the director.

Returns​

boolean

Whether the director can be activated from an armed state.

canArm()?​

optional canArm: (mode, apValues, navData) => boolean

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:225

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

Parameters​

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

Returns​

boolean

Whether the director can be armed.

canRemainActive()?​

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

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:248

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

Parameters​

ParameterTypeDescription
modeAPLateralModesThe director's lateral mode.
apValuesAPValuesAutopilot values from the director's parent autopilot.
navDataReadonly<APNavDirectorNavData>The current radio navigation data received by the director.
isInZoneOfConfusionbooleanWhether the source of the radio navigation data is a VOR and the airplane's position is close enough to the VOR to render lateral deviation values unreliable.
activateNavDataReadonly<APNavDirectorActivateNavData>The radio navigation data received by the director at the moment of activation.

Returns​

boolean

Whether the director can remain in the active state.

desiredBankIntercept()?​

optional desiredBankIntercept: (trackError) => number

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:293

A function which computes a desired bank angle to command for a given track error during intercept phase. The track error is the difference between the director's computed desired track and the airplane's actual ground track in the range [-180, 180) degrees. A positive error indicates that the shortest turn direction from the actual ground track toward the desired track is to the right. A positive bank angle indicates leftward bank. Defaults to a linear function which scales the track error by 2.5 to derive the desired bank angle.

Parameters​

ParameterType
trackErrornumber

Returns​

number

desiredBankTracking()?​

optional desiredBankTracking: (trackError) => number

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:302

A function which computes a desired bank angle to command for a given track error during tracking phase. The track error is the difference between the director's computed desired track and the airplane's actual ground track in the range [-180, 180) degrees. A positive error indicates that the shortest turn direction from the actual ground track toward the desired track is to the right. A positive bank angle indicates leftward bank. Defaults to a linear function which scales the track error by 1.25 to derive the desired bank angle.

Parameters​

ParameterType
trackErrornumber

Returns​

number

disableArming?​

optional disableArming: boolean

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:308

Whether to disable arming on the director. If true, the director will always skip the arming phase and instead immediately activate itself when requested. Defaults to false.

forceNavSource?​

optional forceNavSource: NavRadioIndex

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:313

Force the director to always use a certain NAV/CDI source

lateralInterceptCurve?​

optional lateralInterceptCurve: APNavDirectorInterceptFunc

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:272

A function used to translate DTK and XTK into a track intercept angle. If not defined, a function that computes a default curve tuned for slow GA aircraft will be used.

lateralInterceptCurveIntercept?​

optional lateralInterceptCurveIntercept: APNavDirectorInterceptFunc

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:278

A function used to translate DTK and XTK into a track intercept angle during intercept phase. If not defined, the function defined by lateralInterceptCurve will be used instead. Defaults to undefined.

lateralInterceptCurveTracking?​

optional lateralInterceptCurveTracking: APNavDirectorInterceptFunc

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:284

A function used to translate DTK and XTK into a track intercept angle during tracking phase. If not defined, the function defined by lateralInterceptCurve will be used instead. Defaults to undefined.

maxBankAngle?​

optional maxBankAngle: number | () => number

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:182

The maximum bank angle, in degrees, supported by the director, or a function which returns it. If not defined, the director will use the maximum bank angle defined by its parent autopilot (via apValues). Defaults to undefined.

maxBankAngleIntercept?​

optional maxBankAngleIntercept: number | () => number

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:189

The maximum bank angle, in degrees, supported by the director during intercept phase, or a function which returns it. If not defined, the director will use the maximum bank angle defined by maxBankAngle. Defaults to undefined.

maxBankAngleTracking?​

optional maxBankAngleTracking: number | () => number

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:196

The maximum bank angle, in degrees, supported by the director during tracking phase, or a function which returns it. If not defined, the director will use the maximum bank angle defined by maxBankAngle. Defaults to undefined.

phaseOptions?​

optional phaseOptions: Readonly<APNavDirectorPhaseOptions>

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:260

Options with which to configure the default phase selector logic. Ignored if the phaseSelector option is specified.

phaseSelector?​

optional phaseSelector: APNavDirectorPhaseSelectorFunc

Defined in: src/sdk/autopilot/directors/APNavDirector.ts:266

A function which selects the phase for the director to use when it is active and tracking a navigation signal. If not defined, the director will use a default selector which can be configured using the phaseOptions option.