Skip to main content

Class: NearestLodBoundarySearchSession

A nearest search session for boundaries (airspaces) in the form of LodBoundary objects.

Constructors

constructor

new NearestLodBoundarySearchSession(cache, session, frameBudget): NearestLodBoundarySearchSession

Constructor.

Parameters

NameTypeDescription
cacheLodBoundaryCacheThe boundary cache this search session uses.
sessionNearestBoundarySearchSessionThe nearest boundary facility search session this search session uses.
frameBudgetnumberThe maximum amount of time allotted per frame to retrieve and process LodBoundary objects, in milliseconds.

Returns

NearestLodBoundarySearchSession

Defined in

src/sdk/navigation/NearestLodBoundarySearchSession.ts:28

Properties

frameBudget

Readonly frameBudget: number

The maximum amount of time allotted per frame to retrieve and process LodBoundary objects, in milliseconds.

Defined in

src/sdk/navigation/NearestLodBoundarySearchSession.ts:31

Methods

searchNearest

searchNearest(lat, lon, radius, maxItems): Promise<NearestLodBoundarySearchResults>

Searches for the nearest boundaries around a specified location.

Parameters

NameTypeDescription
latnumberThe latitude of the search center, in degrees.
lonnumberThe longitude of the search center, in degrees.
radiusnumberThe radius of the search, in meters.
maxItemsnumberThe maximum number of items for which to search.

Returns

Promise<NearestLodBoundarySearchResults>

The nearest search results.

Defined in

src/sdk/navigation/NearestLodBoundarySearchSession.ts:43


setFilter

setFilter(classMask): void

Sets this session's boundary class filter. The new filter takes effect with the next search executed in this session.

Parameters

NameTypeDescription
classMasknumberA bitmask defining the boundary classes to include in the search (0: exclude, 1: include). The bit index for each boundary class is equal to the value of the corresponding BoundaryType enum.

Returns

void

Defined in

src/sdk/navigation/NearestLodBoundarySearchSession.ts:63