Class: NearestVorSubscription

Defined in: src/sdk/navigation/NearestSubscription.ts:599

A nearest search subscription for VOR facilites.

Extends

• NearestWaypointSubscription<VorFacility>

Constructors

Constructor

new NearestVorSubscription(facilityLoader): NearestVorSubscription

Defined in: src/sdk/navigation/NearestSubscription.ts:604

Creates a new instance of NearestVorSubscription.

Parameters

Parameter	Type	Description
facilityLoader	FacilityLoader	The facility loader to use with this instance.

Returns

NearestVorSubscription

Overrides

NearestWaypointSubscription<VorFacility>.constructor

Properties

facilities

protected readonly facilities: VorFacility[] = []

Defined in: src/sdk/navigation/NearestSubscription.ts:70

Inherited from

NearestWaypointSubscription.facilities

---

facilityCache

protected readonly facilityCache: Map<string, VorFacility>

Defined in: src/sdk/navigation/NearestSubscription.ts:237

Inherited from

NearestWaypointSubscription.facilityCache

---

facilityClient

protected readonly facilityClient: FacilityClient

Defined in: src/sdk/navigation/NearestSubscription.ts:88

The client from which to retrieve facilities.

Inherited from

NearestWaypointSubscription.facilityClient

---

facilityIndex

protected readonly facilityIndex: Map<string, VorFacility>

Defined in: src/sdk/navigation/NearestSubscription.ts:71

Inherited from

NearestWaypointSubscription.facilityIndex

---

facilityType

protected readonly facilityType: undefined | FacilityType

Defined in: src/sdk/navigation/NearestSubscription.ts:232

Inherited from

NearestWaypointSubscription.facilityType

---

filterCb()?

protected optional filterCb: (facility) => boolean

Defined in: src/sdk/navigation/NearestSubscription.ts:236

Parameters

Parameter	Type
facility	VorFacility

Returns

boolean

Inherited from

NearestWaypointSubscription.filterCb

---

icaos

protected readonly icaos: Map<string, IcaoValue>

Defined in: src/sdk/navigation/NearestSubscription.ts:234

Inherited from

NearestWaypointSubscription.icaos

---

initialNotifyFunc()

protected readonly initialNotifyFunc: (sub) => void

Defined in: src/sdk/sub/AbstractSubscribableArray.ts:20

A function which sends initial notifications to subscriptions.

Notifies a subscription of this array's current state.

Parameters

Parameter	Type	Description
sub	HandlerSubscription<SubscribableArrayHandler<VorFacility>>	The subscription to notify.

Returns

void

Inherited from

NearestWaypointSubscription.initialNotifyFunc

---

notifyDepth

protected notifyDepth: number = 0

Defined in: src/sdk/sub/AbstractSubscribableArray.ts:17

Inherited from

NearestWaypointSubscription.notifyDepth

---

onSubDestroyedFunc()

protected readonly onSubDestroyedFunc: (sub) => void

Defined in: src/sdk/sub/AbstractSubscribableArray.ts:23

A function which responds to when a subscription to this subscribable is destroyed.

Responds to when a subscription to this array is destroyed.

Parameters

Parameter	Type	Description
sub	HandlerSubscription<SubscribableArrayHandler<VorFacility>>	The destroyed subscription.

Returns

void

Inherited from

NearestWaypointSubscription.onSubDestroyedFunc

---

session

protected session: undefined | NearestSearchSession<IcaoValue, IcaoValue>

Defined in: src/sdk/navigation/NearestSubscription.ts:73

Inherited from

NearestWaypointSubscription.session

---

singletonSub?

protected optional singletonSub: HandlerSubscription<SubscribableArrayHandler<VorFacility>>

Defined in: src/sdk/sub/AbstractSubscribableArray.ts:14

Inherited from

NearestWaypointSubscription.singletonSub

---

startPromiseResolves

protected readonly startPromiseResolves: () => void[] = []

Defined in: src/sdk/navigation/NearestSubscription.ts:75

Returns

void

Inherited from

NearestWaypointSubscription.startPromiseResolves

---

subs?

protected optional subs: HandlerSubscription<SubscribableArrayHandler<VorFacility>>[]

