Class: GarminFlightPlanRouteSyncManager
Defined in: src/garminsdk/flightplan/GarminFlightPlanRouteSyncManager.ts:10
A manager for syncing Garmin flight plan routes to and from the sim. The manager supports automatically replying to avionics route requests and can be used to manually or automatically load synced flight plan routes.
Constructors
Constructor
new GarminFlightPlanRouteSyncManager():
GarminFlightPlanRouteSyncManager
Defined in: src/garminsdk/flightplan/GarminFlightPlanRouteSyncManager.ts:35
Creates a new instance of GarminFlightPlanRouteSyncManager. The manager is created in an uninitialized state and must be initialized before it can perform any functions.
Returns
GarminFlightPlanRouteSyncManager
Methods
awaitInit()
awaitInit():
Promise<void>
Defined in: src/garminsdk/flightplan/GarminFlightPlanRouteSyncManager.ts:63
Waits until this manager is initialized.
Returns
Promise<void>
A Promise which is fulfilled when this manager is initialized, or rejected if this manager is destroyed before it is initialized.
cancelLoad()
cancelLoad():
Promise<void>
Defined in: src/garminsdk/flightplan/GarminFlightPlanRouteSyncManager.ts:309
Stops any in-progress operation to load a synced route. This method has no effect if this manager is not initialized.
Returns
Promise<void>
A Promise which is fulfilled after the in-progress operation to load a synced route into the primary flight plan at the time this method is called has been stopped. If there are no in-progress operations, then the Promise is fulfilled immediately.
Throws
Error if this manager has been destroyed.
cancelReply()
cancelReply():
Promise<void>
Defined in: src/garminsdk/flightplan/GarminFlightPlanRouteSyncManager.ts:238
Stops any in-progress operation to reply to avionics route requests. This method has no effect if this manager is not initialized.
Returns
Promise<void>
A Promise which is fulfilled after the in-progress operation to reply to avionics route requests at the time this method is called has been stopped. If there are no in-progress operations, then the Promise is fulfilled immediately.
Throws
Error if this manager has been destroyed.
destroy()
destroy():
void
Defined in: src/garminsdk/flightplan/GarminFlightPlanRouteSyncManager.ts:439
Destroys this manager.
Returns
void
init()
init(
manager,loader,provider):void
Defined in: src/garminsdk/flightplan/GarminFlightPlanRouteSyncManager.ts:76
Initializes this manager. Once initialized, this manager will automatically reply to avionics route requests and can be used to manually or automatically load synced avionics routes.
Parameters
| Parameter | Type | Description |
|---|---|---|
manager | FlightPlanRouteManager | A flight plan route manager. |
loader | GarminFlightPlanRouteLoader | A flight plan route loader. The loader will be used by this manager to load flight plan routes. |
provider | GarminFlightPlanRouteProvider | A flight plan route provider. The provider will be used by this manager to retrieve flight plan routes with which to reply to avionics route requests. |
Returns
void
Throws
Error if this manager has been destroyed.
isAutoReplying()
isAutoReplying():
boolean
Defined in: src/garminsdk/flightplan/GarminFlightPlanRouteSyncManager.ts:103
Checks whether this manager is currently set to automatically reply to avionics route requests.
Returns
boolean
Whether this manager is currently set to automatically reply to avionics route requests.
isAutoSyncing()
isAutoSyncing():
boolean
Defined in: src/garminsdk/flightplan/GarminFlightPlanRouteSyncManager.ts:111
Checks whether this manager is currently set to automatically load synced avionics flight plan routes.
Returns
boolean
Whether this manager is currently set to automatically load synced avionics flight plan routes.
isInit()
isInit():
boolean
Defined in: src/garminsdk/flightplan/GarminFlightPlanRouteSyncManager.ts:54
Checks whether this manager is initialized.
Returns
boolean
Whether this manager is initialized.
loadFromSyncedRoute()
loadFromSyncedRoute():
Promise<boolean>
Defined in: src/garminsdk/flightplan/GarminFlightPlanRouteSyncManager.ts:263
Loads the most recent synced avionics flight plan route, if one exists. This will preempt any existing in-progress route-loading operation. This method has no effect if this manager is not initialized.
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.
Throws
Error if this manager has been destroyed.
loadRoute()
loadRoute(
route):Promise<boolean>
Defined in: src/garminsdk/flightplan/GarminFlightPlanRouteSyncManager.ts:289
Loads a flight plan route. This will preempt any existing in-progress route-loading operation. This method has no effect if this manager is not initialized.
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.
Throws
Error if this manager has been destroyed.
replyToAllPendingRequests()
replyToAllPendingRequests():
void
Defined in: src/garminsdk/flightplan/GarminFlightPlanRouteSyncManager.ts:199
Replies to all pending avionics route requests. The reply operations are handled asynchronously and so are not guaranteed to have completed by the time this method returns. This method has no effect if this manager is not initialized.
Returns
void
Throws
Error if this manager has been destroyed.
replyToRequest()
replyToRequest(
requestId):void
Defined in: src/garminsdk/flightplan/GarminFlightPlanRouteSyncManager.ts:218
Replies to a specific avionics route request. The reply operation is handled asynchronously and so is not guaranteed to have completed by the time this method returns. This method has no effect if this manager is not initialized.
Parameters
| Parameter | Type | Description |
|---|---|---|
requestId | number | The ID of the request to which to reply. |
Returns
void
Throws
Error if this manager has been destroyed.
startAutoReply()
startAutoReply():
void
Defined in: src/garminsdk/flightplan/GarminFlightPlanRouteSyncManager.ts:121
Starts automatically replying to avionics route requests. This will not initiate replies to any existing pending requests; only requests received after this method is called will receive an automatic reply. This method has no effect if this manager is not initialized.
Returns
void
Throws
Error if this manager has been destroyed.
startAutoSync()
startAutoSync():
void
Defined in: src/garminsdk/flightplan/GarminFlightPlanRouteSyncManager.ts:160
Starts automatically loading any synced avionics flight plan routes. After automatic sync has started, this manager will wait until the next time a new avionics route is synced before loading the synced route. This method has no effect if this manager is not initialized.
Returns
void
Throws
Error if this manager has been destroyed.
stopAutoReply()
stopAutoReply():
void
Defined in: src/garminsdk/flightplan/GarminFlightPlanRouteSyncManager.ts:140
Stops automatically replying to avionics route requests. This method does not cancel any reply operation that is already in progress. This method has no effect if this manager is not initialized.
Returns
void
Throws
Error if this manager has been destroyed.
stopAutoSync()
stopAutoSync():
void
Defined in: src/garminsdk/flightplan/GarminFlightPlanRouteSyncManager.ts:179
Stops automatically loading any synced avionics flight plan routes. This method does not cancel any route-loading operation that is already in progress. This method has no effect if this manager is not initialized.
Returns
void
Throws
Error if this manager has been destroyed.