Class: GarminPrimaryFlightPlanRouteLoader

Defined in: src/garminsdk/flightplan/GarminPrimaryFlightPlanRouteLoader.ts:49

A loader of flight plan routes into the primary flight plan of an instance of Fms.

Implements

• GarminFlightPlanRouteLoader

Constructors

Constructor

new GarminPrimaryFlightPlanRouteLoader(fms, options?): GarminPrimaryFlightPlanRouteLoader

Defined in: src/garminsdk/flightplan/GarminPrimaryFlightPlanRouteLoader.ts:64

Creates a new instance of GarminPrimaryFlightPlanRouteLoader.

Parameters

Parameter	Type	Description
fms	Fms	The FMS containing the primary flight plan to which the loader loads flight plan routes.
options?	Readonly<GarminPrimaryFlightPlanRouteLoaderOptions>	Options with which to configure the loader.

Returns

GarminPrimaryFlightPlanRouteLoader

Methods

awaitLoad()

awaitLoad(): Promise<void>

Defined in: src/garminsdk/flightplan/GarminPrimaryFlightPlanRouteLoader.ts:86

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>

Implementation of

GarminFlightPlanRouteLoader.awaitLoad

---

cancelLoad()

cancelLoad(): Promise<void>

Defined in: src/garminsdk/flightplan/GarminPrimaryFlightPlanRouteLoader.ts:98

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.

Implementation of

GarminFlightPlanRouteLoader.cancelLoad

---

isLoadInProgress()

isLoadInProgress(): boolean

Defined in: src/garminsdk/flightplan/GarminPrimaryFlightPlanRouteLoader.ts:81

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

Returns

boolean

Implementation of

GarminFlightPlanRouteLoader.isLoadInProgress

---

loadRoute()

loadRoute(route): Promise<boolean>

Defined in: src/garminsdk/flightplan/GarminPrimaryFlightPlanRouteLoader.ts:93

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

Parameters

Parameter	Type	Description
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.designator	string	The designator of the runway.
route.approach.runway.number	string	The number of the runway.
route.approach.suffix	string	The suffix of the approach.
route.approach.type	string	The type name of the approach.
route.approachTransition	string	The 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.altitude	number	The pattern altitude, in feet AGL.
route.approachVfrPattern.distance	number	The pattern leg distance, in nautical miles.
route.approachVfrPattern.isLeftTraffic	boolean	Whether the pattern uses a left-hand traffic pattern (true) instead of a right-hand traffic pattern (false).
route.approachVfrPattern.type	FlightPlanRouteVfrPatternApproachType	The selected pattern type.
route.arrival	string	The name of this route's arrival procedure.
route.arrivalTransition	string	The name of this route's arrival procedure enroute transition.
route.cruiseAltitude	null | { __Type: "JS_FlightAltitude"; altitude: number; isFlightLevel: boolean; }	This route's cruise altitude.
route.departure	string	The 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.airport	string	The ident of the facility's associated airport.
route.departureAirport.ident	string	The facility's ident.
route.departureAirport.region	string	The facility's region code.
route.departureAirport.type	string	The 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.designator	string	The designator of the runway.
route.departureRunway.number	string	The number of the runway.
route.departureTransition	string	The 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.altitude	number	The pattern altitude, in feet AGL.
route.departureVfrPattern.distance	number	The pattern leg distance, in nautical miles.
route.departureVfrPattern.isLeftTraffic	boolean	Whether the pattern uses a left-hand traffic pattern (true) instead of a right-hand traffic pattern (false).
route.departureVfrPattern.type	FlightPlanRouteVfrPatternDepartureType	The 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.airport	string	The ident of the facility's associated airport.
route.destinationAirport.ident	string	The facility's ident.
route.destinationAirport.region	string	The facility's region code.
route.destinationAirport.type	string	The 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.designator	string	The designator of the runway.
route.destinationRunway.number	string	The number of the runway.
route.enroute	readonly object[]	This route's enroute legs.
route.isVfr	boolean	Whether this route is classified as VFR.

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.

Implementation of

GarminFlightPlanRouteLoader.loadRoute