Skip to main content

Class: FlightPlanRouteManager

Defined in: src/sdk/flightplan/FlightPlanRouteManager.ts:25

A manager for working with flight plan routes. The manager can be used to send or retrieve routes. It also automatically publishes the event bus topics defined in FlightPlanRouteEvents in response to events related to flight plan routes.

Properties​

avionicsRouteRequested​

readonly avionicsRouteRequested: ReadonlySubEvent<FlightPlanRouteManager, number>

Defined in: src/sdk/flightplan/FlightPlanRouteManager.ts:40

An event that fires when an avionics route is requested. The event data is the ID of the request.

avionicsRouteRequestResponse​

readonly avionicsRouteRequestResponse: ReadonlySubEvent<FlightPlanRouteManager, Readonly<FlightPlanRouteAvionicsRequestResponse>>

Defined in: src/sdk/flightplan/FlightPlanRouteManager.ts:44

An event that fires when a response to an avionics route request is received. The event data is the response.

efbRoute​

readonly efbRoute: Subscribable<{ __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; }>

Defined in: src/sdk/flightplan/FlightPlanRouteManager.ts:32

The current EFB flight plan route.

pendingAvionicsRouteRequests​

readonly pendingAvionicsRouteRequests: Subscribable<readonly number[]>

Defined in: src/sdk/flightplan/FlightPlanRouteManager.ts:51

An array of the IDs of all avionics route requests that have not received a response yet, in order of decreasing age.

syncedAvionicsRoute​

readonly syncedAvionicsRoute: Subscribable<null | { __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; }>

Defined in: src/sdk/flightplan/FlightPlanRouteManager.ts:36

The most recent synced avionics flight plan route.

Methods​

fileRouteWithAtc()​

fileRouteWithAtc(route): Promise<void>

Defined in: src/sdk/flightplan/FlightPlanRouteManager.ts:143

Files a route with the sim's ATC service.

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 route to file.
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.

Returns​

Promise<void>

A Promise which is fulfilled when the route has been scheduled to be delivered to the ATC service. This does not guarantee that the route will have been filed when the Promise is fulfilled.

getAtcRoute()​

getAtcRoute(): Promise<FlightPlanRoute>

Defined in: src/sdk/flightplan/FlightPlanRouteManager.ts:151

Gets the filed ATC route.

Returns​

Promise<FlightPlanRoute>

A Promise which is fulfilled with the filed ATC route once it has been retrieved.

getEfbRoute()​

getEfbRoute(): Promise<FlightPlanRoute>

Defined in: src/sdk/flightplan/FlightPlanRouteManager.ts:93

Gets the saved EFB route.

Returns​

Promise<FlightPlanRoute>

A Promise which is fulfilled with the saved EFB route once it has been retrieved.

replyToAvionicsRouteRequest()​

replyToAvionicsRouteRequest(requestId, route): Promise<void>

Defined in: src/sdk/flightplan/FlightPlanRouteManager.ts:133

Reply to an avionics route request with a flight plan route.

Parameters​

ParameterTypeDescription
requestIdnumberThe ID of the request to which to reply.
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 route to send as the reply.
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.

Returns​

Promise<void>

A Promise which is fulfilled when the route has been scheduled to be delivered to reply listeners. This does not guarantee that any listeners will have received the reply when the Promise is fulfilled.

requestAvionicsRoute()​

requestAvionicsRoute(): Promise<number>

Defined in: src/sdk/flightplan/FlightPlanRouteManager.ts:122

Sends an avionics route request to all request listeners.

Returns​

Promise<number>

A Promise which is fulfilled with the ID of the request when the request has been scheduled to be delivered to request listeners. This does not guarantee that any listeners will have received the request when the Promise is fulfilled.

saveEfbRoute()​

saveEfbRoute(route): Promise<void>

Defined in: src/sdk/flightplan/FlightPlanRouteManager.ts:102

Saves a route as the EFB route.

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 route to save.
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.

Returns​

Promise<void>

A Promise which is fulfilled when the route has been saved as the EFB route.

sendRouteToAvionics()​

sendRouteToAvionics(route): Promise<void>

Defined in: src/sdk/flightplan/FlightPlanRouteManager.ts:112

Sends a flight plan route to avionics for sync.

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 route to send.
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.

Returns​

Promise<void>

A Promise which is fulfilled when the route has been scheduled to be delivered to listeners. This does not guarantee that any listeners will have received the route when the Promise is fulfilled.

sendRouteToEfb()​

sendRouteToEfb(route): Promise<void>

Defined in: src/sdk/flightplan/FlightPlanRouteManager.ts:85

Sends a flight plan route to the EFB.

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 route to send.
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.

Returns​

Promise<void>

A Promise which is fulfilled when the route has been scheduled to be delivered to the EFB. This does not guarantee that the EFB will have received the route when the Promise is fulfilled.

getManager()​

static getManager(): Promise<FlightPlanRouteManager>

Defined in: src/sdk/flightplan/FlightPlanRouteManager.ts:75

Gets an instance of FlightPlanRouteManager.

Returns​

Promise<FlightPlanRouteManager>

A Promise which is fulfilled with an instance of FlightPlanRouteManager when the manager is ready.