Interface: VNavPathCalculator
VNav Path Calculator Interface
Implemented by
Properties
flightPathAngle
• flightPathAngle: number
The default FPA for this path calculator
Defined in
src/sdk/autopilot/calculators/VNavPathCalculator.ts:11
maxFlightPathAngle
• maxFlightPathAngle: number
The maximum FPA allowed for path calculator
Defined in
src/sdk/autopilot/calculators/VNavPathCalculator.ts:14
planBuilt
• Readonly planBuilt: ReadonlySubEvent<VNavPathCalculator, number>
An event fired when a vertical plan has been built or rebuilt, with the index of the plan as the event data.
Defined in
src/sdk/autopilot/calculators/VNavPathCalculator.ts:17
vnavCalculated
• Readonly vnavCalculated: ReadonlySubEvent<VNavPathCalculator, number>
An event fired when a path has been calculated, with the index of the plan as the event data.
Defined in
src/sdk/autopilot/calculators/VNavPathCalculator.ts:20
Methods
activateVerticalDirect
▸ activateVerticalDirect(planIndex, constraintGlobalLegIndex): void
Activates a vertical direct to a constraint index.
Parameters
| Name | Type | Description |
|---|---|---|
planIndex | number | The vertical flight plan index. |
constraintGlobalLegIndex | number | The global leg index of the constraint to go direct to. |
Returns
void
Defined in
src/sdk/autopilot/calculators/VNavPathCalculator.ts:116
createVerticalPlan
▸ createVerticalPlan(planIndex): VerticalFlightPlan
Creates an empty vertical plan at a specified index.
Parameters
| Name | Type | Description |
|---|---|---|
planIndex | number | The Vertical Plan Index to create. |
Returns
The newly created Vertical Plan.
Defined in
src/sdk/autopilot/calculators/VNavPathCalculator.ts:35
getCurrentConstraintAltitude
▸ getCurrentConstraintAltitude(planIndex, globalLegIndex): undefined | number
Gets and returns the current constraint altitude in meters.
Parameters
| Name | 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.
Defined in
src/sdk/autopilot/calculators/VNavPathCalculator.ts:76
getCurrentConstraintDetails
▸ getCurrentConstraintDetails(planIndex, globalLegIndex): AltitudeConstraintDetails
Gets and returns the current constraint details.
Parameters
| Name | Type | Description |
|---|---|---|
planIndex | number | The vertical flight plan index. |
globalLegIndex | number | is the global leg index to check. |
Returns
the VNavConstraintDetails.
Defined in
src/sdk/autopilot/calculators/VNavPathCalculator.ts:84
getFirstDescentConstraintAltitude
▸ getFirstDescentConstraintAltitude(planIndex): undefined | number
Gets the first VNAV Constraint Altitude.
Parameters
| Name | Type | Description |
|---|---|---|
planIndex | number | The vertical flight plan index. |
Returns
undefined | number
The first VNAV constraint altitude in the plan.
Defined in
src/sdk/autopilot/calculators/VNavPathCalculator.ts:109
getFlightPhase
▸ getFlightPhase(planIndex): VerticalFlightPhase
Gets and returns the Current Vertical Flight Phase.
Parameters
| Name | Type | Description |
|---|---|---|
planIndex | number | The vertical flight plan index. |
Returns
the VerticalFlightPhase.
Defined in
src/sdk/autopilot/calculators/VNavPathCalculator.ts:68
getNextConstraintAltitude
▸ getNextConstraintAltitude(planIndex, globalLegIndex): undefined | number
Gets and returns the next constraint altitude in meters.
Parameters
| Name | 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.
Defined in
src/sdk/autopilot/calculators/VNavPathCalculator.ts:92
getNextRestrictionForFlightPhase
▸ getNextRestrictionForFlightPhase(planIndex, activeLateralLeg): undefined | VNavConstraint
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
| Name | 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.
Defined in
src/sdk/autopilot/calculators/VNavPathCalculator.ts:102
getTargetAltitude
▸ getTargetAltitude(planIndex, globalLegIndex): undefined | number
Gets the VNAV target altitude for a flight plan leg.
Parameters
| Name | 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.
Defined in
src/sdk/autopilot/calculators/VNavPathCalculator.ts:61
getTargetConstraint
▸ getTargetConstraint(planIndex, globalLegIndex): undefined | VNavConstraint
Gets the VNAV constraint defining the target VNAV altitude for a flight plan leg.
Parameters
| Name | 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.
Defined in
src/sdk/autopilot/calculators/VNavPathCalculator.ts:53
getTargetConstraintIndex
▸ getTargetConstraintIndex(planIndex, globalLegIndex): number
Gets the index of the VNAV constraint defining the target VNAV altitude for a flight plan leg.
Parameters
| Name | 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.
Defined in
src/sdk/autopilot/calculators/VNavPathCalculator.ts:44
getVerticalFlightPlan
▸ getVerticalFlightPlan(planIndex): VerticalFlightPlan
Gets a vertical flight plan by index, or throws not found if the plan does not exist.
Parameters
| Name | 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.
Defined in
src/sdk/autopilot/calculators/VNavPathCalculator.ts:28
requestPathCompute
▸ requestPathCompute(planIndex): boolean
Request an out-of-cycle path computation for a specified vertical flight plan.
Parameters
| Name | Type | Description |
|---|---|---|
planIndex | number | The vertical flight plan index. |
Returns
boolean
Whether or not the computation was completed successfully.
Defined in
src/sdk/autopilot/calculators/VNavPathCalculator.ts:123