Skip to main content

Type Alias: APBackCourseDirectorPhaseOptions

APBackCourseDirectorPhaseOptions = object

Defined in: src/sdk/autopilot/directors/APBackCourseDirector.ts:76

Options which which to configure APBackCourseDirector's default phase selection logic.

The director switches from intercept phase to tracking phase only when all tracking phase conditions are met. The director switches from tracking phase to intercept phase when any of the intercept phase conditions is met.

When the director is activated from an armed state, it will default to intercept phase unless all tracking phase conditions are met, in which case it will immediately enter tracking phase. The normal delay for entering tracking phase is ignored in this situation.

Properties​

interceptCourseError?​

optional interceptCourseError: number

Defined in: src/sdk/autopilot/directors/APBackCourseDirector.ts:93

The minimum absolute value of the error between the course of the desired track and the airplane's actual ground track, in degrees, required to enter intercept phase. Defaults to 5.

interceptDeflection?​

optional interceptDeflection: number

Defined in: src/sdk/autopilot/directors/APBackCourseDirector.ts:81

The minimum absolute value of the lateral deflection of the desired track relative to the plane, normalized from 0 to 1, required to enter intercept phase. Defaults to 0.25.

interceptSwitchDelay?​

optional interceptSwitchDelay: number

Defined in: src/sdk/autopilot/directors/APBackCourseDirector.ts:99

The amount of time that the conditions for switching to intercept phase must be met, in milliseconds, before the director switches from tracking phase to intercept phase. Defaults to 5000.

interceptXtk?​

optional interceptXtk: number

Defined in: src/sdk/autopilot/directors/APBackCourseDirector.ts:87

The minimum absolute value of the cross-track error of the plane from the desired track, in nautical miles, required to enter intercept phase. Defaults to Infinity.

trackingCourseError?​

optional trackingCourseError: number

Defined in: src/sdk/autopilot/directors/APBackCourseDirector.ts:117

The maximum allowed absolute value of the error between the course of the desired track and the airplane's actual ground track, in degrees, required to enter intercept phase. Defaults to 2.

trackingDeflection?​

optional trackingDeflection: number

Defined in: src/sdk/autopilot/directors/APBackCourseDirector.ts:105

The maximum allowed absolute value of the lateral deflection of the desired track relative to the plane, normalized from 0 to 1, required to enter tracking phase. Defaults to 0.125.

trackingSwitchDelay?​

optional trackingSwitchDelay: number

Defined in: src/sdk/autopilot/directors/APBackCourseDirector.ts:123

The amount of time that the conditions for switching to tracking phase must be met, in milliseconds, before the director switches from intercept phase to tracking phase. Defaults to 5000.

trackingXtk?​

optional trackingXtk: number

Defined in: src/sdk/autopilot/directors/APBackCourseDirector.ts:111

The maximum allowed absolute value of the cross-track error of the plane from the desired track, in nautical miles, required to enter intercept phase. Defaults to Infinity.