Class: RunwayUtils
Defined in: src/sdk/navigation/RunwayUtils.ts:16
Methods for working with Runways and Runway Designations.
Constructors
Constructor
new RunwayUtils():
RunwayUtils
Returns
RunwayUtils
Properties
tempGeoPoint
protected
static
tempGeoPoint:GeoPoint
Defined in: src/sdk/navigation/RunwayUtils.ts:68
Methods
createEmptyOneWayRunway()
static
createEmptyOneWayRunway():OneWayRunway
Defined in: src/sdk/navigation/RunwayUtils.ts:87
Creates an empty one-way runway.
Returns
an empty one-way runway.
createRunwayFacility()
static
createRunwayFacility(airport
,runway
):RunwayFacility
Defined in: src/sdk/navigation/RunwayUtils.ts:489
Creates a runway waypoint facility from a runway.
Parameters
Parameter | Type | Description |
---|---|---|
airport | AirportFacility | The runway's parent airport. |
runway | OneWayRunway | A one-way runway. |
Returns
A runway waypoint facility corresponding to the runway.
getBcFrequency()
static
getBcFrequency(airport
,runwayNumber
,runwayDesignator
):undefined
|FacilityFrequency
Defined in: src/sdk/navigation/RunwayUtils.ts:406
Gets the back course frequency for a runway.
Parameters
Parameter | Type | Description |
---|---|---|
airport | AirportFacility | The airport to which the query runway belongs. |
runwayNumber | number | The number of the query runway. |
runwayDesignator | RunwayDesignator | The designator of the query runway. |
Returns
undefined
| FacilityFrequency
The bc frequency for the query runway, or undefined if one could not be found.
getDesignatorLetter()
static
getDesignatorLetter(designator
,lowerCase
):string
Defined in: src/sdk/navigation/RunwayUtils.ts:76
Gets the letter for a runway designator.
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
designator | RunwayDesignator | undefined | A runway designator. |
lowerCase | boolean | false | Whether the letter should be lower case. False by default. |
Returns
string
The letter for the specified runway designator.
getLocFrequency()
Call Signature
static
getLocFrequency(airport
,runway
):undefined
|FacilityFrequency
Defined in: src/sdk/navigation/RunwayUtils.ts:347
Gets the localizer frequency for a runway.
Parameters
Parameter | Type | Description |
---|---|---|
airport | AirportFacility | The airport to which the query runway belongs. |
runway | OneWayRunway | The query runway. |
Returns
undefined
| FacilityFrequency
The localizer frequency for the query runway, or undefined if one could not be found.
Call Signature
static
getLocFrequency(airport
,runwayDesignation
):undefined
|FacilityFrequency
Defined in: src/sdk/navigation/RunwayUtils.ts:354
Gets the localizer frequency for a runway.
Parameters
Parameter | Type | Description |
---|---|---|
airport | AirportFacility | The airport to which the query runway belongs. |
runwayDesignation | string | The designation of the query runway. |
Returns
undefined
| FacilityFrequency
The localizer frequency for the query runway, or undefined if one could not be found.
Call Signature
static
getLocFrequency(airport
,runwayNumber
,runwayDesignator
):undefined
|FacilityFrequency
Defined in: src/sdk/navigation/RunwayUtils.ts:362
Gets the localizer frequency for a runway.
Parameters
Parameter | Type | Description |
---|---|---|
airport | AirportFacility | The airport to which the query runway belongs. |
runwayNumber | number | The number of the query runway. |
runwayDesignator | RunwayDesignator | The designator of the query runway. |
Returns
undefined
| FacilityFrequency
The localizer frequency for the query runway, or undefined if one could not be found.
getOneWayRunways()
static
getOneWayRunways(runway
,index
):OneWayRunway
[]
Defined in: src/sdk/navigation/RunwayUtils.ts:129
Utility method to return two one-way runways from a single runway facility
Parameters
Parameter | Type | Description |
---|---|---|
runway | AirportRunway | is the AirportRunway object to evaluate |
index | number | is the index of the AirportRunway in the Facility |
Returns
splitRunways array of OneWayRunway objects
getOneWayRunwaysFromAirport()
static
getOneWayRunwaysFromAirport(airport
):OneWayRunway
[]
Defined in: src/sdk/navigation/RunwayUtils.ts:113
Utility method to return all of the one-way runways from a single airport facility
Parameters
Parameter | Type | Description |
---|---|---|
airport | AirportFacility | is the Airport Facility to evaluate |
Returns
all of the one-way runways in the airport facility, sorted.
getOppositeOneWayRunway()
static
getOppositeOneWayRunway(airport
,runwayNumber
,runwayDesignator
):undefined
|OneWayRunway
Defined in: src/sdk/navigation/RunwayUtils.ts:424
Get the opposite one way runway from a runway number and designator.
Parameters
Parameter | Type | Description |
---|---|---|
airport | AirportFacility | The airport to which the query runway belongs. |
runwayNumber | number | The number of the query runway. |
runwayDesignator | RunwayDesignator | The designator of the query runway. |
Returns
undefined
| OneWayRunway
The opposite one way runway for the query runway, or undefined if one could not be found.
getProceduresForRunway()
static
getProceduresForRunway(procedures
,runway
):ApproachProcedure
[]
Defined in: src/sdk/navigation/RunwayUtils.ts:314
Utility method to return the procedures for a given runway.
Parameters
Parameter | Type | Description |
---|---|---|
procedures | readonly ApproachProcedure [] | The procedures for the airport. |
runway | AirportRunway | The given runway to find procedures for. |
Returns
A list of approach procedures for the given runway.
getRunwayCode()
static
getRunwayCode(number
):string
Defined in: src/sdk/navigation/RunwayUtils.ts:507
Gets an alpha code from a runway number.
Parameters
Parameter | Type | Description |
---|---|---|
number | number | is the runway number. |
Returns
string
a letter.
getRunwayFacilityIcao()
static
getRunwayFacilityIcao(airport
,runway
):string
Defined in: src/sdk/navigation/RunwayUtils.ts:478
Gets the ICAO string for the runway facility associated with a one-way runway.
Parameters
Parameter | Type | Description |
---|---|---|
airport | string | AirportFacility | The runway's parent airport, or the ICAO of the airport. |
runway | OneWayRunway | A one-way runway. |
Returns
string
the ICAO string for the runway facility associated with the one-way runway.
getRunwayNameString()
static
getRunwayNameString(runwayNumber
,designator
,padded
,prefix
):string
Defined in: src/sdk/navigation/RunwayUtils.ts:216
Utility method to return the runway name from the number and designator (L/R/C/W)
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
runwayNumber | number | undefined | is the integer part of a runway name (18, 26, 27, etc) |
designator | RunwayDesignator | undefined | is the RunwayDesignator enum for the runway |
padded | boolean | true | Whether single-char runways should be 0-padded. |
prefix | string | '' | A prefix to put before the runway name. |
Returns
string
the runway name string
getRunwayNumberPrimary()
static
getRunwayNumberPrimary(runway
):number
Defined in: src/sdk/navigation/RunwayUtils.ts:230
Gets the primary runway number for a paired runway.
Parameters
Parameter | Type | Description |
---|---|---|
runway | AirportRunway | A paired runway. |
Returns
number
The primary runway number for the specified runway.
getRunwayNumberSecondary()
static
getRunwayNumberSecondary(runway
):undefined
|number
Defined in: src/sdk/navigation/RunwayUtils.ts:245
Gets the secondary runway number for a paired runway.
Parameters
Parameter | Type | Description |
---|---|---|
runway | AirportRunway | A paired runway. |
Returns
undefined
| number
The secondary runway number for the specified runway, or undefined
if the runway has no secondary
runway.
getRunwayPairNameString()
static
getRunwayPairNameString(runway
,padded
):string
Defined in: src/sdk/navigation/RunwayUtils.ts:198
Gets a name for a paired runway. Names are formatted as dash-separated pairs of directional (one-way) runway designations, with optional leading zero padding of the runway numbers. If the specified runway is not paired, then the name will be the designation of the primary runway only.
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
runway | AirportRunway | undefined | A paired runway. |
padded | boolean | true | Whether the runway numbers should be padded with leading zeroes. Defaults to true . |
Returns
string
The name for the specified paired runway.
getSurfaceCategory()
static
getSurfaceCategory(runway
):RunwaySurfaceCategory
Defined in: src/sdk/navigation/RunwayUtils.ts:517
Gets the runway surface category from a runway or runway surface type.
Parameters
Parameter | Type | Description |
---|---|---|
runway | AirportRunway | RunwaySurfaceType | OneWayRunway | A runway or runway surface type. |
Returns
The surface category of the specified runway or runway surface type.
matchOneWayRunway()
static
matchOneWayRunway(airport
,runwayNumber
,runwayDesignator
):undefined
|OneWayRunway
Defined in: src/sdk/navigation/RunwayUtils.ts:261
Gets a one-way runway from an airport that matches a runway designation by number and designator.
Parameters
Parameter | Type | Description |
---|---|---|
airport | AirportFacility | The airport facility in which to search for the match. |
runwayNumber | number | A runway number to match. |
runwayDesignator | RunwayDesignator | A runway designator to match. |
Returns
undefined
| OneWayRunway
The one-way runway which matches the designation, or undefined if no match could be found.
matchOneWayRunwayFromDesignation()
static
matchOneWayRunwayFromDesignation(airport
,designation
):undefined
|OneWayRunway
Defined in: src/sdk/navigation/RunwayUtils.ts:285
Gets a one-way runway from an airport that matches a runway designation string.
Parameters
Parameter | Type | Description |
---|---|---|
airport | AirportFacility | The airport facility in which to search for the match. |
designation | string | A runway designation. |
Returns
undefined
| OneWayRunway
The one-way runway which matches the designation, or undefined if no match could be found.
matchOneWayRunwayFromIdent()
static
matchOneWayRunwayFromIdent(airport
,ident
):undefined
|OneWayRunway
Defined in: src/sdk/navigation/RunwayUtils.ts:304
Gets a one-way runway from an airport that matches a runway ident.
Parameters
Parameter | Type | Description |
---|---|---|
airport | AirportFacility | The airport facility in which to search for the match. |
ident | string | A runway ident. |
Returns
undefined
| OneWayRunway
The one-way runway which matches the ident, or undefined if no match could be found.
sortRunways()
static
sortRunways(r1
,r2
):number
Defined in: src/sdk/navigation/RunwayUtils.ts:449
A comparer for sorting runways by number, and then by L, C, and R.
Parameters
Parameter | Type | Description |
---|---|---|
r1 | OneWayRunway | The first runway to compare. |
r2 | OneWayRunway | The second runway to compare. |
Returns
number
-1 if the first is before, 0 if equal, 1 if the first is after.