Class: GarminVNavUtils
Defined in: src/garminsdk/autopilot/vnav/GarminVNavUtils.ts:12
A utility class for working with Garmin VNAV.
Constructors
Constructor
new GarminVNavUtils():
GarminVNavUtils
Returns
GarminVNavUtils
Methods
getDistanceToConstraint()
staticgetDistanceToConstraint(verticalPlan,constraintIndex,globalLegIndex,distanceAlongLeg):number
Defined in: src/garminsdk/autopilot/vnav/GarminVNavUtils.ts:566
Gets the along-track distance, in meters, from a point along the flight plan to the end of a VNAV constraint.
Parameters
| Parameter | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
constraintIndex | number | The index of the VNAV constraint to calculate the distance to. |
globalLegIndex | number | The global index of the flight plan leg along which the point to check lies. |
distanceAlongLeg | number | The distance, in meters, from the start of the flight plan leg to the point to check. |
Returns
number
The along-track distance, in meters, from the specified point to the end of the VNAV constraint.
getPathDesiredAltitude()
Call Signature
staticgetPathDesiredAltitude(verticalPlan,pathConstraintIndex,distance):number
Defined in: src/garminsdk/autopilot/vnav/GarminVNavUtils.ts:602
Gets the desired altitude, in meters, along a descent path at a specific point.
Parameters
| Parameter | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
pathConstraintIndex | number | The index of the VNAV constraint defining the descent path. |
distance | number | The distance, in meters, from the point to check to the end of the VNAV constraint defining the descent path. |
Returns
number
Call Signature
staticgetPathDesiredAltitude(verticalPlan,pathConstraintIndex,globalLegIndex,distanceAlongLeg):number
Defined in: src/garminsdk/autopilot/vnav/GarminVNavUtils.ts:615
Gets the desired altitude, in meters, along a descent path at a specific point.
Parameters
| Parameter | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
pathConstraintIndex | number | The index of the VNAV constraint defining the descent path. |
globalLegIndex | number | The global index of the flight plan leg along which the point to check lies. |
distanceAlongLeg | number | The distance, in meters, from the start of the flight plan leg to the point to check. |
Returns
number
The desired altitude, in meters, along the descent path at the specified point.
getTocBocDetails()
staticgetTocBocDetails(verticalPlan,activeConstraintIndex,activeLegIndex,distanceAlongLeg,currentGroundSpeed,currentAltitude,currentVS,isMapr,out):TocBocDetails
Defined in: src/garminsdk/autopilot/vnav/GarminVNavUtils.ts:386
Gets the VNAV TOC/BOC details for a vertical flight plan.
Parameters
| Parameter | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
activeConstraintIndex | number | The index of the vertical constraint containing the active flight plan leg. |
activeLegIndex | number | The index of the active flight plan leg. |
distanceAlongLeg | number | The distance the plane is along the active flight plan 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. |
isMapr | boolean | Whether to get TOC/BOC details for the missed approach. |
out | TocBocDetails | The object to which to write the TOC/BOC details. |
Returns
TocBocDetails
The VNAV TOC/BOC details.
getTodBodDetails()
staticgetTodBodDetails(verticalPlan,activeConstraintIndex,activeLegIndex,distanceAlongLeg,currentAltitude,currentVS,out):GarminTodBodDetails
Defined in: src/garminsdk/autopilot/vnav/GarminVNavUtils.ts:185
Gets the VNAV TOD/BOD details for a vertical flight plan.
Parameters
| Parameter | Type | Description |
|---|---|---|
verticalPlan | VerticalFlightPlan | The vertical flight plan. |
activeConstraintIndex | number | The index of the VNAV constraint containing the active flight plan leg. |
activeLegIndex | number | The global index of the active flight plan leg. |
distanceAlongLeg | number | The along-track distance from the start of the active flight plan leg to the airplane's position, in meters. |
currentAltitude | number | The current indicated altitude in meters. |
currentVS | number | The current vertical speed in meters per minute. |
out | GarminTodBodDetails | The object to which to write the TOD/BOD details. |
Returns
The VNAV TOD/BOD details.
invalidateClimbConstraint()
staticinvalidateClimbConstraint(constraint,index,constraints,firstDescentConstraintIndex,priorMinAltitude,priorMaxAltitude):boolean
Defined in: src/garminsdk/autopilot/vnav/GarminVNavUtils.ts:99
A function which checks whether a climb constraint should be invalidated.
Parameters
| Parameter | Type | Description |
|---|---|---|
constraint | VNavConstraint | A descent constraint. |
index | number | The index of the constraint to check if it is already in the vertical flight plan. If the constraint is not already in the vertical flight plan (i.e. the constraint has been previously invalidated), then this value equals -(index + 1) where index is the index at which the constraint would appear in the vertical flight plan if it were included. |
constraints | readonly VNavConstraint[] | 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()
staticinvalidateDescentConstraint(constraint,index,constraints,priorMinAltitude,priorMaxAltitude,requiredFpa,maxFpa):boolean
Defined in: src/garminsdk/autopilot/vnav/GarminVNavUtils.ts:148
A function which checks whether a descent constraint should be invalidated.
Parameters
| Parameter | Type | Description |
|---|---|---|
constraint | VNavConstraint | A descent constraint. |
index | number | The index of the constraint to check if it is already in the vertical flight plan. If the constraint is not already in the vertical flight plan, then this value equals -(index + 1) if it is not, where index. |
constraints | readonly VNavConstraint[] | 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.
isLegVNavEligible()
staticisLegVNavEligible(lateralLeg):boolean
Defined in: src/garminsdk/autopilot/vnav/GarminVNavUtils.ts:18
Checks if a lateral flight plan leg is eligible for VNAV.
Parameters
| Parameter | Type | Description |
|---|---|---|
lateralLeg | LegDefinition | A lateral flight plan leg. |
Returns
boolean
Whether the specified leg is eligible for VNAV.
shouldUseConstraint()
staticshouldUseConstraint(lateralPlan,lateralLeg,globalLegIndex,segment,segmentLegIndex):boolean
Defined in: src/garminsdk/autopilot/vnav/GarminVNavUtils.ts:45
Checks whether an altitude constraint defined for a lateral flight plan leg should be used for VNAV.
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.