Skip to main content

Class: BottomTargetPathCalculator

Defined in: src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:19

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

Defined in: src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:49

Creates an instance of the VNavPathCalculator.

Parameters

ParameterTypeDescription
busEventBusThe EventBus to use with this instance.
flightPlannerFlightPlannerThe flight planner to use with this instance.
primaryPlanIndexnumberThe primary flight plan index to use to calculate a path from.
defaultFpanumberThe default FPA for this path calculator.
defaultMaxFpanumberThe default maximum FPA value for this path calculator.

Returns

BottomTargetPathCalculator

Properties

flightPathAngle

flightPathAngle: number

Defined in: src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:25

The default or user set FPA for this path calculator

Implementation of

VNavPathCalculator.flightPathAngle


maxFlightPathAngle

maxFlightPathAngle: number

Defined in: src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:28

The maximum FPA allowed for path calculator

Implementation of

VNavPathCalculator.maxFlightPathAngle


planBuilt

readonly planBuilt: ReadonlySubEvent<this, number>

Defined in: src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:34

An event fired when a vertical plan has been built or rebuilt, with the index of the plan as the event data.

Implementation of

VNavPathCalculator.planBuilt


vnavCalculated

readonly vnavCalculated: ReadonlySubEvent<this, number>

Defined in: src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:37

An event fired when a path has been calculated, with the index of the plan as the event data.

Implementation of

VNavPathCalculator.vnavCalculated

Methods

activateVerticalDirect()

activateVerticalDirect(planIndex, constraintGlobalLegIndex): void

Defined in: src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:248

Activates a vertical direct to a constraint index.

Parameters

ParameterTypeDescription
planIndexnumberThe vertical flight plan index.
constraintGlobalLegIndexnumberThe global leg index of the constraint to go direct to.

Returns

void

Implementation of

VNavPathCalculator.activateVerticalDirect


createVerticalPlan()

createVerticalPlan(planIndex): VerticalFlightPlan

Defined in: src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:90

Creates an empty vertical plan at a specified index.

Parameters

ParameterTypeDescription
planIndexnumberThe Vertical Plan Index to create.

Returns

VerticalFlightPlan

The newly created Vertical Plan.

Implementation of

VNavPathCalculator.createVerticalPlan


getCurrentConstraintAltitude()

getCurrentConstraintAltitude(planIndex, globalLegIndex): undefined | number

Defined in: src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:173

Gets and returns the current constraint altitude in meters.

Parameters

ParameterTypeDescription
planIndexnumberThe vertical flight plan index.
globalLegIndexnumberThe 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


getCurrentConstraintDetails()

getCurrentConstraintDetails(planIndex, globalLegIndex): AltitudeConstraintDetails

Defined in: src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:186

Gets and returns the current constraint details.

Parameters

ParameterTypeDescription
planIndexnumberThe vertical flight plan index.
globalLegIndexnumberis the global leg index to check.

Returns

AltitudeConstraintDetails

the VNavConstraintDetails.

Implementation of

VNavPathCalculator.getCurrentConstraintDetails


getFirstDescentConstraintAltitude()

getFirstDescentConstraintAltitude(planIndex): undefined | number

Defined in: src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:646

Gets the first VNAV Constraint Altitude.

Parameters

ParameterTypeDescription
planIndexnumberThe vertical flight plan index.

Returns

undefined | number

The first VNAV constraint altitude in the plan.

Implementation of

VNavPathCalculator.getFirstDescentConstraintAltitude


getFlightPhase()

getFlightPhase(planIndex): VerticalFlightPhase

Defined in: src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:154

Gets and returns the Current Vertical Flight Phase.

Parameters

ParameterTypeDescription
planIndexnumberThe vertical flight plan index.

Returns

VerticalFlightPhase

the VerticalFlightPhase.

Implementation of

VNavPathCalculator.getFlightPhase


getNextConstraintAltitude()

getNextConstraintAltitude(planIndex, globalLegIndex): undefined | number

Defined in: src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:201

Gets and returns the next constraint altitude in meters.

Parameters

ParameterTypeDescription
planIndexnumberThe vertical flight plan index.
globalLegIndexnumberThe 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


getNextRestrictionForFlightPhase()

getNextRestrictionForFlightPhase(planIndex, activeLateralLeg): undefined | VNavConstraint

Defined in: src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:209

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

ParameterTypeDescription
planIndexnumberThe vertical flight plan index.
activeLateralLegnumberThe 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


getTargetAltitude()

getTargetAltitude(planIndex, globalLegIndex): undefined | number

Defined in: src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:149

Gets the VNAV target altitude for a flight plan leg.

Parameters

ParameterTypeDescription
planIndexnumberThe flight plan index.
globalLegIndexnumberThe 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


getTargetConstraint()

getTargetConstraint(planIndex, globalLegIndex): undefined | VNavConstraint

Defined in: src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:143

Gets the VNAV constraint defining the target VNAV altitude for a flight plan leg.

Parameters

ParameterTypeDescription
planIndexnumberThe flight plan index.
globalLegIndexnumberThe 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


getTargetConstraintIndex()

getTargetConstraintIndex(planIndex, globalLegIndex): number

Defined in: src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:120

Gets the index of the VNAV constraint defining the target VNAV altitude for a flight plan leg.

Parameters

ParameterTypeDescription
planIndexnumberThe flight plan index.
globalLegIndexnumberThe 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


getVerticalFlightPlan()

getVerticalFlightPlan(planIndex): VerticalFlightPlan

Defined in: src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:81

Gets a vertical flight plan by index, or throws not found if the plan does not exist.

Parameters

ParameterTypeDescription
planIndexnumberThe vertical flight plan index.

Returns

VerticalFlightPlan

The requested vertical flight plan.

Throws

Not found if the flight plan index is not valid.

Implementation of

VNavPathCalculator.getVerticalFlightPlan


requestPathCompute()

requestPathCompute(planIndex): boolean

Defined in: src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:822

Request an out-of-cycle path computation for a specified vertical flight plan.

Parameters

ParameterTypeDescription
planIndexnumberThe vertical flight plan index.

Returns

boolean

Whether or not the computation was completed successfully.

Implementation of

VNavPathCalculator.requestPathCompute


setCurrentAlongLegDistance()

setCurrentAlongLegDistance(planIndex, distance): void

Defined in: src/sdk/autopilot/calculators/BottomTargetPathCalculator.ts:113

Parameters

ParameterType
planIndexnumber
distancenumber

Returns

void

Inherit Doc