Skip to main content

Class: AirwayBuilder

The Airway Builder.

Constructors

constructor

new AirwayBuilder(_initialWaypoint, _initialData, facilityLoader): AirwayBuilder

Creates an instance of the AirwayBuilder

Parameters

NameTypeDescription
_initialWaypointIntersectionFacilityis the initial intersection facility
_initialDataAirwaySegmentis the intersection route to build from
facilityLoaderFacilityLoaderis an instance of the facility loader

Returns

AirwayBuilder

Defined in

src/sdk/navigation/FacilityLoader.ts:1014

Accessors

hasStarted

get hasStarted(): boolean

Get whether this builder has started loading waypoints

Returns

boolean

whether this builder has started

Defined in

src/sdk/navigation/FacilityLoader.ts:1023


isDone

get isDone(): boolean

Get whether this builder is done loading waypoints

Returns

boolean

whether this builder is done loading waypoints

Defined in

src/sdk/navigation/FacilityLoader.ts:1031


waypoints

get waypoints(): null | IntersectionFacility[]

Get the airway waypoints

Returns

null | IntersectionFacility[]

the airway waypoints, or null

Defined in

src/sdk/navigation/FacilityLoader.ts:1039

Methods

_step

_step(stepForward, arrayInsertFunc): Promise<void>

Steps through the airway waypoints

Parameters

NameTypeDescription
stepForwardbooleanis the direction to step; true = forward, false = backward
arrayInsertFunc(wpt: IntersectionFacility) => voidis the arrayInsertFunc

Returns

Promise<void>

Defined in

src/sdk/navigation/FacilityLoader.ts:1047


_stepBackward

_stepBackward(): Promise<void>

Steps Backward through the airway waypoints

Returns

Promise<void>

the step backward function

Defined in

src/sdk/navigation/FacilityLoader.ts:1080


_stepForward

_stepForward(): Promise<void>

Steps Forward through the airway waypoints

Returns

Promise<void>

the step forward function

Defined in

src/sdk/navigation/FacilityLoader.ts:1071


setWaypointsArray

setWaypointsArray(array): void

Sets the array into which this builder will load waypoints.

Parameters

NameTypeDescription
arrayIntersectionFacility[]is the array into which the builder will load waypoints

Returns

void

Defined in

src/sdk/navigation/FacilityLoader.ts:1090


startBuild

startBuild(): Promise<AirwayStatus>

Begins loading waypoints for this builder's parent airway.

Returns

Promise<AirwayStatus>

a Promise to return a status code corresponding to Airway.Status when this builder has finished loading waypoints.

Defined in

src/sdk/navigation/FacilityLoader.ts:1099