Class: FlightPlanUtils
Defined in: src/sdk/flightplan/FlightPlanUtils.ts:10
Utility class for working with flight plans.
Constructors
Constructor
new FlightPlanUtils():
FlightPlanUtils
Returns
FlightPlanUtils
Methods
convertLegRunwayIcaosToSdkFormat()
staticconvertLegRunwayIcaosToSdkFormat(leg):FlightPlanLeg
Defined in: src/sdk/flightplan/FlightPlanUtils.ts:170
Converts all runway ICAO references in a flight plan leg to the runway ICAO format used by the MSFS avionics SDK.
Parameters
| Parameter | Type | Description |
|---|---|---|
leg | FlightPlanLeg | The flight plan leg to change. |
Returns
The specified flight plan leg, after all of its runway ICAO references have been changed to the format used by the MSFS avionics SDK.
emptyLegIndexes()
staticemptyLegIndexes():FlightPlanLegIndexes
Defined in: src/sdk/flightplan/FlightPlanUtils.ts:159
Creates a new FlightPlanLegIndexes object with all indexes set to -1.
Returns
A new FlightPlanLegIndexes object with all indexes set to -1.
getTerminatorIcao()
staticgetTerminatorIcao(leg):string|undefined
Defined in: src/sdk/flightplan/FlightPlanUtils.ts:115
Gets the ICAO of the facility defining the terminator of a flight plan leg.
Parameters
| Parameter | Type | Description |
|---|---|---|
leg | FlightPlanLeg | A flight plan leg. |
Returns
string | undefined
The ICAO of the facility defining the terminator of the specified flight plan leg, or undefined if
the leg's terminator is not defined by a facility.
Deprecated
Use FlightPathUtils.getTerminatorIcaoValue instead.
getTerminatorIcaoValue()
staticgetTerminatorIcaoValue(leg):IcaoValue|undefined
Defined in: src/sdk/flightplan/FlightPlanUtils.ts:138
Gets the ICAO of the facility defining the terminator of a flight plan leg.
Parameters
| Parameter | Type | Description |
|---|---|---|
leg | FlightPlanLeg | A flight plan leg. |
Returns
IcaoValue | undefined
The ICAO of the facility defining the terminator of the specified flight plan leg, or undefined if
the leg's terminator is not defined by a facility.
isAltitudeLeg()
staticisAltitudeLeg(legType): legType is CA | FA | VA
Defined in: src/sdk/flightplan/FlightPlanUtils.ts:50
Checks if a leg type is an "to altitude" leg type.
Parameters
| Parameter | Type | Description |
|---|---|---|
legType | LegType | The leg type to check. |
Returns
legType is CA | FA | VA
Whether the leg type is a "to altitude" leg type.
isDiscontinuityLeg()
staticisDiscontinuityLeg(legType): legType is Discontinuity | ThruDiscontinuity
Defined in: src/sdk/flightplan/FlightPlanUtils.ts:104
Checks if a leg type is a discontinuity leg type.
Parameters
| Parameter | Type | Description |
|---|---|---|
legType | LegType | The leg type to check. |
Returns
legType is Discontinuity | ThruDiscontinuity
Whether the leg type is a discontinuity leg type.
isHeadingToLeg()
staticisHeadingToLeg(legType): legType is VA | VD | VI | VM | VR
Defined in: src/sdk/flightplan/FlightPlanUtils.ts:59
Checks if a leg type is a "heading to" leg type.
Parameters
| Parameter | Type | Description |
|---|---|---|
legType | LegType | The leg type to check. |
Returns
legType is VA | VD | VI | VM | VR
Whether the leg type is a "heading to" leg type.
isHoldLeg()
staticisHoldLeg(legType): legType is HA | HF | HM
Defined in: src/sdk/flightplan/FlightPlanUtils.ts:77
Checks if a leg type is a "hold" leg type.
Parameters
| Parameter | Type | Description |
|---|---|---|
legType | LegType | The leg type to check. |
Returns
legType is HA | HF | HM
Whether the leg type is a "hold" leg type.
isInterceptLeg()
staticisInterceptLeg(legType): legType is CI | PI | VI
Defined in: src/sdk/flightplan/FlightPlanUtils.ts:86
Checks if a leg type is a "intercept" leg type.
Parameters
| Parameter | Type | Description |
|---|---|---|
legType | LegType | The leg type to check. |
Returns
legType is CI | PI | VI
Whether the leg type is a "intercept" leg type.
isManualDiscontinuityLeg()
staticisManualDiscontinuityLeg(legType): legType is FM | VM
Defined in: src/sdk/flightplan/FlightPlanUtils.ts:95
Checks if a leg type is a manual termination leg type that ends in a discontinuity.
Parameters
| Parameter | Type | Description |
|---|---|---|
legType | LegType | The leg type to check. |
Returns
legType is FM | VM
Whether the leg type is a manual termination leg type that ends in a discontinuity.
isToFixLeg()
staticisToFixLeg(legType): legType is AF | CF | DF | HF | IF | RF | TF
Defined in: src/sdk/flightplan/FlightPlanUtils.ts:41
Checks if a leg type is a "to fix" leg type. Note that while HM and HA legs may terminate at the hold fix, they are explicitly excluded from this check.
Parameters
| Parameter | Type | Description |
|---|---|---|
legType | LegType | The leg type to check. |
Returns
legType is AF | CF | DF | HF | IF | RF | TF
Whether the leg type is a "to fix" leg type.
isToRadialLeg()
staticisToRadialLeg(legType): legType is CR | VR
Defined in: src/sdk/flightplan/FlightPlanUtils.ts:68
Checks if a leg type is a "to radial" leg type.
Parameters
| Parameter | Type | Description |
|---|---|---|
legType | LegType | The leg type to check. |
Returns
legType is CR | VR
Whether the leg type is a "to radial" leg type.
setLegIcao()
staticsetLegIcao(leg,prop,icao):FlightPlanLeg
Defined in: src/sdk/flightplan/FlightPlanUtils.ts:198
Sets an ICAO property on a FlightPlanLeg, ensuring that both the associated value and string (V1) properties stay in sync.
Parameters
| Parameter | Type | Description |
|---|---|---|
leg | FlightPlanLeg | The flight plan leg to change. |
prop | "fixIcaoStruct" | "originIcaoStruct" | "arcCenterFixIcaoStruct" | The property to set. |
icao | IcaoValue | The ICAO value to set on the property. |
Returns
The specified flight plan leg, after it has been changed.