Defined in: src/sdk/sub/AbstractSubscribableArray.ts:16

Inherited from

NearestWaypointSubscription.subs

---

type

protected readonly type: All | Airport | Intersection | Vor | Ndb | User | Visual | AllExceptVisual

Defined in: src/sdk/navigation/NearestSubscription.ts:89

The type of facility to search for.

Inherited from

NearestWaypointSubscription.type

---

updatePromiseResolves

protected readonly updatePromiseResolves: () => void[] = []

Defined in: src/sdk/navigation/NearestSubscription.ts:76

Returns

void

Inherited from

NearestWaypointSubscription.updatePromiseResolves

Accessors

length

Get Signature

get length(): number

Defined in: src/sdk/navigation/NearestSubscription.ts:95

Inherit Doc

Returns

number

Inherited from

NearestWaypointSubscription.length

---

started

Get Signature

get started(): boolean

Defined in: src/sdk/navigation/NearestSubscription.ts:103

Whether or not this subscription has been started.

Returns

boolean

True if started, false otherwise.

Inherited from

NearestWaypointSubscription.started

Methods

addFacility()

protected addFacility(facility, key): void

Defined in: src/sdk/navigation/NearestSubscription.ts:198

Adds a facility to the collection.

Parameters

Parameter	Type	Description
facility	VorFacility	The facility to add.
key	string	The key to track this facility by.

Returns

void

Inherited from

NearestWaypointSubscription.addFacility

---

addSubscription()

protected addSubscription(sub): void

Defined in: src/sdk/sub/AbstractSubscribableArray.ts:29

Adds a subscription to this array.

Parameters

Parameter	Type	Description
sub	HandlerSubscription<SubscribableArrayHandler<VorFacility>>	The subscription to add.

Returns

void

Inherited from

NearestWaypointSubscription.addSubscription

---

awaitStart()

awaitStart(): Promise<void>

Defined in: src/sdk/navigation/NearestSubscription.ts:113

Returns

Promise<void>

Inherit Doc

Inherited from

NearestWaypointSubscription.awaitStart

---

doUpdate()

protected doUpdate(lat, lon, radius, maxItems): Promise<void>

Defined in: src/sdk/navigation/NearestSubscription.ts:171

Executes an update of the nearest search subscription.

Parameters

Parameter	Type	Description
lat	number	The latitude of the current search position.
lon	number	The longitude of the current search position.
radius	number	The radius of the search, in meters.
maxItems	number	The maximum number of items to return in the search.

Returns

Promise<void>

Inherited from

NearestWaypointSubscription.doUpdate

---

get()

get(index): VorFacility

Defined in: src/sdk/sub/AbstractSubscribableArray.ts:64

Gets an item from the array.

Parameters

Parameter	Type	Description
index	number	Thex index of the item to get.

Returns

VorFacility

An item.

Throws

Inherited from

NearestWaypointSubscription.get

---

getArray()

getArray(): readonly VorFacility[]

Defined in: src/sdk/navigation/NearestSubscription.ts:108

Returns

readonly VorFacility[]

Inherit Doc

Inherited from

NearestWaypointSubscription.getArray

---

getFacilities()

protected getFacilities(icaos): Promise<(null | VorFacility)[]>

Defined in: src/sdk/navigation/NearestSubscription.ts:330

Retrieves facilities for an array of ICAOs.

Parameters

Parameter	Type	Description
icaos	readonly IcaoValue[]	The ICAOs for which to get facilities.

Returns

Promise<(null | VorFacility)[]>

A Promise which will be fulfilled with an array of facilities corresponding to the specified ICAOs. Each position in the facilities array will contain either the facility for the ICAO at the corresponding position in the ICAO array, or null if a facility for that ICAO could not be retrieved.

Inherited from

NearestWaypointSubscription.getFacilities

---

initialNotify()

protected initialNotify(sub): void

Defined in: src/sdk/sub/AbstractSubscribableArray.ts:163

Notifies a subscription of this array's current state.

Parameters

Parameter	Type	Description
sub	HandlerSubscription<SubscribableArrayHandler<VorFacility>>	The subscription to notify.

Returns

void

Inherited from

NearestWaypointSubscription.initialNotify

---

