Skip to main content

Interface: VNavConstraint

Defined in: src/sdk/autopilot/VerticalNavigation.ts:239

An altitude constraint in a VerticalFlightPlan.

Properties​

alongTrackOffset?​

optional alongTrackOffset: number

Defined in: src/sdk/autopilot/VerticalNavigation.ts:254

The along-track offset of this constraint from the end of the flight plan leg that hosts this constraint, in meters. Positive values indicate this constraint is located past the end of the leg, and negative values indicate this constraint is located prior to the end of the leg. If not defined, then the offset is zero.

containingLegDistanceToEnd?​

optional containingLegDistanceToEnd: number

Defined in: src/sdk/autopilot/VerticalNavigation.ts:266

The distance from this constraint to the end of its containing leg. Only defined if this constraint's along-track offset is non-zero.

containingLegIndex?​

optional containingLegIndex: number

Defined in: src/sdk/autopilot/VerticalNavigation.ts:260

The global index of the flight plan leg that contains this constraint. Only defined if this constraint's along-track offset is non-zero.

distance​

distance: number

Defined in: src/sdk/autopilot/VerticalNavigation.ts:302

The distance from this constraint to the constraint immediately prior to it (in flight plan order), in meters. If there is no prior constraint, then the distance is measured to the beginning of the flight plan.

fpa​

fpa: number

Defined in: src/sdk/autopilot/VerticalNavigation.ts:308

The flight path angle of the vertical path terminating at this constraint, in degrees. Positive angles represent a descending path.

index​

index: number

Defined in: src/sdk/autopilot/VerticalNavigation.ts:244

The global index of the flight plan leg that hosts this constraint.

isBeyondFaf​

isBeyondFaf: boolean

Defined in: src/sdk/autopilot/VerticalNavigation.ts:320

Whether or not this constraint is beyond the FAF.

isPathEnd​

isPathEnd: boolean

Defined in: src/sdk/autopilot/VerticalNavigation.ts:285

Whether or not this constraint is the last constraint prior to a MANSEQ or other VNAV ineligible leg type.

isTarget​

isTarget: boolean

Defined in: src/sdk/autopilot/VerticalNavigation.ts:282

Whether or not this constraint is a target that will be held at during a level-off or whether it will instead be passed through with no level off.

legs​

legs: VNavLeg[]

Defined in: src/sdk/autopilot/VerticalNavigation.ts:317

The vertical flight plan legs assigned to this constraint. The legs appear in the array in the reverse order in which they appear in the flight plan. The first leg in the array is always the leg that hosts this constraint. All subsequent legs in the array represent a consecutive sequence of legs in the flight plan that ends with the leg immediately following (in flight plan order) the leg hosting the prior constraint, or the first leg in the flight plan if there is no prior constraint.

maxAltitude​

maxAltitude: number

Defined in: src/sdk/autopilot/VerticalNavigation.ts:272

The maximum altitude of this constraint in meters, or positive infinity if this constraint has no maximum altitude.

minAltitude​

minAltitude: number

Defined in: src/sdk/autopilot/VerticalNavigation.ts:269

The minimum altitude of this constraint in meters, or negative infinity if this constraint has no minimum altitude.

name​

name: string

Defined in: src/sdk/autopilot/VerticalNavigation.ts:296

The name of the flight plan leg that hosts this constraint.

nextVnavEligibleLegIndex?​

optional nextVnavEligibleLegIndex: number

Defined in: src/sdk/autopilot/VerticalNavigation.ts:293

The global index of the earliest flight plan leg that is eligible for computing a VNAV path that is not followed by a path-ineligible leg in this constraint, if this constraint contains at least one path-ineligible leg. If the last leg in this constraint is path-ineligible, then this index will be equal to the global index of this constraint's host leg plus one. If this constraint has no path-ineligible legs, then this property is undefined.

targetAltitude​

targetAltitude: number

Defined in: src/sdk/autopilot/VerticalNavigation.ts:275

The target altitude of this constraint in meters.

type​

type: "direct" | "climb" | "descent" | "manual" | "missed" | "dest"

Defined in: src/sdk/autopilot/VerticalNavigation.ts:241

The type of this constraint.