Skip to main content

Class: WT21FlightPlanRouteLoader

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21FlightPlanRouteLoader.ts:9

WTLineFlightPlanRouteLoader for the WT12

Extends

Constructors

Constructor

new WT21FlightPlanRouteLoader(fms): WT21FlightPlanRouteLoader

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21FlightPlanRouteLoader.ts:11

Parameters

ParameterType
fmsWT21Fms

Returns

WT21FlightPlanRouteLoader

Inherit Doc

Overrides

WTLineFlightPlanRouteLoader.constructor

Properties

fms

protected readonly fms: WT21Fms

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21FlightPlanRouteLoader.ts:11

The FMS containing the primary flight plan to which the loader loads flight plan routes.

Inherited from

WTLineFlightPlanRouteLoader.fms

Methods

awaitLoad()

awaitLoad(): Promise<void>

Defined in: wtlinesdk/fms/WTLineFlightPlanRouteLoader.ts:50

Waits until this loader is finished with any in-progress operation to load a flight plan route. If there is no such operation, then the returned Promise is fulfilled immediately. The returned Promise is guaranteed to never be rejected.

Returns

Promise<void>

Inherited from

WTLineFlightPlanRouteLoader.awaitLoad


cancelLoad()

cancelLoad(): Promise<void>

Defined in: wtlinesdk/fms/WTLineFlightPlanRouteLoader.ts:73

Stops any in-progress operation by this loader to load a flight plan route.

Returns

Promise<void>

A Promise which is fulfilled after the in-progress operation to load a flight plan route at the time this method is called has been stopped. If there is no in-progress operation, then the Promise is fulfilled immediately. The returned Promise is guaranteed to never be rejected.

Inherited from

WTLineFlightPlanRouteLoader.cancelLoad


isLoadInProgress()

isLoadInProgress(): boolean

Defined in: wtlinesdk/fms/WTLineFlightPlanRouteLoader.ts:41

Checks whether this loader is currently loading a flight plan route.

Returns

boolean

Whether this loader is currently loading a flight plan route.

Inherited from

WTLineFlightPlanRouteLoader.isLoadInProgress


loadRoute()

loadRoute(route, exec): Promise<boolean>

Defined in: wtlinesdk/fms/WTLineFlightPlanRouteLoader.ts:63

Loads a flight plan route. This will preempt any existing in-progress route-loading operation.

Parameters