notify()

protected notify(index, type, modifiedItem?): void

Defined in: src/sdk/sub/AbstractSubscribableArray.ts:87

Notifies subscriptions of a change in the array.

Parameters

Parameter	Type	Description
index	number	The index that was changed.
type	SubscribableArrayEventType	The type of subject event.
modifiedItem?	VorFacility | readonly VorFacility[]	The item modified by the operation.

Returns

void

Inherited from

NearestWaypointSubscription.notify

---

onResults()

protected onResults(results): Promise<void>

Defined in: src/sdk/navigation/NearestSubscription.ts:295

Parameters

Parameter	Type
results	NearestSearchResults<IcaoValue, IcaoValue>

Returns

Promise<void>

Inherit Doc

Inherited from

NearestWaypointSubscription.onResults

---

onSubDestroyed()

protected onSubDestroyed(sub): void

Defined in: src/sdk/sub/AbstractSubscribableArray.ts:172

Responds to when a subscription to this array is destroyed.

Parameters

Parameter	Type	Description
sub	HandlerSubscription<SubscribableArrayHandler<VorFacility>>	The destroyed subscription.

Returns

void

Inherited from

NearestWaypointSubscription.onSubDestroyed

---

refilter()

protected refilter(): void

Defined in: src/sdk/navigation/NearestSubscription.ts:269

Refilters the latest search results returned from this subscription's nearest search session.

Returns

void

Inherited from

NearestWaypointSubscription.refilter

---

removeFacility()

protected removeFacility(key): void

Defined in: src/sdk/navigation/NearestSubscription.ts:213

Removes a facility from the collection.

Parameters

Parameter	Type	Description
key	string	The key of the facility to remove.

Returns

void

Inherited from

NearestWaypointSubscription.removeFacility

---

setFilterCb()

setFilterCb(filter): void

Defined in: src/sdk/navigation/NearestSubscription.ts:261

Sets this subscription's post-search session filter and refilters this subscription's latest results using the new filter.

Parameters

Parameter	Type	Description
filter	undefined | (facility) => boolean	A function which filters results after they have been returned by this subscription's search session, or undefined if no post-search session filtering is to be performed.

Returns

void

Inherited from

NearestWaypointSubscription.setFilterCb

---

setVorFilter()

setVorFilter(classMask, typeMask): void

Defined in: src/sdk/navigation/NearestSubscription.ts:613

Sets the VOR search filter.

Parameters

Parameter	Type	Description
classMask	number	A bitmask to determine which JS VOR classes to show.
typeMask	number	A bitmask to determine which JS VOR types to show.

Returns

void

---

start()

start(): Promise<void>

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

Returns

Promise<void>

Inherit Doc

Inherited from

NearestWaypointSubscription.start

---

startSearchSession()

protected startSearchSession(): Promise<NearestSearchSession<IcaoValue, IcaoValue>>

Defined in: src/sdk/navigation/NearestSubscription.ts:290

Returns

Promise<NearestSearchSession<IcaoValue, IcaoValue>>

Inherit Doc

Inherited from

NearestWaypointSubscription.startSearchSession

---

sub()

sub(handler, initialNotify, paused): Subscription

Defined in: src/sdk/sub/AbstractSubscribableArray.ts:41

Parameters

Parameter	Type	Default value
handler	SubscribableArrayHandler<VorFacility>	undefined
initialNotify	boolean	false
paused	boolean	false

Returns

Subscription

Inherit Doc

Inherited from

NearestWaypointSubscription.sub

---

tryGet()

tryGet(index): undefined | VorFacility

Defined in: src/sdk/sub/AbstractSubscribableArray.ts:77

Tries to get the value from the array.

Parameters

Parameter	Type	Description
index	number	The index of the item to get.

Returns

undefined | VorFacility

The value or undefined if not found.

Inherited from

NearestWaypointSubscription.tryGet

---

update()

update(lat, lon, radius, maxItems): Promise<void>

Defined in: src/sdk/navigation/NearestSubscription.ts:152

Parameters

Parameter	Type
lat	number
lon	number
radius	number
maxItems	number

Returns

Promise<void>

Inherit Doc

Inherited from

NearestWaypointSubscription.update