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