Class: ApproachUtils

Defined in: src/sdk/navigation/ApproachUtils.ts:15

A utility class for working with approach procedures.

Constructors

Constructor

new ApproachUtils(): ApproachUtils

Returns

ApproachUtils

Methods

emptyIdentifier()

static emptyIdentifier(): ApproachIdentifier

Defined in: src/sdk/navigation/ApproachUtils.ts:69

Creates an empty approach identifier.

Returns

ApproachIdentifier

An empty approach identifier.

---

getBestRnavType()

static getBestRnavType(query): RnavTypeFlags

Defined in: src/sdk/navigation/ApproachUtils.ts:122

Gets the best RNAV minimum type available for a given approach.

Parameters

Parameter	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.

---

getFafOriginIcao()

static getFafOriginIcao(approach): undefined | string

Defined in: src/sdk/navigation/ApproachUtils.ts:192

Gets the origin facility ICAO for the FAF leg of an approach. The facility type is not checked against the approach type to ensure it is valid, in contrast to getReferenceFacility which does perform these checks.

Parameters

Parameter	Type	Description
approach	ApproachProcedure	The approach for which to get a reference facility.

Returns

undefined | string

The ICAO of the origin facility for the FAF leg of the specified approach, or undefined if one could not be found.

---

getFrequencyFromAirport()

Call Signature

static getFrequencyFromAirport(facility, approach): undefined | FacilityFrequency

Defined in: src/sdk/navigation/ApproachUtils.ts:155

Gets an approach frequency from its parent airport facility record.

Parameters

Parameter	Type	Description
facility	AirportFacility	The approach's parent airport facility.
approach	ApproachProcedure	The approach for which to get a frequency.

Returns

undefined | FacilityFrequency

The frequency of the specified approach, or undefined if one could not be found.

Call Signature

static getFrequencyFromAirport(facility, approachIndex): undefined | FacilityFrequency

Defined in: src/sdk/navigation/ApproachUtils.ts:162

Gets an approach frequency from its parent airport facility record.

Parameters

Parameter	Type	Description
facility	AirportFacility	The approach's parent airport facility.
approachIndex	number	The index of the approach for which to get a frequency.

Returns

undefined | FacilityFrequency

The frequency of the specified approach, or undefined if one could not be found.

---

getIdentifier()

static getIdentifier(approach, out): ApproachIdentifier

Defined in: src/sdk/navigation/ApproachUtils.ts:96

Gets the identifier corresponding to an approach procedure.

Parameters

Parameter	Type	Description
approach	ApproachProcedure	The approach procedure for which to get an identifier.
out	ApproachIdentifier	The object to which to write the result. If not defined, then a new identifier object will be created.

Returns

ApproachIdentifier

The identifier corresponding to the specified approach procedure.

---

getReferenceFacility()

static getReferenceFacility(approach, facLoader): Promise<undefined | VorFacility | NdbFacility>

Defined in: src/sdk/navigation/ApproachUtils.ts:220

Gets the reference facility for an approach. Only ILS, LOC (BC), LDA, SDF, VOR(DME), and NDB(DME) approaches can have reference facilities.

Parameters

Parameter	Type	Description
approach	ApproachProcedure	The approach for which to get a reference facility.
facLoader	FacilityLoader	The facility loader.

Returns

Promise<undefined | VorFacility | NdbFacility>

A Promise which is fulfilled with the reference facility for the specified approach, or undefined if one could not be found.

---

identifierEquals()

static identifierEquals(a, b): boolean

Defined in: src/sdk/navigation/ApproachUtils.ts:110

Checks whether two approach identifiers are equal.

Parameters

Parameter	Type	Description
a	{ __Type: "JS_ApproachIdentifier"; runway: { __Type: "JS_RunwayIdentifier"; designator: string; number: string; }; suffix: string; type: string; }	The first identifier.
a.__Type	"JS_ApproachIdentifier"	Coherent C++ object binding type.
a.runway	{ __Type: "JS_RunwayIdentifier"; designator: string; number: string; }	The approach's associated runway.
a.runway.__Type	"JS_RunwayIdentifier"	Coherent C++ object binding type.
a.runway.designator	string	The designator of the runway.
a.runway.number	string	The number of the runway.
a.suffix	string	The suffix of the approach.
a.type	string	The type name of the approach.
b	{ __Type: "JS_ApproachIdentifier"; runway: { __Type: "JS_RunwayIdentifier"; designator: string; number: string; }; suffix: string; type: string; }	The second identifier.
b.__Type	"JS_ApproachIdentifier"	Coherent C++ object binding type.
b.runway	{ __Type: "JS_RunwayIdentifier"; designator: string; number: string; }	The approach's associated runway.
b.runway.__Type	"JS_RunwayIdentifier"	Coherent C++ object binding type.
b.runway.designator	string	The designator of the runway.
b.runway.number	string	The number of the runway.
b.suffix	string	The suffix of the approach.
b.type	string	The type name of the approach.

Returns

boolean

Whether the two specified approach identifiers are equal.

---

isRnpAr()

static isRnpAr(approach): boolean

Defined in: src/sdk/navigation/ApproachUtils.ts:145

Checks whether an approach procedure is an RNP (AR) approach.

Parameters

Parameter	Type	Description
approach	ApproachProcedure	The approach procedure to check.

Returns

boolean

Whether the approach procedure is an RNP (AR) approach.

---

nameToType()

static nameToType(name): ExtendedApproachType

Defined in: src/sdk/navigation/ApproachUtils.ts:22

Converts an approach type name to its corresponding approach type.

Parameters

Parameter	Type	Description
name	string	The name to convert.

Returns

ExtendedApproachType

The approach type corresponding to the specified name.

---

toEmptyIdentifier()

static toEmptyIdentifier(ident): ApproachIdentifier

Defined in: src/sdk/navigation/ApproachUtils.ts:83

Sets an approach identifier to be empty.

Parameters

Parameter	Type	Description
ident	ApproachIdentifier	The identifier to set.

Returns

ApproachIdentifier

The specified identifier, after it has been set to be empty.

---

typeToName()

static typeToName(type): string

Defined in: src/sdk/navigation/ApproachUtils.ts:46

Converts an approach type to its corresponding approach type name.

Parameters

Parameter	Type	Description
type	ExtendedApproachType	The type to convert.

Returns

string

The approach type name corresponding to the specified type.