Class: FlightPlanLegIterator
Defined in: src/sdk/flightplan/FlightPlanLegIterator.ts:25
A Utility Class that supports iterating through a flight plan either forward or reverse.
Constructors
Constructor
new FlightPlanLegIterator():
FlightPlanLegIterator
Returns
FlightPlanLegIterator
Methods
isBusy()
isBusy():
boolean
Defined in: src/sdk/flightplan/FlightPlanLegIterator.ts:40
Method that checks whether the FlightPlanLegIterator is busy.
Returns
boolean
Whether the cursor is busy.
iterateForward()
iterateForward(
lateralPlan,each):void
Defined in: src/sdk/flightplan/FlightPlanLegIterator.ts:93
Iterates through the active flight plan in forward order.
Parameters
| Parameter | Type | Description |
|---|---|---|
lateralPlan | FlightPlan | The lateral flight plan to iterate through. |
each | (data) => void | The function to call for each flight plan leg. |
Returns
void
Throws
an Error if the cursor is busy.
iterateReverse()
iterateReverse(
lateralPlan,each):void
Defined in: src/sdk/flightplan/FlightPlanLegIterator.ts:50
Iterates through the active flight plan in reverse order.
Parameters
| Parameter | Type | Description |
|---|---|---|
lateralPlan | FlightPlan | The lateral flight plan to iterate through. |
each | (data) => void | The function to call for each flight plan leg. |
Returns
void
Throws
an Error if the cursor is busy.