Class: BottomTargetPathCalculator
Handles the calculation of the VNAV flight path for VNAV Implemetations that use only the bottom altitude of each constraint.
Deprecated
Implements
Constructors
constructor
• new BottomTargetPathCalculator(bus, flightPlanner, primaryPlanIndex, defaultFpa, defaultMaxFpa): BottomTargetPathCalculator
Creates an instance of the VNavPathCalculator.
Parameters
| Name | Type | Description |
|---|---|---|
bus | EventBus | The EventBus to use with this instance. |
flightPlanner | FlightPlanner<any> | The flight planner to use with this instance. |
primaryPlanIndex | number | The primary flight plan index to use to calculate a path from. |
defaultFpa | number | The default FPA for this path calculator. |
defaultMaxFpa | number | The default maximum FPA value for this path calculator. |
Returns
Defined in
src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:49
Properties
flightPathAngle
• flightPathAngle: number
The default or user set FPA for this path calculator
Implementation of
VNavPathCalculator.flightPathAngle
Defined in
src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:25
maxFlightPathAngle
• maxFlightPathAngle: number
The maximum FPA allowed for path calculator
Implementation of
VNavPathCalculator.maxFlightPathAngle
Defined in
src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:28
planBuilt
• Readonly planBuilt: ReadonlySubEvent<BottomTargetPathCalculator, number>
An event fired when a vertical plan has been built or rebuilt, with the index of the plan as the event data.
Implementation of
Defined in
src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:34
vnavCalculated
• Readonly vnavCalculated: ReadonlySubEvent<BottomTargetPathCalculator, number>
An event fired when a path has been calculated, with the index of the plan as the event data.
Implementation of
VNavPathCalculator.vnavCalculated
Defined in
src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:37
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
Implementation of
VNavPathCalculator.activateVerticalDirect
Defined in
src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:248
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.
Implementation of
VNavPathCalculator.createVerticalPlan
Defined in
src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:90
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.
Implementation of
VNavPathCalculator.getCurrentConstraintAltitude
Defined in
src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:173
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.
Implementation of
VNavPathCalculator.getCurrentConstraintDetails
Defined in
src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:186
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.
Implementation of
VNavPathCalculator.getFirstDescentConstraintAltitude
Defined in
src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:646
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.
Implementation of
VNavPathCalculator.getFlightPhase
Defined in
src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:154
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.
Implementation of
VNavPathCalculator.getNextConstraintAltitude
Defined in
src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:201
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.
Implementation of
VNavPathCalculator.getNextRestrictionForFlightPhase
Defined in
src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:209
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.
Implementation of
VNavPathCalculator.getTargetAltitude
Defined in
src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:149
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.
Implementation of
VNavPathCalculator.getTargetConstraint
Defined in
src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:143
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.
Implementation of
VNavPathCalculator.getTargetConstraintIndex
Defined in
src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:120
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.
Implementation of
VNavPathCalculator.getVerticalFlightPlan
Defined in
src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:81
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.
Implementation of
VNavPathCalculator.requestPathCompute
Defined in
src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:822
setCurrentAlongLegDistance
▸ setCurrentAlongLegDistance(planIndex, distance): void
Parameters
| Name | Type |
|---|---|
planIndex | number |
distance | number |
Returns
void
Inherit Doc
Defined in
src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:113