ParameterTypeDescription
route{ __Type: "JS_FlightPlanRoute"; approach: { __Type: "JS_ApproachIdentifier"; runway: { __Type: "JS_RunwayIdentifier"; designator: string; number: string; }; suffix: string; type: string; }; approachTransition: string; approachVfrPattern: { __Type: "JS_VfrPatternProcedure"; altitude: number; distance: number; isLeftTraffic: boolean; type: FlightPlanRouteVfrPatternApproachType; }; arrival: string; arrivalTransition: string; cruiseAltitude: null | { __Type: "JS_FlightAltitude"; altitude: number; isFlightLevel: boolean; }; departure: string; departureAirport: { __Type: "JS_ICAO"; airport: string; ident: string; region: string; type: string; }; departureRunway: { __Type: "JS_RunwayIdentifier"; designator: string; number: string; }; departureTransition: string; departureVfrPattern: { __Type: "JS_VfrPatternProcedure"; altitude: number; distance: number; isLeftTraffic: boolean; type: FlightPlanRouteVfrPatternDepartureType; }; destinationAirport: { __Type: "JS_ICAO"; airport: string; ident: string; region: string; type: string; }; destinationRunway: { __Type: "JS_RunwayIdentifier"; designator: string; number: string; }; enroute: readonly object[]; isVfr: boolean; }The flight plan route to load.
route.__Type"JS_FlightPlanRoute"Coherent C++ object binding type.
route.approach{ __Type: "JS_ApproachIdentifier"; runway: { __Type: "JS_RunwayIdentifier"; designator: string; number: string; }; suffix: string; type: string; }This route's approach procedure.
route.approach.__Type"JS_ApproachIdentifier"Coherent C++ object binding type.
route.approach.runway{ __Type: "JS_RunwayIdentifier"; designator: string; number: string; }The approach's associated runway.
route.approach.runway.__Type"JS_RunwayIdentifier"Coherent C++ object binding type.
route.approach.runway.designatorstringThe designator of the runway.
route.approach.runway.numberstringThe number of the runway.
route.approach.suffixstringThe suffix of the approach.
route.approach.typestringThe type name of the approach.
route.approachTransitionstringThe name of this route's approach procedure transition.
route.approachVfrPattern{ __Type: "JS_VfrPatternProcedure"; altitude: number; distance: number; isLeftTraffic: boolean; type: FlightPlanRouteVfrPatternApproachType; }This route's VFR traffic pattern approach procedure.
route.approachVfrPattern.__Type"JS_VfrPatternProcedure"Coherent C++ object binding type.
route.approachVfrPattern.altitudenumberThe pattern altitude, in feet AGL.
route.approachVfrPattern.distancenumberThe pattern leg distance, in nautical miles.
route.approachVfrPattern.isLeftTrafficbooleanWhether the pattern uses a left-hand traffic pattern (true) instead of a right-hand traffic pattern (false).
route.approachVfrPattern.typeFlightPlanRouteVfrPatternApproachTypeThe selected pattern type.
route.arrivalstringThe name of this route's arrival procedure.
route.arrivalTransitionstringThe name of this route's arrival procedure enroute transition.
route.cruiseAltitudenull | { __Type: "JS_FlightAltitude"; altitude: number; isFlightLevel: boolean; }This route's cruise altitude.
route.departurestringThe name of this route's departure procedure.
route.departureAirport{ __Type: "JS_ICAO"; airport: string; ident: string; region: string; type: string; }The ICAO of this route's departure airport.
route.departureAirport.__Type"JS_ICAO"Coherent C++ object binding type.
route.departureAirport.airportstringThe ident of the facility's associated airport.
route.departureAirport.identstringThe facility's ident.
route.departureAirport.regionstringThe facility's region code.
route.departureAirport.typestringThe facility's type.
route.departureRunway{ __Type: "JS_RunwayIdentifier"; designator: string; number: string; }This route's departure runway.
route.departureRunway.__Type"JS_RunwayIdentifier"Coherent C++ object binding type.
route.departureRunway.designatorstringThe designator of the runway.
route.departureRunway.numberstringThe number of the runway.
route.departureTransitionstringThe name of this route's departure procedure enroute transition.
route.departureVfrPattern{ __Type: "JS_VfrPatternProcedure"; altitude: number; distance: number; isLeftTraffic: boolean; type: FlightPlanRouteVfrPatternDepartureType; }This route's VFR traffic pattern departure procedure.
route.departureVfrPattern.__Type"JS_VfrPatternProcedure"Coherent C++ object binding type.
route.departureVfrPattern.altitudenumberThe pattern altitude, in feet AGL.
route.departureVfrPattern.distancenumberThe pattern leg distance, in nautical miles.
route.departureVfrPattern.isLeftTrafficbooleanWhether the pattern uses a left-hand traffic pattern (true) instead of a right-hand traffic pattern (false).
route.departureVfrPattern.typeFlightPlanRouteVfrPatternDepartureTypeThe selected pattern type.
route.destinationAirport{ __Type: "JS_ICAO"; airport: string; ident: string; region: string; type: string; }The ICAO of this route's destination airport.
route.destinationAirport.__Type"JS_ICAO"Coherent C++ object binding type.
route.destinationAirport.airportstringThe ident of the facility's associated airport.
route.destinationAirport.identstringThe facility's ident.
route.destinationAirport.regionstringThe facility's region code.
route.destinationAirport.typestringThe facility's type.
route.destinationRunway{ __Type: "JS_RunwayIdentifier"; designator: string; number: string; }This route's destination runway.
route.destinationRunway.__Type"JS_RunwayIdentifier"Coherent C++ object binding type.
route.destinationRunway.designatorstringThe designator of the runway.
route.destinationRunway.numberstringThe number of the runway.
route.enroutereadonly object[]This route's enroute legs.
route.isVfrbooleanWhether this route is classified as VFR.
execbooleanWhether to execute the changes to the flight plan after the route is loaded.

Returns

Promise<boolean>

A Promise which is fulfilled when the loading operation ends. The fulfillment value reports whether the operation completed successfully without being cancelled. The returned Promise is guaranteed to never be rejected.

Inherited from

WTLineFlightPlanRouteLoader.loadRoute


setCruiseAltitude()

setCruiseAltitude(mainPlanIndex, cruiseAlt): void

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21FlightPlanRouteLoader.ts:16

Sets the cruising altitude for a particular flight plan

Parameters

ParameterTypeDescription
mainPlanIndexWTLineLegacyMainFlightPlanthe main flight plan index to set the cruising altitude for
cruiseAltnumberthe cruising altitude value, in feet

Returns

void

Overrides

WTLineFlightPlanRouteLoader.setCruiseAltitude