Type Alias: SmoothingPathCalculatorOptions
SmoothingPathCalculatorOptions =
object
Defined in: src/sdk/autopilot/calculators/SmoothingPathCalculator.ts:30
Options for a SmoothingPathCalculator.
Properties
defaultFpa?
optionaldefaultFpa:number
Defined in: src/sdk/autopilot/calculators/SmoothingPathCalculator.ts:41
The default flight path angle, in degrees, for descent paths. Increasingly positive values indicate steeper descents. Defaults to 3 degrees.
directToLegOffset?
optionaldirectToLegOffset:number
Defined in: src/sdk/autopilot/calculators/SmoothingPathCalculator.ts:66
The index offset of a lateral direct-to leg from its direct-to target leg. Defaults to 3.
forceFirstApproachAtConstraint?
optionalforceFirstApproachAtConstraint:boolean
Defined in: src/sdk/autopilot/calculators/SmoothingPathCalculator.ts:63
Whether to force the first constraint in the approach to an AT constraint. Defaults to false.
Deprecated
Please use the getLegConstraintAltitudes option to customize minimum and maximum altitudes for VNAV
constraints.
getConstraintAlongTrackOffset()?
optionalgetConstraintAlongTrackOffset: (constraint,constraintIndex,verticalLeg,lateralLeg,verticalPlan,lateralPlan) =>number
Defined in: src/sdk/autopilot/calculators/SmoothingPathCalculator.ts:140
A function which gets the along-track offset to use for a VNAV constraint.
Parameters
| Parameter | Type | Description |
|---|---|---|
constraint | UncomputedVNavConstraint | The constraint for which to get an along-track offset. |
constraintIndex | number | The index of the constraint for which to get an along-track offset. |
verticalLeg | UncomputedVNavLeg | The vertical flight plan leg that hosts the constraint for which to get an along-track offset. |
lateralLeg | LegDefinition | The lateral flight plan leg that hosts the constraint for which to get an along-track offset. |
verticalPlan | VerticalFlightPlan | The vertical flight plan containing the constraint for which to get an along-track offset. Use caution when accessing information from the vertical flight plan - computed vertical path information may be unavailable or out-of-date. Refer to the UncomputedVNavLeg and UncomputedVNavConstraint types for guidance on what information from legs and constraints is safe to access. |
lateralPlan | FlightPlan | The lateral flight plan associated with the constraint for which to get an along-track offset. |
Returns
number
The along-track offset to use for the specified VNAV constraint, in meters. An offset of zero indicates the constraint is coincident with the end of its host leg, positive offsets move the constraint forward along the flight plan, and negative offsets move the constraint backward along the flight plan.
getDescentTargetConstraintAltitude()?
optionalgetDescentTargetConstraintAltitude: (constraint,constraintIndex,verticalLeg,lateralLeg,verticalPlan,lateralPlan) =>number
Defined in: src/sdk/autopilot/calculators/SmoothingPathCalculator.ts:230
Gets the target altitude to use for a target descent constraint, in meters. A target descent constraint is a constraint at which a section of the vertical path with a constant flight path angle terminates. The target altitude of the constraint is the altitude at which the vertical path crosses the constraint.
Note: this function is only called to get target altitudes for constraints for which the target altitude is not otherwise constrained by the vertical path to one possible value.
Parameters
| Parameter | Type | Description |
|---|---|---|
constraint | UncomputedVNavConstraint | The constraint for which to get a target altitude. |
constraintIndex | number | The index of the constraint for which to get a target altitude. |
verticalLeg | UncomputedVNavLeg | The vertical flight plan leg that hosts the constraint for which to get a target altitude. |
lateralLeg | LegDefinition | The lateral flight plan leg that hosts the constraint for which to get a target altitude. |
verticalPlan | VerticalFlightPlan | The vertical flight plan containing the constraint for which to get a target altitude. Use caution when accessing information from the vertical flight plan - computed vertical path information may be unavailable or out-of-date. Refer to the UncomputedVNavLeg and UncomputedVNavConstraint types for guidance on what information from legs and constraints is safe to access. |
lateralPlan | FlightPlan | The lateral flight plan associated with the constraint for which to get a target altitude. |
Returns
number
The target altitude to use for the specified target descent constraint, in meters.
getLegConstraintAltitudes()?
optionalgetLegConstraintAltitudes: (out,lateralPlan,lateralLeg,globalLegIndex,segment,segmentLegIndex) => [number,number] |undefined
Defined in: src/sdk/autopilot/calculators/SmoothingPathCalculator.ts:95
A function which gets the minimum and maximum altitudes to enforce for a VNAV constraint assigned to a lateral flight plan leg.
If not defined, then the minimum and maximum altitudes will be taken from the leg's vertical data based on the value of the altitude restriction type field as follows:
- AltitudeRestrictionType.At: minimum and maximum altitude equal to the first altitude restriction field.
- AltitudeRestrictionType.AtOrAbove: minimum altitude equal to the first altitude restriction field, maximum altitude equal to infinity.
- AltitudeRestrictionType.AtOrBelow: minimum altitude equal to negative infinity, maximum altitude equal to the second altitude restriction field.
- AltitudeRestrictionType.Between: minimum altitude equal to the second altitude restriction field, maximum altitude equal to the first altitude restriction field.
- AltitudeRestrictionType.Unused (or any other value): no altitudes.
Parameters
| Parameter | Type | Description |
|---|---|---|
out | [number, number] | The tuple to which to write the minimum and maximum altitudes, as [minimum_altitude, maximum_altitude] in meters. |
lateralPlan | FlightPlan | The lateral flight plan that hosts the leg for which to get the constraint altitudes. |
lateralLeg | LegDefinition | The lateral flight plan leg for which to get the constraint altitudes. |
globalLegIndex | number | The global index of the lateral flight plan leg for which to get the constraint altitudes. |
segment | FlightPlanSegment | The latearl flight plan segment containing the flight plan leg for which to get the constraint altitudes. |
segmentLegIndex | number | The index of the lateral flight plan leg for which to get the constraint altitudes in its containing segment. |
Returns
[number, number] | undefined
The minimum and maximum altitudes to enforce for a VNAV constraint assigned to the specified lateral
flight plan leg, as the tuple passed to the out parameter, or undefined if there should be no constraint
assigned to the leg.
index?
optionalindex:number
Defined in: src/sdk/autopilot/calculators/SmoothingPathCalculator.ts:35
The VNAV index to assign to the path calculator. The VNAV index determines the index of the control events used
to control the calculator. Defaults to 0.
invalidateClimbConstraint()?
optionalinvalidateClimbConstraint: (constraint,index,constraints,firstDescentConstraintIndex,priorMinAltitude,priorMaxAltitude) =>boolean
Defined in: src/sdk/autopilot/calculators/SmoothingPathCalculator.ts:167
A function which checks whether a climb constraint should be invalidated. Invalidated constraints will not appear in the vertical flight plan.
If not defined, then no climb constraints will be invalidated.
Parameters
| Parameter | Type | Description |
|---|---|---|
constraint | UncomputedVNavConstraint | The climb constraint to check. |
index | number | The index of the constraint to check. |
constraints | readonly UncomputedVNavConstraint[] | The array of VNAV constraints currently in the vertical flight plan. |
firstDescentConstraintIndex | number | The index of the first descent constraint in the vertical flight plan, if one exists. |
priorMinAltitude | number | The most recent minimum altitude, in meters, defined by a VNAV constraint prior to the constraint to check. Only prior constraints connected to the constraint to check by a contiguous sequence of constraints of the same category (climb or missed approach) are included. |
priorMaxAltitude | number | The most recent maximum altitude, in meters, defined by a VNAV constraint prior to the constraint to check. Only prior constraints connected to the constraint to check by a contiguous sequence of constraints of the same category (climb or missed approach) are included. |
Returns
boolean
Whether the specified climb constraint should be invalidated.
invalidateDescentConstraint()?
optionalinvalidateDescentConstraint: (constraint,index,constraints,priorMinAltitude,priorMaxAltitude,requiredFpa,maxFpa) =>boolean
Defined in: src/sdk/autopilot/calculators/SmoothingPathCalculator.ts:202
A function which checks whether a descent constraint should be invalidated. Invalidated constraints will not appear in the vertical flight plan.
If not defined, then a constraint is invalidated if any of the following conditions is met:
- The constraint defines a minimum altitude and the minimum altitude is greater than the most recent maximum altitude defined by a prior constraint that is connected to the constraint to check by a contiguous sequence of descent constraints.
- The required flight path angle to meet the constraint is greater than the maximum allowed flight path angle.
Parameters
| Parameter | Type | Description |
|---|---|---|
constraint | UncomputedVNavConstraint | The descent constraint to check. |
index | number | The index of the constraint to check. |
constraints | readonly UncomputedVNavConstraint[] | The array of VNAV constraints currently in the vertical flight plan. |
priorMinAltitude | number | The most recent minimum altitude, in meters, defined by a VNAV constraint prior to the constraint to check. Only prior constraints connected to the constraint to check by a contiguous sequence of descent constraints are included. |
priorMaxAltitude | number | The most recent maximum altitude, in meters, defined by a VNAV constraint prior to the constraint to check. Only prior constraints connected to the constraint to check by a contiguous sequence of descent constraints are included. |
requiredFpa | number | The minimum flight path angle, in degrees, required to meet the maximum altitude of the constraint to check, assuming a descent starting from the constraint defining the most recent prior minimum altitude. Positive values indicate a descending path. If there is no required FPA because there is no defined prior minimum altitude or maximum altitude for the constraint to check, or if the constraint to check is higher than the prior minimum altitude, then this value will equal zero. |
maxFpa | number | The maximum allowed flight path angle, in degrees. Positive values indicate a descending path. |
Returns
boolean
Whether the specified descent constraint should be invalidated.
isLegEligible()?
optionalisLegEligible: (lateralLeg) =>boolean
Defined in: src/sdk/autopilot/calculators/SmoothingPathCalculator.ts:109
A function which checks whether a lateral flight plan leg is eligible for VNAV. VNAV descent paths will not be calculated through VNAV-ineligible legs. If not defined, then a leg will be considered eligible if and only if it does not contain a discontinuity.
Parameters
| Parameter | Type |
|---|---|
lateralLeg | LegDefinition |
Returns
boolean
maxFpa?
optionalmaxFpa:number
Defined in: src/sdk/autopilot/calculators/SmoothingPathCalculator.ts:56
The maximum allowed flight path angle, in degrees, for descent paths. Increasingly positive values indicate steeper descents. Paths that require angles greater than the maximum value will have their FPAs clamped to the maximum value, even if this would create a discontinuity in the vertical profile. Defaults to 6 degrees.
minFpa?
optionalminFpa:number
Defined in: src/sdk/autopilot/calculators/SmoothingPathCalculator.ts:49
The minimum allowed flight path angle, in degrees, for descent paths. Increasingly positive values indicate steeper descents. Paths that require angles less than the minimum value will be assigned the default flight path angle instead to create a step-down descent. Vertical direct-to paths are exempt from the minimum FPA requirement. Defaults to 1.5 degrees.
shouldUseConstraint()?
optionalshouldUseConstraint: (lateralPlan,lateralLeg,globalLegIndex,segment,segmentLegIndex) =>boolean
Defined in: src/sdk/autopilot/calculators/SmoothingPathCalculator.ts:123
A function which checks whether an altitude constraint defined for a lateral flight plan leg should be used for VNAV. If not defined, then all constraints will be used.
Parameters
| Parameter | Type | Description |
|---|---|---|
lateralPlan | FlightPlan | The lateral flight plan that hosts the altitude constraint. |
lateralLeg | LegDefinition | The lateral flight plan leg that hosts the altitude constraint. |
globalLegIndex | number | The global index of the lateral flight plan leg that hosts the altitude constraint. |
segment | FlightPlanSegment | The lateral flight plan segment containing the flight plan leg that hosts the altitude constraint. |
segmentLegIndex | number | The index of the lateral flight plan leg that hosts the altitude constraint in its containing segment. |
Returns
boolean
Whether the altitude constraint defined for the specified lateral flight plan leg should be used for VNAV.