Class: VNavUtils
A utility class for working with VNAV.
Constructors
constructor
• new VNavUtils(): VNavUtils
Returns
Methods
altitudeConstraintDetailsEquals
▸ altitudeConstraintDetailsEquals(a, b): boolean
Checks whether two altitude constraint details are equal.
Parameters
| Name | Type | Description |
|---|---|---|
a | AltitudeConstraintDetails | The first altitude constraint details. |
b | AltitudeConstraintDetails | The second altitude constraint details. |
Returns
boolean
Whether the two altitude constraint details are equal.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:1297
altitudeForDistance
▸ altitudeForDistance(fpa, distance): number
Gets the change in altitude along a flight path angle for a given lateral distance traveled.
Parameters
| Name | Type | Description |
|---|---|---|
fpa | number | The flight path angle, in degrees. Positive values represent an ascending flight path. |
distance | number | The lateral distance traveled. |
Returns
number
The change in altitude along the specified flight path angle for the specified lateral distance traveled,
expressed in the same units as distance.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:86
createConstraint
▸ createConstraint(index, minAltitude, maxAltitude, name, type?): VNavConstraint
Creates a new empty vertical flight plan constraint.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
index | number | undefined | The leg index of the constraint. |
minAltitude | number | undefined | The bottom altitude of the constraint. |
maxAltitude | number | undefined | THe top altitude of the constraint. |
name | string | undefined | The name of the leg for the constraint. |
type | "direct" | "climb" | "descent" | "manual" | "missed" | 'descent' | The type of constraint. |
Returns
A new empty constraint.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:1171
createLeg
▸ createLeg(segmentIndex, legIndex, name, distance?): VNavLeg
Creates a new vertical flight plan leg.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
segmentIndex | number | undefined | The segment index for the leg. |
legIndex | number | undefined | The index of the leg within the segment. |
name | string | undefined | The name of the leg. |
distance | number | 0 | The leg distance. |
Returns
A new VNAV plan leg.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:1196
distanceForAltitude
▸ distanceForAltitude(fpa, altitude): number
Gets the lateral distance traveled along a flight path angle for a given change in altitude.
Parameters
| Name | Type | Description |
|---|---|---|
fpa | number | The flight path angle, in degrees. Positive values represent an ascending flight path. |
altitude | number | The change in the altitude. |
Returns
number
The lateral distance traveled along the specified flight path angle for the specified change in altitude,
expressed in the same units as altitude.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:97
getConstraintDetails
▸ getConstraintDetails(constraint, out): AltitudeConstraintDetails
Gets VNAV Constraint Details from a constraint.
Parameters
| Name | Type | Description |
|---|---|---|
constraint | VNavConstraint | The constraint to get details from. |
out | AltitudeConstraintDetails | The object to which write the results. |
Returns
The VNav Constraint Details.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:309
getConstraintDistanceFromConstraint
▸ getConstraintDistanceFromConstraint(constraint): number
Gets a constraint segment distance from the constraint legs.
Parameters
| Name | Type | Description |
|---|---|---|
constraint | VNavConstraint | The constraint to calculate a distance for. |
Returns
number
The constraint distance, in meters.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:240
getConstraintDistanceFromLegs
▸ getConstraintDistanceFromLegs(constraint, previousConstraint, verticalPlan): number
Gets a constraint segment distance from the Vertical Plan legs.
Parameters
| Name | Type | Description |
|---|---|---|
constraint | VNavConstraint | The constraint to calculate a distance for. |
previousConstraint | undefined | VNavConstraint | The constraint that preceds the constraint we are calculating the distance for. |
verticalPlan | VerticalFlightPlan | The Vertical Flight Plan. |
Returns
number
The constraint distance, in meters.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:257
getConstraintForVerticalDirect
▸ getConstraintForVerticalDirect(verticalPlan, activeGlobalLegIndex, selectedGlobalLegIndex): undefined | VNavConstraint
Gets the constraint for a vertical direct based on an input global leg index.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
activeGlobalLegIndex | number | The current active global leg index. |
selectedGlobalLegIndex | number | The input global leg index selected. |
Returns
undefined | VNavConstraint
The constraint, or undefined if none exists.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:1130
getConstraintFromLegIndex
▸ getConstraintFromLegIndex(verticalPlan, globalLegIndex): undefined | VNavConstraint
Gets the VNAV constraint that contains a flight plan leg.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
globalLegIndex | number | The global leg index of the flight plan leg. |
Returns
undefined | VNavConstraint
The VNAV constraint that contains the specified flight plan leg, or undefined if one could not be
found.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:179
getConstraintIndexFromLegIndex
▸ getConstraintIndexFromLegIndex(verticalPlan, globalLegIndex): number
Gets the index of the VNAV constraint that contains a flight plan leg.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
globalLegIndex | number | The global leg index of the flight plan leg. |
Returns
number
The index of the VNAV constraint that contains the specified flight plan leg, or -1 if one could not
be found.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:163
getConstraintLegIndexFromLegIndex
▸ getConstraintLegIndexFromLegIndex(verticalPlan, globalLegIndex): number
Gets the global leg index for the constraint containing an indexed leg.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical plan. |
globalLegIndex | number | A global leg index. |
Returns
number
The global leg index for the constraint containing the leg at the specified global index, or -1 if one could not be found.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:231
getCruiseTocBocDetails
▸ getCruiseTocBocDetails(lateralPlan, verticalPlan, activeLegIndex, distanceAlongLeg, currentGroundSpeed, currentAltitude, currentVS, cruiseAltitude, out): TocBocDetails
Gets the VNAV TOC/BOC to cruise altitude details for a vertical flight plan.
Parameters
| Name | Type | Description |
|---|---|---|
lateralPlan | FlightPlan | The lateral flight plan. |
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
activeLegIndex | number | The current active leg index. |
distanceAlongLeg | number | The distance the plane is along the current leg in meters. |
currentGroundSpeed | number | The current ground speed, in knots. |
currentAltitude | number | The current indicated altitude in meters. |
currentVS | number | The current vertical speed in meters per minute. |
cruiseAltitude | number | The cruise altitude, in meters. |
out | TocBocDetails | The object to which to write the TOC/BOC details. |
Returns
The VNAV TOC/BOC to cruise altitude details.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:976
getCurrentClimbConstraint
▸ getCurrentClimbConstraint(verticalPlan, globalLegIndex): undefined | VNavConstraint
Gets the current climb constraint, if one exists.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
globalLegIndex | number | The global index of the flight plan leg to find the constraint for. |
Returns
undefined | VNavConstraint
The current climb constraint, or undefined if no such constraint exists.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:492
getDesiredAltitude
▸ getDesiredAltitude(verticalPlan, globalLegIndex, distanceAlongLeg): number
Gets the VNAV desired altitude.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
globalLegIndex | number | The global leg index to get the target for. |
distanceAlongLeg | number | The distance along the leg the aircraft is presently. |
Returns
number
The current VNAV desired altitude.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:550
getDistanceToConstraint
▸ getDistanceToConstraint(constraint, lateralPlan, activeLegIndex, distanceAlongLeg): number
Gets the distance from the current location in the plan to the constraint.
Parameters
| Name | Type | Description |
|---|---|---|
constraint | VNavConstraint | The vnav constraint to calculate the distance to. |
lateralPlan | FlightPlan | The lateral flight plan. |
activeLegIndex | number | The current active leg index. |
distanceAlongLeg | number | The current distance along leg. |
Returns
number
the distance to the constraint, or positive infinity if a discontinuity exists between the ppos and the constraint.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:278
getEventBusTopicSuffix
▸ getEventBusTopicSuffix<Index>(index): Index extends 0 ? "" : `_${Index}`
Gets the suffix for event bus topics published by VNAV with a given index.
Type parameters
| Name | Type |
|---|---|
Index | extends number |
Parameters
| Name | Type | Description |
|---|---|---|
index | Index | The index of the VNAV for which to get the suffix. |
Returns
Index extends 0 ? "" : `_${Index}`
The suffix for event bus topics published by VNAV with the specified index.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:1342
getFafAltitude
▸ getFafAltitude(verticalPlan): undefined | number
Gets and returns the FAF altitude.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
Returns
undefined | number
the FAF constraint altitude.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:566
getFafIndex
▸ getFafIndex(plan): undefined | number
Gets the FAF index in the plan.
Parameters
| Name | Type | Description |
|---|---|---|
plan | FlightPlan | The flight plan. |
Returns
undefined | number
The FAF index in the plan.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:123
getFafIndexReverse
▸ getFafIndexReverse(lateralPlan, iterator): number
Finds and returns the FAF index in the plan.
Parameters
| Name | Type | Description |
|---|---|---|
lateralPlan | FlightPlan | The lateral flight plan. |
iterator | FlightPlanLegIterator | The FlightPlanLegIterator instance. |
Returns
number
The FAF index in the lateral flight plan.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:142
getFirstClimbConstraintIndex
▸ getFirstClimbConstraintIndex(verticalPlan): number
Finds the index of the first climb constraint in a vertical plan.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | A vertical flight plan. |
Returns
number
The index of the first climb constraint in the specified vertical plan, or -1 if the plan has no
climb constraints.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:1218
getFirstDescentConstraintIndex
▸ getFirstDescentConstraintIndex(verticalPlan): number
Finds the index of the first descent constraint in a vertical plan.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | A vertical flight plan. |
Returns
number
The index of the first descent constraint in the specified vertical plan, or -1 if the plan has no
descent constraints.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:1250
getFpa
▸ getFpa(distance, altitude): number
Gets the flight path angle required to travel a given lateral distance and altitude. Positive flight path angles represent an ascending flight path. By convention, the flight path angle required to travel zero altitude equals zero degrees for all distances.
Parameters
| Name | Type | Description |
|---|---|---|
distance | number | The lateral distance to travel, in the same units as altitude. |
altitude | number | The altitude to travel, in the same units as distance. |
Returns
number
The flight path angle, in degrees, required to travel the specified altitude and distance.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:71
getFpaFromVerticalSpeed
▸ getFpaFromVerticalSpeed(vs, groundspeed): number
Gets the equivalent flight path angle for a given vertical speed and groundspeed. For this calculation, positive flight path angles represent an ascending flight path.
Parameters
| Name | Type | Description |
|---|---|---|
vs | number | The vertical speed, in feet per minute. |
groundspeed | number | The groundspeed, in knots. |
Returns
number
The flight path angle equivalent to the specified vertical speed and ground speed.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:59
getIsPathEnd
▸ getIsPathEnd(verticalPlan, globalLegIndex): boolean
Gets and returns whether the input leg index is a path end.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
globalLegIndex | number | is the global leg index to check. |
Returns
boolean
whether the input leg index is a path end.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:216
getLastClimbConstraintIndex
▸ getLastClimbConstraintIndex(verticalPlan): number
Finds the index of the last climb constraint in a vertical plan.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | A vertical flight plan. |
Returns
number
The index of the last climb constraint in the specified vertical plan, or -1 if the plan has no
climb constraints.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:1234
getLastDescentConstraintIndex
▸ getLastDescentConstraintIndex(verticalPlan): number
Finds the index of the last descent constraint in a vertical plan.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | A vertical flight plan. |
Returns
number
The index of the last descent constraint in the specified vertical plan, or -1 if the plan has no
descent constraints.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:1271
getMissedApproachLegIndex
▸ getMissedApproachLegIndex(plan): number
Gets the missed approach leg index.
Parameters
| Name | Type | Description |
|---|---|---|
plan | FlightPlan | The flight plan. |
Returns
number
The Destination leg global leg index.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:106
getNextClimbConstraintIndex
▸ getNextClimbConstraintIndex(verticalPlan, globalLegIndex): number
Gets the index of the next climb constraint at or after a flight plan leg.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
globalLegIndex | number | The global index of the flight plan leg to find the constraint for. |
Returns
number
The index of the next climb constraint at or after the specified flight plan leg, or -1 if one could
not be found.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:396
getNextClimbTargetAltitude
▸ getNextClimbTargetAltitude(verticalPlan, globalLegIndex): undefined | number
Gets the next climb constraint maximum altitude at or after a flight plan leg, or undefined if none exists.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
globalLegIndex | number | The global index of the flight plan leg to find the constraint for. |
Returns
undefined | number
The next climb constraint defined maximum altitude in meters at or after the specified flight plan leg, or
undefined if no such constraint exists.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:507
getNextClimbTargetConstraint
▸ getNextClimbTargetConstraint(verticalPlan, globalLegIndex): undefined | VNavConstraint
Gets the next climb constraint with a defined maximum altitude at or after a flight plan leg.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
globalLegIndex | number | The global index of the flight plan leg to find the constraint for. |
Returns
undefined | VNavConstraint
The next climb constraint with a defined maximum altitude at or after the specified flight plan leg, or
undefined if no such constraint exists.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:465
getNextDescentConstraintIndex
▸ getNextDescentConstraintIndex(verticalPlan, globalLegIndex): number
Gets the index of the next descent constraint at or after a flight plan leg.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
globalLegIndex | number | The global index of the flight plan leg to find the constraint for. |
Returns
number
The index of the next descent constraint at or after the specified flight plan leg, or -1 if one could
not be found.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:377
getNextDescentTargetAltitude
▸ getNextDescentTargetAltitude(verticalPlan, globalLegIndex): undefined | number
Gets the next descent constraint minimum altitude at or after a flight plan leg, or undefined if none exists.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
globalLegIndex | number | The global index of the flight plan leg to find the constraint for. |
Returns
undefined | number
The next descent constraint defined minimum altitude in meters at or after the specified flight plan leg, or
undefined if no such constraint exists.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:453
getNextDescentTargetConstraint
▸ getNextDescentTargetConstraint(verticalPlan, globalLegIndex): undefined | VNavConstraint
Gets the next descent constraint with a defined minimum altitude at or after a flight plan leg.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
globalLegIndex | number | The global index of the flight plan leg to find the constraint for. |
Returns
undefined | VNavConstraint
The next descent constraint with a defined minimum altitude at or after the specified flight
plan leg, or undefined if no such constraint exists.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:434
getNextMaprConstraintIndex
▸ getNextMaprConstraintIndex(verticalPlan, globalLegIndex): number
Gets the index of the next missed approach constraint at or after a flight plan leg.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
globalLegIndex | number | The global index of the flight plan leg to find the constraint for. |
Returns
number
The index of the next missed approach constraint at or after the specified flight plan leg, or -1 if
one could not be found.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:415
getNextMaprTargetAltitude
▸ getNextMaprTargetAltitude(verticalPlan, globalLegIndex): undefined | number
Gets the next missed approach constraint maximum altitude at or after a flight plan leg, or undefined if none exists.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
globalLegIndex | number | The global index of the flight plan leg to find the constraint for. |
Returns
undefined | number
The next missed approach constraint defined maximum altitude in meters at or after the specified flight plan leg, or
undefined if no such constraint exists.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:538
getNextMaprTargetConstraint
▸ getNextMaprTargetConstraint(verticalPlan, globalLegIndex): undefined | VNavConstraint
Gets the next missed approach constraint with a defined maximum altitude at or after a flight plan leg.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
globalLegIndex | number | The global index of the flight plan leg to find the constraint for. |
Returns
undefined | VNavConstraint
The next missed approach constraint with a defined maximum altitude at or after the specified flight
plan leg, or undefined if no such constraint exists.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:519
getPathErrorDistance
▸ getPathErrorDistance(groundSpeed): number
Computes the path error distance that should be used given the groundspeed.
Parameters
| Name | Type | Description |
|---|---|---|
groundSpeed | number | The current groundspeed, in knots. |
Returns
number
The path error distance to use.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:1318
getPriorConstraintFromLegIndex
▸ getPriorConstraintFromLegIndex(verticalPlan, globalLegIndex): undefined | VNavConstraint
Gets the VNAV constraint immediately prior to the constraint that contains a flight plan leg.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
globalLegIndex | number | The global leg index of the flight plan leg. |
Returns
undefined | VNavConstraint
The VNAV constraint immediately prior to the constraint that contains the specified flight plan leg, or
undefined if one could nto be found.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:206
getPriorConstraintIndexFromLegIndex
▸ getPriorConstraintIndexFromLegIndex(verticalPlan, globalLegIndex): number
Gets the index of the VNAV constraint immediately prior to the constraint that contains a flight plan leg.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
globalLegIndex | number | The global leg index of the flight plan leg. |
Returns
number
The index of the VNAV constraint immediately prior to the constraint that contains the specified flight
plan leg, or -1 if one could nto be found.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:190
getRequiredVs
▸ getRequiredVs(distance, targetAltitude, currentAltitude, groundSpeed): number
Gets the required vertical speed to meet an altitude constraint.
Parameters
| Name | Type | Description |
|---|---|---|
distance | number | The distance to the constraint, in nautical miles. |
targetAltitude | number | The target altitude for the constraint, in feet. |
currentAltitude | number | The current altitude, in feet. |
groundSpeed | number | The current groundspeed, in knots. |
Returns
number
The required vertical speed, in feet per minute, to meet the altitude constraint.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:36
getTocBocDetails
▸ getTocBocDetails(verticalPlan, activeLegIndex, distanceAlongLeg, currentGroundSpeed, currentAltitude, currentVS, out): TocBocDetails
Gets the VNAV TOC/BOC details for a vertical flight plan.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
activeLegIndex | number | The current active leg index. |
distanceAlongLeg | number | The distance the plane is along the current leg in meters. |
currentGroundSpeed | number | The current ground speed, in knots. |
currentAltitude | number | The current indicated altitude in meters. |
currentVS | number | The current vertical speed in meters per minute. |
out | TocBocDetails | The object to which to write the TOC/BOC details. |
Returns
The VNAV TOC/BOC details.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:782
getTodBodDetails
▸ getTodBodDetails(verticalPlan, activeLegIndex, distanceAlongLeg, currentAltitude, currentVS, out): TodBodDetails
Gets the VNAV TOD/BOD details for a vertical flight plan.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
activeLegIndex | number | The current active leg index. |
distanceAlongLeg | number | The distance the plane is along the current leg in meters. |
currentAltitude | number | The current indicated altitude in meters. |
currentVS | number | The current vertical speed in meters per minute. |
out | TodBodDetails | The object to which to write the TOD/BOD details. |
Returns
The VNAV TOD/BOD details.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:585
getVerticalDirectConstraintFromIndex
▸ getVerticalDirectConstraintFromIndex(verticalPlan, selectedGlobalLegIndex, activeLegIndex): undefined | VNavConstraint
Gets and returns the vertical direct constraint based on an input index.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
selectedGlobalLegIndex | number | The global leg index selected for vertical direct. |
activeLegIndex | number | The active leg index. |
Returns
undefined | VNavConstraint
The Vnav Constraint for the vertical direct or undefined.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:352
getVerticalLegFromPlan
▸ getVerticalLegFromPlan(verticalPlan, globalLegIndex): VNavLeg
Gets a VNAV leg from a vertical flight plan.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
globalLegIndex | number | The global leg index of the leg to get. |
Returns
The requested VNAV leg.
Throws
Not found if the index is not valid.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:1094
getVerticalLegFromSegmentInPlan
▸ getVerticalLegFromSegmentInPlan(verticalPlan, segmentIndex, legIndex): VNavLeg
Gets a VNAV leg from the plan from a specified segment.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
segmentIndex | number | The segment index of the leg to get. |
legIndex | number | The index of the leg to get within the specified segment. |
Returns
The requested VNAV leg.
Throws
Not found if the index is not valid.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:1113
getVerticalSegmentsFromPlan
▸ getVerticalSegmentsFromPlan(verticalPlan): VNavPlanSegment[]
Gets the VNAV segments from the calculated VNAV plan.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
Returns
The vnav segments.
Throws
Not found if the index is not valid.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:1140
getVerticalSpeedFromFpa
▸ getVerticalSpeedFromFpa(fpa, groundspeed): number
Gets the vertical speed required to maintain a given flight path angle and groundspeed.
Parameters
| Name | Type | Description |
|---|---|---|
fpa | number | The flight path angle, in degrees. Positive angles represent an ascending flight path. |
groundspeed | number | The groundspeed, in knots. |
Returns
number
The vertical speed required to maintain the specified flight path angle and groundspeed.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:48
isLegTypeHoldOrProcedureTurn
▸ isLegTypeHoldOrProcedureTurn(lateralLeg): boolean
Gets whether a lateral plan leg is a hold or procedure turn.
Parameters
| Name | Type | Description |
|---|---|---|
lateralLeg | LegDefinition | The Lateral Leg in the flight plan (LegDefinition). |
Returns
boolean
Whether the leg is a hold or procedure turn.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:1149
isUserConstraint
▸ isUserConstraint(lateralLeg): boolean
Checks if a constraint is a user-created constraint.
Parameters
| Name | Type | Description |
|---|---|---|
lateralLeg | LegDefinition | The Lateral Flight Plan Leg. |
Returns
boolean
If this constraint is a user-created constraint.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:19
isValidVNavIndex
▸ isValidVNavIndex(index): boolean
Checks whether an index is a valid VNAV index.
Parameters
| Name | Type | Description |
|---|---|---|
index | number | The index to check. |
Returns
boolean
Whether the specified index is a valid VNAV index.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:1333
speedConstraintDetailsEquals
▸ speedConstraintDetailsEquals(a, b): boolean
Checks whether two speed constraint details are equal.
Parameters
| Name | Type | Description |
|---|---|---|
a | SpeedConstraintDetails | The first speed constraint details. |
b | SpeedConstraintDetails | The second speed constraint details. |
Returns
boolean
Whether the two speed constraint details are equal.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:1307
speedConstraintEquals
▸ speedConstraintEquals(a, b): boolean
Checks whether two speed constraints are equal.
Parameters
| Name | Type | Description |
|---|---|---|
a | SpeedConstraint | The first speed constraint. |
b | SpeedConstraint | The second speed constraint. |
Returns
boolean
Whether the two speed constraints are equal.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:1287
verticalPlanHasLeg
▸ verticalPlanHasLeg(verticalPlan, globalLegIndex): boolean
Checks whether or not the vertical plan has a leg at a given globalLegIndex.
Parameters
| Name | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The Vertical Flight Plan. |
globalLegIndex | number | The global leg index to check. |
Returns
boolean
True if the leg exists.
Defined in
src/sdk/autopilot/vnav/VNavUtils.ts:1077