Interface: VNavPathCalculator
Defined in: src/sdk/autopilot/calculators/VNavPathCalculator.ts:8
VNav Path Calculator Interface
Properties
flightPathAngle
flightPathAngle:
number
Defined in: src/sdk/autopilot/calculators/VNavPathCalculator.ts:11
The default FPA for this path calculator
maxFlightPathAngle
maxFlightPathAngle:
number
Defined in: src/sdk/autopilot/calculators/VNavPathCalculator.ts:14
The maximum FPA allowed for path calculator
planBuilt
readonly
planBuilt:ReadonlySubEvent
<this
,number
>
Defined in: src/sdk/autopilot/calculators/VNavPathCalculator.ts:17
An event fired when a vertical plan has been built or rebuilt, with the index of the plan as the event data.
vnavCalculated
readonly
vnavCalculated:ReadonlySubEvent
<this
,number
>
Defined in: src/sdk/autopilot/calculators/VNavPathCalculator.ts:20
An event fired when a path has been calculated, with the index of the plan as the event data.
Methods
activateVerticalDirect()
activateVerticalDirect(
planIndex
,constraintGlobalLegIndex
):void
Defined in: src/sdk/autopilot/calculators/VNavPathCalculator.ts:116
Activates a vertical direct to a constraint index.
Parameters
Parameter | Type | Description |
---|---|---|
planIndex | number | The vertical flight plan index. |
constraintGlobalLegIndex | number | The global leg index of the constraint to go direct to. |
Returns
void
createVerticalPlan()
createVerticalPlan(
planIndex
):VerticalFlightPlan
Defined in: src/sdk/autopilot/calculators/VNavPathCalculator.ts:35
Creates an empty vertical plan at a specified index.
Parameters
Parameter | Type | Description |
---|---|---|
planIndex | number | The Vertical Plan Index to create. |
Returns
The newly created Vertical Plan.
getCurrentConstraintAltitude()
getCurrentConstraintAltitude(
planIndex
,globalLegIndex
):undefined
|number
Defined in: src/sdk/autopilot/calculators/VNavPathCalculator.ts:76
Gets and returns the current constraint altitude in meters.
Parameters
Parameter | Type | Description |
---|---|---|
planIndex | number | The vertical flight plan index. |
globalLegIndex | number | The global index of the leg for which to get the current constraint. |
Returns
undefined
| number
The current constraint altitude in meters, or undefined
if there is no current constraint.
getCurrentConstraintDetails()
getCurrentConstraintDetails(
planIndex
,globalLegIndex
):AltitudeConstraintDetails
Defined in: src/sdk/autopilot/calculators/VNavPathCalculator.ts:84
Gets and returns the current constraint details.
Parameters
Parameter | Type | Description |
---|---|---|
planIndex | number | The vertical flight plan index. |
globalLegIndex | number | is the global leg index to check. |
Returns
the VNavConstraintDetails.
getFirstDescentConstraintAltitude()
getFirstDescentConstraintAltitude(
planIndex
):undefined
|number
Defined in: src/sdk/autopilot/calculators/VNavPathCalculator.ts:109
Gets the first VNAV Constraint Altitude.
Parameters
Parameter | Type | Description |
---|---|---|
planIndex | number | The vertical flight plan index. |
Returns
undefined
| number
The first VNAV constraint altitude in the plan.
getFlightPhase()
getFlightPhase(
planIndex
):VerticalFlightPhase
Defined in: src/sdk/autopilot/calculators/VNavPathCalculator.ts:68
Gets and returns the Current Vertical Flight Phase.
Parameters
Parameter | Type | Description |
---|---|---|
planIndex | number | The vertical flight plan index. |
Returns
the VerticalFlightPhase.
getNextConstraintAltitude()
getNextConstraintAltitude(
planIndex
,globalLegIndex
):undefined
|number
Defined in: src/sdk/autopilot/calculators/VNavPathCalculator.ts:92
Gets and returns the next constraint altitude in meters.
Parameters
Parameter | Type | Description |
---|---|---|
planIndex | number | The vertical flight plan index. |
globalLegIndex | number | The global index of the leg for which to get the next constraint. |
Returns
undefined
| number
The next constraint altitude in meters or undefined
if there is no next constraint.
getNextRestrictionForFlightPhase()
getNextRestrictionForFlightPhase(
planIndex
,activeLateralLeg
):undefined
|VNavConstraint
Defined in: src/sdk/autopilot/calculators/VNavPathCalculator.ts:102
Gets the next altitude limit for the current phase of flight. (used to calculate the required VS and is not always the next constraint) In descent, this will return the next above altitude in the vertical plan. In climb, this will return the next below altitude in the vertical plan.
Parameters
Parameter | Type | Description |
---|---|---|
planIndex | number | The vertical flight plan index. |
activeLateralLeg | number | The current active lateral leg. |
Returns
undefined
| VNavConstraint
The VNavConstraint not to exceed appropriate to the current phase of flight, or undefined if one does not exist.
getTargetAltitude()
getTargetAltitude(
planIndex
,globalLegIndex
):undefined
|number
Defined in: src/sdk/autopilot/calculators/VNavPathCalculator.ts:61
Gets the VNAV target altitude for a flight plan leg.
Parameters
Parameter | Type | Description |
---|---|---|
planIndex | number | The flight plan index. |
globalLegIndex | number | The global index of the flight plan leg. |
Returns
undefined
| number
The VNAV target altitude for the specified flight plan leg, or undefined
if none exists.
getTargetConstraint()
getTargetConstraint(
planIndex
,globalLegIndex
):undefined
|VNavConstraint
Defined in: src/sdk/autopilot/calculators/VNavPathCalculator.ts:53
Gets the VNAV constraint defining the target VNAV altitude for a flight plan leg.
Parameters
Parameter | Type | Description |
---|---|---|
planIndex | number | The flight plan index. |
globalLegIndex | number | The global index of the flight plan leg. |
Returns
undefined
| VNavConstraint
The VNAV constraint defining the target VNAV altitude for the specified flight plan leg, or undefined
if one could not be found.
getTargetConstraintIndex()
getTargetConstraintIndex(
planIndex
,globalLegIndex
):number
Defined in: src/sdk/autopilot/calculators/VNavPathCalculator.ts:44
Gets the index of the VNAV constraint defining the target VNAV altitude for a flight plan leg.
Parameters
Parameter | Type | Description |
---|---|---|
planIndex | number | The flight plan index. |
globalLegIndex | number | The global index of the flight plan leg. |
Returns
number
The index of the VNAV constraint defining the target VNAV altitude for the specified flight plan leg, or
-1
if one could not be found.
getVerticalFlightPlan()
getVerticalFlightPlan(
planIndex
):VerticalFlightPlan
Defined in: src/sdk/autopilot/calculators/VNavPathCalculator.ts:28
Gets a vertical flight plan by index, or throws not found if the plan does not exist.
Parameters
Parameter | Type | Description |
---|---|---|
planIndex | number | The vertical flight plan index. |
Returns
The requested vertical flight plan.
Throws
Not found if the flight plan index is not valid.
requestPathCompute()
requestPathCompute(
planIndex
):boolean
Defined in: src/sdk/autopilot/calculators/VNavPathCalculator.ts:123
Request an out-of-cycle path computation for a specified vertical flight plan.
Parameters
Parameter | Type | Description |
---|---|---|
planIndex | number | The vertical flight plan index. |
Returns
boolean
Whether or not the computation was completed successfully.