Class: FmsUtils
Utility Methods for the FMS.
Constructors
constructor
• new FmsUtils(): FmsUtils
Returns
Properties
DTO_LEG_OFFSET
▪ Static Readonly DTO_LEG_OFFSET: 3
The number of flight plan legs between a direct-to target leg and its associated direct-to leg.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:31
DTO_RANDOM_PLAN_INDEX
▪ Static Readonly DTO_RANDOM_PLAN_INDEX: 1
The index of the off-route direct-to flight plan.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:25
PRIMARY_PLAN_INDEX
▪ Static Readonly PRIMARY_PLAN_INDEX: 0
The index of the primary flight plan.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:22
PROC_PREVIEW_PLAN_INDEX
▪ Static Readonly PROC_PREVIEW_PLAN_INDEX: 2
The index of the procedure preview flight plan.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:28
getBestRnavType
▪ Static getBestRnavType: (query: ApproachProcedure | RnavTypeFlags) => RnavTypeFlags = ApproachUtils.getBestRnavType
Gets the best RNAV minimum type available for a given approach.
Param
The approach to check, or its RNAV type flags.
Type declaration
▸ (query): RnavTypeFlags
Gets the best RNAV minimum type available for a given approach.
Parameters
| Name | Type | Description |
|---|---|---|
query | ApproachProcedure | RnavTypeFlags | The approach to check, or its RNAV type flags. |
Returns
RnavTypeFlags
The best RNAV minimum type available for the specified approach.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:418
isApproachRnpAr
▪ Static isApproachRnpAr: (approach: ApproachProcedure) => boolean = ApproachUtils.isRnpAr
Checks whether an approach procedure is an RNP (AR) approach.
Param
The approach procedure to check.
Type declaration
▸ (approach): boolean
Checks whether an approach procedure is an RNP (AR) approach.
Parameters
| Name | Type |
|---|---|
approach | ApproachProcedure |
Returns
boolean
Whether the approach procedure is an RNP (AR) approach.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:718
Methods
approachDetailsEquals
▸ approachDetailsEquals(a, b): boolean
Checks whether two FMS approach details objects are equal.
Parameters
| Name | Type | Description |
|---|---|---|
a | Readonly<ApproachDetails> | The first FMS approach details object to compare. |
b | Readonly<ApproachDetails> | The second FMS approach details object to compare. |
Returns
boolean
Whether the two FMS approach details objects are equal.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:1603
approachHasNavFrequency
▸ approachHasNavFrequency(approach): boolean
Checks whether an approach has a primary NAV frequency based on its type. Only approaches of the following types have primary NAV frequencies: ILS, LOC (BC), LDA, SDF, VOR(DME).
Parameters
| Name | Type | Description |
|---|---|---|
approach | ApproachProcedure | The approach to check. |
Returns
boolean
Whether the specified approach has a primary NAV frequency based on its type.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:823
buildEmptyVisualApproach
▸ buildEmptyVisualApproach(runway): ApproachProcedure
Builds an empty approach procedure object for a visual approach. The empty object contains all descriptive data for the approach but lacks flight plan leg information for the approach.
Parameters
| Name | Type | Description |
|---|---|---|
runway | OneWayRunway | The runway to which the approach belongs. |
Returns
ApproachProcedure
An empty approach procedure object for the specified approach.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:304
buildRunwayLeg
▸ buildRunwayLeg(airport, runway, isInitialFix): FlightPlanLeg
Builds a flight plan leg to a runway fix.
Parameters
| Name | Type | Description |
|---|---|---|
airport | string | AirportFacility | The runway's parent airport or its ICAO. |
runway | OneWayRunway | The runway associated with the runway fix. |
isInitialFix | boolean | Whether to create the flight plan leg as an initial fix (IF) leg instead of a track-to-fix (TF) leg. |
Returns
FlightPlanLeg
A flight plan leg to the specified runway fix.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:162
buildRunwayLegForApproach
▸ buildRunwayLegForApproach(airport, runwayIcao): undefined | FlightPlanLeg
Utility method to return a one-way runway leg from an approach runway leg definition
Parameters
| Name | Type | Description |
|---|---|---|
airport | AirportFacility | is the facility associated with the arrival |
runwayIcao | string | is the icao string for the runway waypoint in the final legs |
Returns
undefined | FlightPlanLeg
a leg object for the runway
Defined in
src/garminsdk/flightplan/FmsUtils.ts:179
buildVfrApproach
▸ buildVfrApproach(airport, approachIndex): undefined | GarminVfrApproachProcedure
Creates a VFR approach object based on a published approach.
Parameters
| Name | Type | Description |
|---|---|---|
airport | AirportFacility | The airport facility containing the published approach on which the VFR approach is based. |
approachIndex | number | The index of the published approach on which the VFR approach is based. |
Returns
undefined | GarminVfrApproachProcedure
A new VFR approach object based on the specified published approach, or undefined if a VFR approach
could not be generated.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:329
buildVisualApproach
▸ buildVisualApproach(airport, runway, finalLegDistance, initialLegDistance, name?, finalLegIdent?, initialLegIdent?): ApproachProcedure
Utility method to return a visual approach for a runway.
Parameters
| Name | Type | Description |
|---|---|---|
airport | AirportFacility | is the airport facility for the visual approach. |
runway | OneWayRunway | is the runway to build the visual approach for. |
finalLegDistance | number | is the distance from the runway to place the faf leg in NM. |
initialLegDistance | number | is the distance from the final leg to place the iaf leg in NM. |
name? | string | is the optional name for the approach. |
finalLegIdent? | string | is the optional name for the faf leg. |
initialLegIdent? | string | is the optional name for the iaf leg. |
Returns
ApproachProcedure
an approach procedure.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:208
checkForCourseReversal
▸ checkForCourseReversal(legs, ppos): boolean
Checks for a course reversal in the procedure.
Parameters
| Name | Type | Description |
|---|---|---|
legs | LegDefinition[] | The legs in the procedure. |
ppos | GeoPoint | The current aircraft present position. |
Returns
boolean
true if there is an optional course reversal.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:1322
createApproachListItem
▸ createApproachListItem(approach, index): ApproachListItem
Creates an ApproachListItem from an ApproachProcedure and the approach index.
Parameters
| Name | Type | Description |
|---|---|---|
approach | ApproachProcedure | The approach procedure. |
index | number | The approach index. |
Returns
The created ApproachListItem.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:937
createApproachTransitionListItem
▸ createApproachTransitionListItem(approach, transitionIndex): TransitionListItem
Creates an TransitionListItem from an ApproachProcedure and the transition index.
Parameters
| Name | Type | Description |
|---|---|---|
approach | ApproachProcedure | The approach procedure. |
transitionIndex | number | The approach transition index. |
Returns
The created TransitionListItem.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:990
displayAltitudeAsFlightLevel
▸ displayAltitudeAsFlightLevel(altitudeMeters): boolean
Determines whether an altitude should be displayed as a flight level.
Parameters
| Name | Type | Description |
|---|---|---|
altitudeMeters | number | The altitude in meters. |
Returns
boolean
Whether an altitude should be displayed as a flight level.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:1579
flightPhaseEquals
▸ flightPhaseEquals(a, b): boolean
Checks whether two FMS flight phase objects are equal.
Parameters
| Name | Type | Description |
|---|---|---|
a | Readonly<FmsFlightPhase> | The first FMS flight phase object to compare. |
b | Readonly<FmsFlightPhase> | The second FMS flight phase object to compare. |
Returns
boolean
Whether the two FMS flight phase objects are equal.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:1590
getAirportFromPlan
▸ getAirportFromPlan(plan, reverse): undefined | string
Gets and returns the ICAO of first or last airport fix from the flight plan legs.
Parameters
| Name | Type | Description |
|---|---|---|
plan | FlightPlan | The flight plan to use. |
reverse | boolean | Whether to get the first or last airport. |
Returns
undefined | string
The ICAO of last airport fix from the flight plan legs.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:1365
getApproachFafLeg
▸ getApproachFafLeg(plan): undefined | LegDefinition
Gets the final approach fix leg of a flight plan.
Parameters
| Name | Type | Description |
|---|---|---|
plan | FlightPlan | A flight plan. |
Returns
undefined | LegDefinition
The final approach fix leg of a flight plan, or undefined if one could not be found.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:562
getApproachFromPlan
▸ getApproachFromPlan(plan, destination): undefined | GarminApproachProcedure
Gets an approach procedure from a flight plan. If the flight plan has an visual approach loaded, an empty procedure object, containing descriptive data for the approach but lacking flight plan leg information, will be returned.
Parameters
| Name | Type | Description |
|---|---|---|
plan | FlightPlan | A flight plan. |
destination | AirportFacility | The destination airport of the flight plan. |
Returns
undefined | GarminApproachProcedure
The approach procedure from the flight plan, or undefined if the plan has no approach.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:496
getApproachNameAsParts
▸ getApproachNameAsParts(proc): ApproachNameParts
Utility method to analyze an approach for its name components and pack them into a custom type.
Parameters
| Name | Type | Description |
|---|---|---|
proc | GarminApproachProcedure | The approach procedure. |
Returns
The name as an ApproachNameParts
Defined in
src/garminsdk/flightplan/FmsUtils.ts:726
getApproachNameAsString
▸ getApproachNameAsString(approach): string
Utility method that takes an approach and returns its name as a flat string suitable for use in embedded text content.
Parameters
| Name | Type | Description |
|---|---|---|
approach | GarminApproachProcedure | The approach as an ApproaceProcedure |
Returns
string
The formatted name as a string.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:807
getApproachSegment
▸ getApproachSegment(plan): undefined | FlightPlanSegment
Gets the approach segment from a flight plan.
Parameters
| Name | Type | Description |
|---|---|---|
plan | FlightPlan | A flight plan. |
Returns
undefined | FlightPlanSegment
The approach segment in the specified flight plan, or undefined if one does not exist.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:131
getApproachTransitionName
▸ getApproachTransitionName(approach, transitionIndex): string
Creates an TransitionListItem from an ApproachProcedure and the transition index.
Parameters
| Name | Type | Description |
|---|---|---|
approach | ApproachProcedure | The approach procedure. |
transitionIndex | number | The approach transition index. |
Returns
string
The created TransitionListItem.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:1003
getApproachTransitions
▸ getApproachTransitions(approachItem?): TransitionListItem[]
Gets the transitions for the approach, adding suffixes, vectors transtion, and default approach if needed.
Parameters
| Name | Type | Description |
|---|---|---|
approachItem? | ApproachListItem | The approach procedure to get the transitions for. |
Returns
The transitions for the approach.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:958
getApproachVtfLeg
▸ getApproachVtfLeg(plan): undefined | LegDefinition
Gets the vectors-to-final faf leg of a flight plan.
Parameters
| Name | Type | Description |
|---|---|---|
plan | FlightPlan | A flight plan. |
Returns
undefined | LegDefinition
The vectors-to-final faf leg of the flight plan, or undefined if one could not be found.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:587
getApproaches
▸ getApproaches(airport?, includeVisual?): ApproachListItem[]
Gets an array of approach list items from an airport.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
airport? | AirportFacility | undefined | An airport. |
includeVisual | boolean | true | Whether to include visual approaches. Defaults to true. |
Returns
An array of approach list items for the specified airport.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:844
getArrivalEnrouteTransitionName
▸ getArrivalEnrouteTransitionName(procedure, transitionIndex, rwyTransitionIndex): string
Gets the transition name and creates a default transition when the procedure has no transitions.
Parameters
| Name | Type | Description |
|---|---|---|
procedure | Procedure | is the arrival procedure. |
transitionIndex | number | is the index of the enroute transition in the procedure. |
rwyTransitionIndex | number | is the index of the runway transition in the procedure. |
Returns
string
The transition name string.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:690
getArrivalNameAsString
▸ getArrivalNameAsString(airport, arrival, transitionIndex, runway): string
Gets the name of a arrival procedure as a string.
Parameters
| Name | Type | Description |
|---|---|---|
airport | AirportFacility | The airport to which the departure belongs. |
arrival | Procedure | An arrival procedure definition. |
transitionIndex | number | The index of the arrival enroute transition. |
runway | undefined | OneWayRunway | The runway of the arrival, if any. |
Returns
string
The name of the arrival procedure.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:631
getArrivalSegment
▸ getArrivalSegment(plan): undefined | FlightPlanSegment
Gets the arrival segment from a flight plan.
Parameters
| Name | Type | Description |
|---|---|---|
plan | FlightPlan | A flight plan. |
Returns
undefined | FlightPlanSegment
The arrival segment in the specified flight plan, or undefined if one does not exist.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:117
getBestApproachType
▸ getBestApproachType(airport, includeVisual?, includeRnpAr?): ExtendedApproachType
Gets the best approach type available at an airport.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
airport | AirportFacility | undefined | An airport facility. |
includeVisual | boolean | false | Whether to include visual approaches. Defaults to false. |
includeRnpAr | boolean | false | Whether to include RNP AR approaches. Defaults to false. |
Returns
ExtendedApproachType
The best approach type available at the specified airport.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:443
getDepartureEnrouteTransitionName
▸ getDepartureEnrouteTransitionName(procedure, transitionIndex, rwyTransitionIndex): string
Gets the transition name and creates a default transition when the procedure has no transitions.
Parameters
| Name | Type | Description |
|---|---|---|
procedure | Procedure | is the departure procedure. |
transitionIndex | number | is the index of the enroute transition in the procedure. |
rwyTransitionIndex | number | is the index of the runway transition in the procedure. |
Returns
string
The transition name string.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:657
getDepartureNameAsString
▸ getDepartureNameAsString(airport, departure, transitionIndex, runway): string
Gets the name of a departure procedure as a string.
Parameters
| Name | Type | Description |
|---|---|---|
airport | AirportFacility | The airport to which the departure belongs. |
departure | Procedure | A departure procedure definition. |
transitionIndex | number | The index of the departure enroute transition. |
runway | undefined | OneWayRunway | The runway of the departure, if any. |
Returns
string
The name of the departure procedure.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:604
getDepartureSegment
▸ getDepartureSegment(plan): undefined | FlightPlanSegment
Gets the departure segment from a flight plan.
Parameters
| Name | Type | Description |
|---|---|---|
plan | FlightPlan | A flight plan. |
Returns
undefined | FlightPlanSegment
The departure segment in the specified flight plan, or undefined if one does not exist.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:69
getDestinationSegment
▸ getDestinationSegment(plan): undefined | FlightPlanSegment
Gets the destination segment from a flight plan.
Parameters
| Name | Type | Description |
|---|---|---|
plan | FlightPlan | A flight plan. |
Returns
undefined | FlightPlanSegment
The destination segment in the specified flight plan, or undefined if one does not exist.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:145
getFirstAirportFromPlan
▸ getFirstAirportFromPlan(plan): undefined | string
Gets and returns the ICAO of first airport fix from the flight plan legs.
Parameters
| Name | Type | Description |
|---|---|---|
plan | FlightPlan | The flight plan to use. |
Returns
undefined | string
The ICAO of first airport fix from the flight plan legs.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:1346
getFirstEnrouteSegment
▸ getFirstEnrouteSegment(plan): undefined | FlightPlanSegment
Gets the first enroute segment from a flight plan.
Parameters
| Name | Type | Description |
|---|---|---|
plan | FlightPlan | A flight plan. |
Returns
undefined | FlightPlanSegment
The first enroute segment in the specified flight plan, or undefined if one does not exist.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:83
getFromLegForArrowDisplay
▸ getFromLegForArrowDisplay(plan, globalLegIndex): undefined | LegDefinition
Gets the leg from which a specified flight plan leg originates for the purpose of displaying the flight plan from-to arrow.
Parameters
| Name | Type | Description |
|---|---|---|
plan | FlightPlan | A flight plan. |
globalLegIndex | number | The global index of the leg for which to get the from leg. |
Returns
undefined | LegDefinition
The leg from which the specified flight plan leg originates for the purpose of displaying the from -to arrow.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:1113
▸ getFromLegForArrowDisplay(plan, segmentIndex, segmentLegIndex): undefined | LegDefinition
Gets the leg from which a specified flight plan leg originates for the purpose of displaying the flight plan from-to arrow.
Parameters
| Name | Type | Description |
|---|---|---|
plan | FlightPlan | A flight plan. |
segmentIndex | number | The index of the segment containing the leg for which to get the from leg. |
segmentLegIndex | number | The index of the leg for which to get the from leg in its segment. |
Returns
undefined | LegDefinition
The leg from which the specified flight plan leg originates for the purpose of displaying the from -to arrow.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:1123
getGlobalLegIndex
▸ getGlobalLegIndex(lateralPlan, segmentIndex, segmentLegIndex): number
Gets the global leg index from a segment and segment leg index, whether or not the leg exists.
Parameters
| Name | Type | Description |
|---|---|---|
lateralPlan | FlightPlan | The Lateral Flight Plan. |
segmentIndex | number | The Segment Index. |
segmentLegIndex | number | The Segment Leg Index. |
Returns
number
The global leg index.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:1024
getLastAirportFromPlan
▸ getLastAirportFromPlan(plan): undefined | string
Gets and returns the ICAO of last airport fix from the flight plan legs.
Parameters
| Name | Type | Description |
|---|---|---|
plan | FlightPlan | The flight plan to use. |
Returns
undefined | string
The ICAO of last airport fix from the flight plan legs.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:1355
getLastEnrouteSegment
▸ getLastEnrouteSegment(plan): undefined | FlightPlanSegment
Gets the last enroute segment from a flight plan.
Parameters
| Name | Type | Description |
|---|---|---|
plan | FlightPlan | A flight plan. |
Returns
undefined | FlightPlanSegment
The last enroute segment in the specified flight plan, or undefined if one does not exist.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:100
getLegIndexes
▸ getLegIndexes(lateralPlan, leg): undefined | LegIndexes
Gets the indexes for a leg.
Parameters
| Name | Type | Description |
|---|---|---|
lateralPlan | FlightPlan | The Lateral Flight Plan. |
leg | LegDefinition | The leg definition. |
Returns
undefined | LegIndexes
The leg indexes, or undefined if not found.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:1038
getNominalFromLeg
▸ getNominalFromLeg(plan, segmentIndex, segmentLegIndex): undefined | LegDefinition
Gets the nominal leg from which a specified flight plan leg originates. The nominal from leg excludes any legs which are part of a direct to or vectors-to-final sequence.
Parameters
| Name | Type | Description |
|---|---|---|
plan | FlightPlan | A flight plan. |
segmentIndex | number | The index of the segment containing the leg for which to get the from leg. |
segmentLegIndex | number | The index of the leg for which to get the from leg in its segment. |
Returns
undefined | LegDefinition
The nominal leg from which the specified flight plan leg originates.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:1062
getNominalFromLegIndex
▸ getNominalFromLegIndex(plan, segmentIndex, segmentLegIndex): number
Gets the global leg index of the nominal leg from which a specified flight plan leg originates. The nominal from leg excludes any legs which are part of a direct to or vectors-to-final sequence.
Parameters
| Name | Type | Description |
|---|---|---|
plan | FlightPlan | A flight plan. |
segmentIndex | number | The index of the segment containing the leg for which to get the from leg. |
segmentLegIndex | number | The index of the leg for which to get the from leg in its segment. |
Returns
number
The nominal leg from which the specified flight plan leg originates.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:1086
getNominalLegDtk
▸ getNominalLegDtk(leg, out): Float64Array
Gets the nominal desired track for a flight plan leg, as [dtk, magVar] where dtk is the true desired track and
magVar is the magnetic variation used to convert between true and magnetic desired tracks, both in degrees. If a
nominal desired track could not be obtained, then the value of dtk will be equal to NaN.
Parameters
| Name | Type | Description |
|---|---|---|
leg | LegDefinition | The leg for which to get the nominal desired track. |
out | Float64Array | The array to which to write the results. |
Returns
Float64Array
The nominal desired track for the specified flight plan leg, as [dtk, magVar] where dtk is the true
desired track and magVar is the magnetic variation used to convert between true and magnetic desired tracks,
both in degrees.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:1182
getPublishedSpeedDescBasedOnSegment
▸ getPublishedSpeedDescBasedOnSegment(publishedSpeedRestriction, segmentType): SpeedRestrictionType
Returns the speed restriction type to use based on the published speed and what segment it's in.
Parameters
| Name | Type | Description |
|---|---|---|
publishedSpeedRestriction | number | The published speed. |
segmentType | FlightPlanSegmentType | The segment type. |
Returns
SpeedRestrictionType
The speed restriction type to use.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:1566
getSequenceLegFixTypeSuffix
▸ getSequenceLegFixTypeSuffix(leg, allowHdg?): string
Gets the string for the leg fix type for use in a sequence list.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
leg | LegDefinition | undefined | The leg definition. |
allowHdg | boolean | true | If false, will not return 'hdg'. Defaults to true. |
Returns
string
The left padded suffix string or empty string.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:1298
getVfrApproaches
▸ getVfrApproaches(airport?): VfrApproachListItem[]
Gets an array of approach list items from an airport.
Parameters
| Name | Type | Description |
|---|---|---|
airport? | AirportFacility | An airport. |
Returns
An array of approach list items for the specified airport.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:885
getVisualApproaches
▸ getVisualApproaches(facility): ApproachProcedure[]
Gets the visual approaches for the facility.
Parameters
| Name | Type | Description |
|---|---|---|
facility | AirportFacility | is the facility. |
Returns
ApproachProcedure[]
The Approach Procedures.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:910
isAltitudeEditable
▸ isAltitudeEditable(plan, leg, isAdvancedVNav): boolean
Checks whether a flight plan leg's altitude constraint should be editable.
Parameters
| Name | Type | Description |
|---|---|---|
plan | FlightPlan | The flight plan containing the leg to evaluate. |
leg | LegDefinition | The flight plan leg to evaluate. |
isAdvancedVNav | boolean | Whether this is for advanced vnav mode or not. |
Returns
boolean
whether a leg's altitude constraint should be editable.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:1420
isAltitudeVisible
▸ isAltitudeVisible(plan, leg, isAdvancedVNav, isEditable?): boolean
Checks whether a leg's altitude constraint should be visible.
Parameters
| Name | Type | Description |
|---|---|---|
plan | FlightPlan | The flight plan containing the leg to evaluate. |
leg | LegDefinition | The flight plan leg to evaluate. |
isAdvancedVNav | boolean | Whether this is for advanced vnav mode or not. |
isEditable? | boolean | Whether the constraint is editable, leave undefined if we don't know yet. |
Returns
boolean
whether a leg's altitude constraint should be visible.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:1482
isApproachLoaded
▸ isApproachLoaded(plan): boolean
Checks whether a flight plan has an approach loaded.
Parameters
| Name | Type | Description |
|---|---|---|
plan | FlightPlan | A flight plan. |
Returns
boolean
Whether the flight plan has an approach loaded.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:522
isGpsApproach
▸ isGpsApproach(approach): boolean
Utility method to check whether an approach is authorized for GPS guidance.
Parameters
| Name | Type | Description |
|---|---|---|
approach | ApproachProcedure | The approach procedure |
Returns
boolean
True if GPS guidance is authorized, false otherwise.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:462
isLegAltitudeEdited
▸ isLegAltitudeEdited(leg, isAdvancedVNav): boolean
Determines if a flight plan leg's altitude constraint is considered to be edited. If the leg does not have a
designated altitude constraint, false will be returned.
Parameters
| Name | Type | Description |
|---|---|---|
leg | LegDefinition | A flight plan leg. |
isAdvancedVNav | boolean | Whether advanced VNAV is supported. |
Returns
boolean
Whether the specified flight plan leg's altitude constraint is considered to be edited.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:1381
isLocalizerApproach
▸ isLocalizerApproach(approach): boolean
Utility method to check for an approach with a a tunable localizer.
Parameters
| Name | Type | Description |
|---|---|---|
approach | ApproachProcedure | The approach procedure |
Returns
boolean
True if a localizer needs to be tuned, otherwise false.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:476
isPublishedApproachLoaded
▸ isPublishedApproachLoaded(plan): boolean
Checks whether a flight plan has an approach loaded.
Parameters
| Name | Type | Description |
|---|---|---|
plan | FlightPlan | A flight plan. |
Returns
boolean
Whether the flight plan has an approach loaded.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:533
isVfrApproachLoaded
▸ isVfrApproachLoaded(plan): boolean
Checks whether a flight plan has an approach loaded.
Parameters
| Name | Type | Description |
|---|---|---|
plan | FlightPlan | A flight plan. |
Returns
boolean
Whether the flight plan has an approach loaded.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:552
isVisualApproachLoaded
▸ isVisualApproachLoaded(plan): boolean
Checks whether a flight plan has an approach loaded.
Parameters
| Name | Type | Description |
|---|---|---|
plan | FlightPlan | A flight plan. |
Returns
boolean
Whether the flight plan has an approach loaded.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:542
isVtfApproachLoaded
▸ isVtfApproachLoaded(plan): boolean
Checks whether a plan has a vectors-to-final approach loaded.
Parameters
| Name | Type | Description |
|---|---|---|
plan | FlightPlan | A flight plan. |
Returns
boolean
Whether the flight plan has a vectors-to-final approach loaded.
Defined in
src/garminsdk/flightplan/FmsUtils.ts:576
onFmsEvent
▸ onFmsEvent<ID, K>(id, bus, baseTopic): Consumer<BaseFmsEvents[K]>
Subscribes to one of the event bus topics published by an FMS with a given ID.
Type parameters
| Name | Type |
|---|---|
ID | extends string |
K | extends keyof BaseFmsEvents |
Parameters
| Name | Type | Description |
|---|---|---|
id | ID | The ID of the FMS. |
bus | EventBus | The event bus to which to subscribe. |
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/garminsdk/flightplan/FmsUtils.ts:44
▸ onFmsEvent<ID, K>(id, subscriber, baseTopic): Consumer<BaseFmsEvents[K]>
Subscribes to one of the event bus topics published by an FMS with a given ID.
Type parameters
| Name | Type |
|---|---|
ID | extends string |
K | extends keyof BaseFmsEvents |
Parameters
| Name | Type | Description |
|---|---|---|
id | ID | The ID of the FMS. |
subscriber | EventSubscriber<FmsEventsForId<ID>> | The event subscriber to use to subscribe. |
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/garminsdk/flightplan/FmsUtils.ts:52
reconcileDirectToData
▸ reconcileDirectToData(plan): void
Reconciles a flight plan's Direct-To data with its internal leg structure. Scans the legs of the flight plan for Direct-To legs and sets the segment index and segment leg index of the plan's Direct-To data to point to the leg immediately preceding the first Direct-To leg found, or to -1 for both if the plan contains no Direct-To legs.
Parameters
| Name | Type | Description |
|---|---|---|
plan | FlightPlan | A flight plan. |
Returns
void
Defined in
src/garminsdk/flightplan/FmsUtils.ts:1274