Class: G3XFms
A G3X Touch flight management system.
Constructors
constructor
• new G3XFms(isPrimary, bus, flightPlanner, options): G3XFms
Creates a new instance of G3XFms.
Parameters
| Name | Type | Description |
|---|---|---|
isPrimary | boolean | Whether this FMS is the primary instance. Only the primary FMS will execute certain operations that have global effects across the entire airplane. |
bus | EventBus | The event bus. |
flightPlanner | FlightPlanner<"g3x"> | The internal flight planner for the new FMS to use. |
options | Readonly<G3XFmsOptions> | Options with which to configure the FMS. |
Returns
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:92
Properties
facLoader
• Readonly facLoader: FacilityLoader
The facility loader used by this FMS.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:75
flightPlanner
• Readonly flightPlanner: FlightPlanner<"g3x">
The internal flight planner used by this FMS.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:78
internalFms
• Readonly internalFms: Fms<"g3x">
The Garmin FMS instance to which this FMS delegates for its internal flight plan data source.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:72
Methods
activateApproach
▸ activateApproach(isVtf): Promise<void>
Activates the approach that is currently loaded into the internal primary flight plan. Activating the approach will insert the approach legs into the internal primary flight plan and either activate an on-route Direct-To targeting the faf (for non-vectors-to-final approaches) or activate the vectors-to-final leg to the faf (for vectors-to-final approaches).
Parameters
| Name | Type | Description |
|---|---|---|
isVtf | boolean | Whether to activate the approach as a vectors-to-final (VTF) approach. |
Returns
Promise<void>
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:1095
activateLeg
▸ activateLeg(segmentIndex, segmentLegIndex, planIndex?, inhibitImmediateSequence?): void
Activates a flight plan leg for the internal flight plan source.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
segmentIndex | number | undefined | The index of the flight plan segment containing the leg to activate. |
segmentLegIndex | number | undefined | The index of the leg to activate in its containing segment. |
planIndex | number | FmsUtils.PRIMARY_PLAN_INDEX | The index of the flight plan containing the leg to activate. Defaults to the index of the primary flight plan. |
inhibitImmediateSequence | boolean | false | Whether to inhibit immediate automatic sequencing past the activated leg. Defaults to false. |
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:1063
activateNearestLeg
▸ activateNearestLeg(allowMissedApproach?): boolean
Activates the nearest and most applicable leg of the internal primary flight plan.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
allowMissedApproach | boolean | false | Whether to allow activation of missed approach legs. Defaults to false. |
Returns
boolean
Whether a leg was successfully activated.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:1297
addUserFacility
▸ addUserFacility(userFacility): void
Adds a user facility.
Parameters
| Name | Type | Description |
|---|---|---|
userFacility | UserFacility | the facility to add. |
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:455
buildApproachPreviewPlan
▸ buildApproachPreviewPlan(calculator, facility, approachIndex, isVtf): Promise<FlightPlan>
Builds a flight plan to preview an approach procedure that can be loaded into the internal primary flight plan.
Parameters
| Name | Type | Description |
|---|---|---|
calculator | FlightPathCalculator | The flight path calculator to assign to the preview plan. |
facility | AirportFacility | The airport facility containing the published approach on which the VFR approach to preview is based. |
approachIndex | number | The index of the published approach on which the VFR approach to preview is based. |
isVtf | boolean | Whether to preview the approach as a vectors-to-final (VTF) approach. |
Returns
Promise<FlightPlan>
A Promise which will be fulfilled with the preview plan after it has been built.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:1310
canActivateApproach
▸ canActivateApproach(): boolean
Checks whether an approach can be activated. An approach can be activated if and only if the primary flight plan has a non-vectors-to-final approach loaded.
Returns
boolean
Whether an approach can be activated.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:1077
canActivateLeg
▸ canActivateLeg(segmentIndex, segmentLegIndex): boolean
Checks whether a leg in the primary flight plan can be manually activated.
Parameters
| Name | Type | Description |
|---|---|---|
segmentIndex | number | The index of the segment in which the leg resides. |
segmentLegIndex | number | The index of the leg in its segment. |
Returns
boolean
Whether the leg can be manually activated.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:411
canApproachLoad
▸ canApproachLoad(): boolean
Method to check whether an approach can load, or only activate.
Returns
boolean
true if the approach can be loaded and not activated, otherwise the approach can only be immediatly activated.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:1043
canDirectTo
▸ canDirectTo(segmentIndex, segmentLegIndex): boolean
Checks whether a leg in the primary flight plan is a valid direct to target.
Parameters
| Name | Type | Description |
|---|---|---|
segmentIndex | number | The index of the segment in which the leg resides. |
segmentLegIndex | number | The index of the leg in its segment. |
Returns
boolean
Whether the leg is a valid direct to target.
Throws
Error if a leg could not be found at the specified location.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:422
canEdit
▸ canEdit(): boolean
Checks whether the internal flight plans can be edited.
Returns
boolean
Whether the internal flight plans can be edited.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:376
cancelDirectTo
▸ cancelDirectTo(): boolean
Cancels the currently active internal on-route or off-route Direct-To.
Returns
boolean
Whether an active Direct-To was cancelled.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:1253
createDirectTo
▸ createDirectTo(target, course?): Promise<void>
Creates and activates a Direct-To for the internal flight plan source. If the target fix does not appear in the internal flight plan, then this will replace the primary flight plan with a single leg to the Direct-To's target waypoint and create and activate a Direct-To targeting the waypoint. If the target fix does appear in the internal flight plan, then this will create and activate an on-route Direct-To targeting the last occurrence of the target fix in the flight plan.
Parameters
| Name | Type | Description |
|---|---|---|
target | Facility | The Direct-To's target waypoint facility. |
course? | number | The magnetic course for the Direct-To, in degrees. If not defined, then the Direct-To will be initiated from the airplane's present position. |
Returns
Promise<void>
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:1190
deleteFlightPlanName
▸ deleteFlightPlanName(planIndex): void
Deletes the name of an internal flight plan.
Parameters
| Name | Type | Description |
|---|---|---|
planIndex | number | The index of the flight plan for which to delete the name. |
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:401
deletePrimaryFlightPlan
▸ deletePrimaryFlightPlan(): Promise<void>
Empties the internal primary flight plan and deletes its name.
Returns
Promise<void>
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:1273
emptyPrimaryFlightPlan
▸ emptyPrimaryFlightPlan(): Promise<void>
Empties the internal primary flight plan.
Returns
Promise<void>
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:1260
getApproachRunway
▸ getApproachRunway(): null | OneWayRunway
Gets the approach runway:
Returns
null | OneWayRunway
Selected approach runway
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:384
getCurrentFms
▸ getCurrentFms(): Fms<any>
Gets the Garmin FMS instance for the current flight plan source.
Returns
Fms<any>
The Garmin FMS instance for the current flight plan source.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:186
getDirectToFlightPlan
▸ getDirectToFlightPlan(): FlightPlan
Gets the off-route Direct-To flight plan for the current flight plan source.
Returns
FlightPlan
The off-route Direct-To flight plan for the current flight plan source.
Throws
Error if the off-route Direct-To flight plan does not exist.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:368
getDirectToState
▸ getDirectToState(): DirectToState
Gets the current Direct To State.
Returns
DirectToState
the DirectToState.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:430
getDirectToTargetIcao
▸ getDirectToTargetIcao(): undefined | string
Gets the ICAO string of the current Direct To target.
Returns
undefined | string
The ICAO string of the current Direct To target, or undefined if Direct To is not active.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:438
getExternalDirectToFlightPlan
▸ getExternalDirectToFlightPlan(index): FlightPlan
Gets the off-route Direct-To flight plan for an external flight plan source.
Parameters
| Name | Type | Description |
|---|---|---|
index | G3XExternalNavigatorIndex | The index of the external flight plan source from which to get the flight plan. |
Returns
FlightPlan
The off-route Direct-To flight plan for the specified external flight plan source.
Throws
Error if the external flight plan source is not supported or if the off-route Direct-To flight plan does not exist.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:359
getExternalFlightPlan
▸ getExternalFlightPlan(sourceIndex, index?): FlightPlan
Gets a specified external flight plan.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
sourceIndex | G3XExternalNavigatorIndex | undefined | The index of the external flight plan source from which to get a flight plan. |
index | number | FmsUtils.PRIMARY_PLAN_INDEX | The index of the flight plan. Defaults to the index of the primary flight plan. |
Returns
FlightPlan
The requested external flight plan.
Throws
Error if the external flight plan source is not supported or if no flight plan exists at the specified index.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:251
getExternalFms
▸ getExternalFms(index): Fms<any>
Retrieves the Garmin FMS instance to which this FMS delegates for an external flight plan source.
Parameters
| Name | Type | Description |
|---|---|---|
index | G3XExternalNavigatorIndex | The index of the external flight plan source for which to retrieve an FMS. |
Returns
Fms<any>
The Garmin FMS instance to which this FMS delegates for the specified external flight plan source.
Throws
Error if the external flight plan source is not supported.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:173
getExternalPrimaryFlightPlan
▸ getExternalPrimaryFlightPlan(index): FlightPlan
Gets the primary flight plan for an external flight plan source.
Parameters
| Name | Type | Description |
|---|---|---|
index | G3XExternalNavigatorIndex | The index of the external flight plan source from which to get the flight plan. |
Returns
FlightPlan
The primary flight plan for the specified external flight plan source.
Throws
Error if the external flight plan source is not supported or if the primary flight plan does not exist.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:305
getFlightPlan
▸ getFlightPlan(index?): FlightPlan
Gets a specified flight plan from the current flight plan source.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
index | number | FmsUtils.PRIMARY_PLAN_INDEX | The index of the flight plan. Defaults to the index of the primary flight plan. |
Returns
FlightPlan
The requested flight plan from the current flight plan source.
Throws
Error if no flight plan exists at the specified index.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:261
getInternalDirectToFlightPlan
▸ getInternalDirectToFlightPlan(): FlightPlan
Gets the off-route Direct-To flight plan for the internal flight plan source.
Returns
FlightPlan
The off-route Direct-To flight plan for the internal flight plan source.
Throws
Error if the off-route Direct-To flight plan does not exist.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:348
getInternalEventSubscriber
▸ getInternalEventSubscriber(): EventSubscriber<FmsEventsForId<"g3x">>
Gets an event bus subscriber for topics published by this FMS.
Returns
EventSubscriber<FmsEventsForId<"g3x">>
An event bus subscriber for topics published by this flight planner.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:144
getInternalFlightPlan
▸ getInternalFlightPlan(index?): FlightPlan
Gets a specified internal flight plan.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
index | number | FmsUtils.PRIMARY_PLAN_INDEX | The index of the flight plan. Defaults to the index of the primary flight plan. |
Returns
FlightPlan
The requested internal flight plan.
Throws
Error if no flight plan exists at the specified index.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:239
getInternalPrimaryFlightPlan
▸ getInternalPrimaryFlightPlan(): FlightPlan
Gets the primary flight plan for the internal flight plan source.
Returns
FlightPlan
The primary flight plan for the internal flight plan source.
Throws
Error if the primary flight plan does not exist.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:295
getPrimaryFlightPlan
▸ getPrimaryFlightPlan(): FlightPlan
Gets the primary flight plan for the current flight plan source.
Returns
FlightPlan
The primary flight plan for the current flight plan source.
Throws
Error if the primary flight plan does not exist.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:314
hasDirectToFlightPlan
▸ hasDirectToFlightPlan(): boolean
Checks whether the off-route Direct-To flight plan exists for the current flight plan source.
Returns
boolean
Whether the off-route Direct-To flight plan exists for the current flight plan source.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:339
hasExternalDirectToFlightPlan
▸ hasExternalDirectToFlightPlan(index): boolean
Checks whether the off-route Direct-To flight plan exists for an external flight plan source.
Parameters
| Name | Type | Description |
|---|---|---|
index | G3XExternalNavigatorIndex | The index of the external flight plan source to check. |
Returns
boolean
Whether the off-route Direct-To flight plan exists for the specified external flight plan source.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:331
hasExternalFlightPlan
▸ hasExternalFlightPlan(sourceIndex, index): boolean
Checks whether an external indexed flight plan exists.
Parameters
| Name | Type | Description |
|---|---|---|
sourceIndex | G3XExternalNavigatorIndex | The index of the external flight plan source to check. |
index | number | A flight plan index. |
Returns
boolean
Whether an external flight plan at the specified index exists.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:220
hasExternalPrimaryFlightPlan
▸ hasExternalPrimaryFlightPlan(index): boolean
Checks whether the primary flight plan exists for an external flight plan source.
Parameters
| Name | Type | Description |
|---|---|---|
index | G3XExternalNavigatorIndex | The index of the external flight plan source to check. |
Returns
boolean
Whether the primary flight plan exists for the specified external flight plan source.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:278
hasFlightPlan
▸ hasFlightPlan(index): boolean
Checks whether an indexed flight plan exists for the current flight plan source.
Parameters
| Name | Type | Description |
|---|---|---|
index | number | A flight plan index. |
Returns
boolean
Whether a flight plan at the specified index exists for the current flight plan source.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:229
hasInternalDirectToFlightPlan
▸ hasInternalDirectToFlightPlan(): boolean
Checks whether the off-route Direct-To flight plan exists for the internal flight plan source.
Returns
boolean
Whether the off-route Direct-To flight plan exists for the internal flight plan source.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:322
hasInternalFlightPlan
▸ hasInternalFlightPlan(index): boolean
Checks whether an internal indexed flight plan exists.
Parameters
| Name | Type | Description |
|---|---|---|
index | number | A flight plan index. |
Returns
boolean
Whether an internal flight plan at the specified index exists.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:210
hasInternalPrimaryFlightPlan
▸ hasInternalPrimaryFlightPlan(): boolean
Checks whether the primary flight plan exists for the internal flight plan source.
Returns
boolean
Whether the primary flight plan exists for the internal flight plan source.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:269
hasPrimaryFlightPlan
▸ hasPrimaryFlightPlan(): boolean
Checks whether the primary flight plan exists for the current flight plan source.
Returns
boolean
Whether the primary flight plan exists for the current flight plan source.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:286
initPrimaryFlightPlan
▸ initPrimaryFlightPlan(force?): Promise<void>
Initializes the primary flight plan for the internal flight plan source.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
force | boolean | false | Whether to force a new primary flight plan to be created, even if one already exists. |
Returns
Promise<void>
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:201
insertWaypoint
▸ insertWaypoint(segmentIndex, facility, segmentLegIndex?): Promise<undefined | LegDefinition>
Inserts a waypoint into the internal primary flight plan.
Parameters
| Name | Type | Description |
|---|---|---|
segmentIndex | number | The index of the flight plan segment into which to insert the waypoint. |
facility | Facility | The waypoint facility to insert. |
segmentLegIndex? | number | The index in the segment at which to insert the waypoint. If a leg already exists at the index, the existing leg and all subsequent legs will be shifted to the right. If not defined, the waypoint will be inserted at the end of the segment. |
Returns
Promise<undefined | LegDefinition>
The leg that was inserted into the flight plan, or undefined if the insertion operation could not be
carried out.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:477
invertFlightplan
▸ invertFlightplan(): void
Inverts the internal primary flightplan.
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:1035
isFirstEnrouteSegment
▸ isFirstEnrouteSegment(segmentIndex): boolean
Checks if a segment is the first enroute segment that is not an airway.
Parameters
| Name | Type | Description |
|---|---|---|
segmentIndex | number | is the segment index of the segment to check |
Returns
boolean
whether or not the segment is the first enroute segment that is not an airway.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:447
loadApproach
▸ loadApproach(facility, approachIndex, activate?, isVtf?): Promise<boolean>
Loads an approach into the internal primary flight plan.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
facility | AirportFacility | undefined | The airport facility containing the published approach on which the VFR approach to load is based. |
approachIndex | number | undefined | The index of the published approach on which the VFR approach to load is based. |
activate | boolean | false | Whether to immediately activate the approach after it has been loaded. Defaults to false. |
isVtf | boolean | false | Whether to activate the approach as a vectors-to-final (VTF) approach. Ignored if activate is false. Defaults to false. |
Returns
Promise<boolean>
A Promise which will be fulfilled with whether the specified approach was successfully loaded into the flight plan.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:570
onInternalEvent
▸ onInternalEvent<K>(baseTopic): Consumer<BaseFmsEvents[K]>
Subscribes to one of the event bus topics published by this FMS.
Type parameters
| Name | Type |
|---|---|
K | extends keyof BaseFmsEvents |
Parameters
| Name | Type | Description |
|---|---|---|
baseTopic | K | The base name of the topic to which to subscribe. |
Returns
Consumer<BaseFmsEvents[K]>
A consumer for the specified event bus topic.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:153
removeApproach
▸ removeApproach(): Promise<void>
Removes the approach that is currently loaded into the internal primary flight plan.
Returns
Promise<void>
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:619
removeUserFacility
▸ removeUserFacility(userFacility): void
Removes a user facility.
Parameters
| Name | Type | Description |
|---|---|---|
userFacility | UserFacility | the facility to remove. |
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:463
removeWaypoint
▸ removeWaypoint(segmentIndex, segmentLegIndex): Promise<boolean>
Removes a leg to a waypoint from the internal primary flight plan.
Parameters
| Name | Type | Description |
|---|---|---|
segmentIndex | number | The index of the segment containing the leg to remove. |
segmentLegIndex | number | The index of the leg to remove in its segment. |
Returns
Promise<boolean>
Whether the waypoint was successfully removed.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:523
resetAllFlightPlans
▸ resetAllFlightPlans(): Promise<void>
Resets all internal flight plans to their initial empty states, and cancels any active off-route Direct-To.
Returns
Promise<void>
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:1286
setFlightPlanName
▸ setFlightPlanName(planIndex, name): void
Sets the name of an internal flight plan.
Parameters
| Name | Type | Description |
|---|---|---|
planIndex | number | The index of the flight plan for which to set the name. |
name | string | The new name for the flight plan. |
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:393
tryGetExternalFms
▸ tryGetExternalFms(index): undefined | Fms<any>
Attempts to retrieve the Garmin FMS instance to which this FMS delegates for an external flight plan source.
Parameters
| Name | Type | Description |
|---|---|---|
index | G3XExternalNavigatorIndex | The index of the external flight plan source for which to retrieve an FMS. |
Returns
undefined | Fms<any>
The Garmin FMS instance to which this FMS delegates for the specified external flight plan source, or
undefined if the external flight plan source is not supported.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/FlightPlan/G3XFms.ts:163