Skip to main content

Class: GarminPrimaryFlightPlanRouteProvider

Defined in: src/garminsdk/flightplan/GarminPrimaryFlightPlanRouteProvider.ts:11

A provider of flight plan routes representing the structure of the primary flight plan of an instance of Fms.

Implements

Constructors

Constructor

new GarminPrimaryFlightPlanRouteProvider(fms): GarminPrimaryFlightPlanRouteProvider

Defined in: src/garminsdk/flightplan/GarminPrimaryFlightPlanRouteProvider.ts:16

Creates a new instance of GarminPrimaryFlightPlanRouteProvider.

Parameters

ParameterTypeDescription
fmsFmsThe FMS containing the primary flight plan from which this provider sources flight plan routes.

Returns

GarminPrimaryFlightPlanRouteProvider

Methods

getRoute()

getRoute(): Promise<{ __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/garminsdk/flightplan/GarminPrimaryFlightPlanRouteProvider.ts:25

Gets a flight plan route representing the structure of the primary flight plan loaded in this provider's Fms instance.

Returns

Promise<{ __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; }>

A Promise which is fulfilled with the flight plan route representing the structure of the primary flight plan loaded in this provider's Fms instance. The returned Promise is guaranteed to never be rejected.

Implementation of

GarminFlightPlanRouteProvider.getRoute