Class: WT21Fms

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21Fms.ts:39

WTLineFms with legacy functionality for the WT21, for backwards compatibility

Extends

• WTLineFms<WTLineLegacyFlightPlanIndexTypes>

Constructors

Constructor

new WT21Fms(bus, facLoader, flightPlanner, fmsPos, verticalPathCalculator, messageService, fixInfo): WT21Fms

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21Fms.ts:130

Initialize an instance of the FMS for the WT21.

Parameters

Parameter	Type	Description
bus	EventBus	is the event bus
facLoader	FacilityLoader	The facility loader.
flightPlanner	FlightPlanner	is the flight planner
fmsPos	FmsPos	is the FMS position system
verticalPathCalculator	SmoothingPathCalculator	is the VNAV Path Calculator.
messageService	MessageService	is the message service.
fixInfo	WT21FixInfoManager	The fix info manager.

Returns

WT21Fms

Overrides

WTLineFms<WTLineLegacyFlightPlanIndexTypes>.constructor

Properties

approachDetails

approachDetails: ApproachDetails

Defined in: wtlinesdk/fms/WTLineFms.ts:101

Inherited from

WTLineFms.approachDetails

---

basePerformanceManager

readonly basePerformanceManager: BasePerformanceDataManager

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21Fms.ts:82

---

bus

readonly bus: EventBus

Defined in: wtlinesdk/fms/WTLineFms.ts:156

is the event bus

Inherited from

WTLineFms.bus

---

facilityInfo

facilityInfo: FacilityInfo

Defined in: wtlinesdk/fms/WTLineFms.ts:96

Information on our origin, arrival and destination facilities to save lookups. When in MOD, this will reflect the current origin and destination in the MOD plan.

Deprecated

look facilities up using facLoader instead - they are cached anyway, and this does not support the secondary plan

Inherited from

WTLineFms.facilityInfo

---

facLoader

readonly facLoader: FacilityLoader

Defined in: wtlinesdk/fms/WTLineFms.ts:157

The facility loader.

Inherited from

WTLineFms.facLoader

---

fixInfo

readonly fixInfo: WT21FixInfoManager

Defined in: wtlinesdk/fms/WTLineFms.ts:160

The fix info manager.

Inherited from

WTLineFms.fixInfo

---

flightPlanner

readonly flightPlanner: FlightPlanner

Defined in: wtlinesdk/fms/WTLineFms.ts:158

is the flight planner

Inherited from

WTLineFms.flightPlanner

---

flightPlanRepo

protected readonly flightPlanRepo: WTLineFlightPlanRepository<WTLineLegacyFlightPlans, WTLineLegacyMainFlightPlan>

Defined in: wtlinesdk/fms/WTLineFms.ts:161

The flight plan repository.

Inherited from

WTLineFms.flightPlanRepo

---

fmsPos

readonly fmsPos: FmsPos

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21Fms.ts:135

Deprecated

get the FMS position from outside this class

---

lnavLegDistanceAlong

readonly lnavLegDistanceAlong: Accessible<number>

Defined in: wtlinesdk/fms/WTLineFms.ts:143

Inherited from

WTLineFms.lnavLegDistanceAlong

---

lnavLegDistanceRemaining

readonly lnavLegDistanceRemaining: Accessible<number>

Defined in: wtlinesdk/fms/WTLineFms.ts:144

Inherited from

WTLineFms.lnavLegDistanceRemaining

---

lnavTrackedLegIndex

readonly lnavTrackedLegIndex: Accessible<number>

Defined in: wtlinesdk/fms/WTLineFms.ts:142

Inherited from

WTLineFms.lnavTrackedLegIndex

---

messageService

readonly messageService: MessageService

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21Fms.ts:138

Deprecated

get the message service from outside this class

---

performancePlanProxy

readonly performancePlanProxy: PerformancePlanProxy

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21Fms.ts:46

Proxy to the currently relevant performance plan. This allows subbing to subscribables that always point to the right value, whether we are in ACT or MOD, without worrying about switching around subscriptions.

---

planInMod

readonly planInMod: MutableSubscribable<boolean, boolean>

Defined in: wtlinesdk/fms/WTLineFms.ts:72

Set to true by FMC pages when the plan on this FMS instance is in modification and awaiting a cancel or exec.

Inherited from

WTLineFms.planInMod

---

ppos

readonly ppos: GeoPoint

Defined in: wtlinesdk/fms/WTLineFms.ts:79

Inherited from

WTLineFms.ppos

---

remotePlanInMod

remotePlanInMod: boolean = false

Defined in: wtlinesdk/fms/WTLineFms.ts:75

Set to true when an event is received from the bus indicating that another instrument is in MOD on the plan.

Inherited from

WTLineFms.remotePlanInMod

---

userFacilities

readonly userFacilities: ExistingUserWaypointsArray

Defined in: wtlinesdk/fms/WTLineFms.ts:83

Inherited from

WTLineFms.userFacilities

---

verticalDtoWasCreatedInModPlan

verticalDtoWasCreatedInModPlan: boolean = false

Defined in: wtlinesdk/fms/WTLineFms.ts:132

Set to true when a new vertical DTO is created, meaning its origin should be regularly updated while in MOD and when hitting EXEC. Should be reset whenever leaving MOD.

Inherited from

WTLineFms.verticalDtoWasCreatedInModPlan

---

verticalDtoWasCreatedInModPlanWasAutomatic

verticalDtoWasCreatedInModPlanWasAutomatic: boolean = false

Defined in: wtlinesdk/fms/WTLineFms.ts:138

Set to true when the vertical DTO in the mod flight plan was automatic

Inherited from

WTLineFms.verticalDtoWasCreatedInModPlanWasAutomatic

---

verticalPathCalculator

readonly verticalPathCalculator: SmoothingPathCalculator

Defined in: wtlinesdk/fms/WTLineFms.ts:159

is the VNAV Path Calculator.

Inherited from

WTLineFms.verticalPathCalculator

Accessors

activePerformancePlan

Get Signature

get activePerformancePlan(): PerformancePlan

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21Fms.ts:78

Returns the active performance plan

Returns

PerformancePlan

the performance plan for the active flight plan index

Methods

activateApproach()

activateApproach(): void

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21Fms.ts:407

Activates an approach. Activating an approach activates a Direct To to the first approach waypoint of the primary flight plan, and attempts to load the primary approach frequency (if one exists) to the nav radios. If the primary flight plan does not have an approach loaded, this method has no effect.

Returns

void

Deprecated

unused, not applicable

---

activateLeg()

activateLeg(segmentIndex, legIndex, removeExistingDTO): void

Defined in: wtlinesdk/fms/WTLineFms.ts:2943

Method to activate a leg in the flight plan.

Parameters

Parameter	Type	Default value	Description
segmentIndex	number	undefined	is the index of the segment containing the leg to activate.
legIndex	number	undefined	is the index of the leg in the selected segment activate.
removeExistingDTO	boolean	true	Whether to check for and remove the existing direct to legs.

Returns

void

Inherited from

WTLineFms.activateLeg

---

activateSecondaryPlan()

activateSecondaryPlan(): void

Defined in: wtlinesdk/fms/WTLineFms.ts:368

Activates the secondary flight plan.

Returns

void

Inherited from

WTLineFms.activateSecondaryPlan

---

activateVtf()

activateVtf(): Promise<void>

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21Fms.ts:443

Activates vectors-to-final. Activating vectors-to-final activates the primary flight plan's vectors-to-final leg, and attempts to load the primary approach frequency (if one exists) to the nav radios. If the primary flight plan has a non-VTF approach loaded, it will be replaced by its VTF counterpart. If the primary flight plan has no approach loaded, this method has no effect.

Returns

Promise<void>

Deprecated

unused, not applicable

---

addUserFacility()

addUserFacility(userFacility): void

Defined in: wtlinesdk/fms/WTLineFms.ts:777

Adds a user facility.

Parameters

Parameter	Type	Description
userFacility	UserFacility	the facility to add.

Returns

void

Inherited from

WTLineFms.addUserFacility

---

canActivateApproach()

canActivateApproach(): boolean

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21Fms.ts:430

Checks whether an approach can be activated. An approach can be activated if and only if the primary flight plan has a non-vectors-to-final approach loaded.

Returns

boolean

Whether an approach can be activated.

Deprecated

unused, not applicable

---

canActivateLeg()

canActivateLeg(segmentIndex, segmentLegIndex): boolean

Defined in: wtlinesdk/fms/WTLineFms.ts:617

Checks whether a leg in the primary flight plan can be manually activated.

Parameters

Parameter	Type	Description
segmentIndex	number	The index of the segment in which the leg resides.
segmentLegIndex	number	The index of the leg in its segment.

Returns

boolean

Whether the leg can be manually activated.

Inherited from

WTLineFms.canActivateLeg

---

canActivateVtf()

canActivateVtf(): boolean

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21Fms.ts:418

Checks whether vectors-to-final can be activated. VTF can be activated if and only if the primary flight plan has an approach loaded.

Returns

boolean

Whether vectors-to-final can be activated.

Deprecated

unused, not applicable

---

canApproachLoad()

canApproachLoad(): boolean

Defined in: wtlinesdk/fms/WTLineFms.ts:2133

Method to check whether an approach can load, or only activate.

Returns

boolean

true if the approach can be loaded and not activated, otherwise the approach can only be immediatly activated.

Inherited from

WTLineFms.canApproachLoad

---

cancelMod()

cancelMod(): void

Defined in: wtlinesdk/fms/WTLineFms.ts:382

Handles when the CANCEL MOD button is pressed.

FIXME make work with multiple plans

Returns

void

Inherited from

WTLineFms.cancelMod

---

canDirectTo()

canDirectTo(segmentIndex, segmentLegIndex): boolean

Defined in: wtlinesdk/fms/WTLineFms.ts:663

Checks whether a leg in the primary flight plan is a valid direct to target.

Parameters

Parameter	Type	Description
segmentIndex	number	The index of the segment in which the leg resides.
segmentLegIndex	number	The index of the leg in its segment.

Returns

boolean

Whether the leg is a valid direct to target.

Throws

Error if a leg could not be found at the specified location.

Inherited from

WTLineFms.canDirectTo

---

canEditPlan()

canEditPlan(mainPlanIndex): boolean

Defined in: wtlinesdk/fms/WTLineFms.ts:440

Checks whether the plan can go into MOD/be edited on this instance of WT21Fms.

Parameters

Parameter	Type	Default value	Description
mainPlanIndex	WTLineLegacyMainFlightPlan	WTLineLegacyFlightPlans.Active	the main plan index to query

Returns

boolean

Whether to allow plan edits or not

Inherited from

WTLineFms.canEditPlan

---

canMissedApproachActivate()

canMissedApproachActivate(): boolean

Defined in: wtlinesdk/fms/WTLineFms.ts:2963

Method to check if there is a currently loaded missed approach to be activated.

Returns

boolean

whether the approach can activate

Inherited from

WTLineFms.canMissedApproachActivate

---

changeAirwayAtSegment()

changeAirwayAtSegment(planIndex, segmentIndex, airway): Promise<boolean>

Defined in: wtlinesdk/fms/WTLineFms.ts:3443

Changes the airway present at an already existing segment, replacing its legs with the correct intermediary waypoints.

Parameters

Parameter	Type	Description
planIndex	WTLineLegacyFlightPlans	Is the index of the plan to target the edit to.
segmentIndex	number	Is the segment index for the entry leg.
airway	AirwayData	The airway object.

Returns

Promise<boolean>

whether the airway could correctly be inserted with the existing entry and exit fixes

Inherited from

WTLineFms.changeAirwayAtSegment

---

clearApproachDetails()

protected clearApproachDetails(): void

Defined in: wtlinesdk/fms/WTLineFms.ts:4953

Clears the approach details

Returns

void

Inherited from

WTLineFms.clearApproachDetails

---

copyActivePlanIntoSecondaryPlan()

copyActivePlanIntoSecondaryPlan(): void

Defined in: wtlinesdk/fms/WTLineFms.ts:361

Copies the active flight plan into the secondary flight plan.

Returns

void

Inherited from

WTLineFms.copyActivePlanIntoSecondaryPlan

---

createDirectTo()

createDirectTo(segmentIndex?, segmentLegIndex?, isNewDTO?, course?, facility?): void

Defined in: wtlinesdk/fms/WTLineFms.ts:3001

Method to create a direct to in the plan. This method will also then call activateLeg. A DTO consists of 4 legs:

1. The original leg that was used to create the DTO. a. We preserve this leg so that we will have a vlid FROM leg in case the DTO needs to be removed.
2. A DISCO leg, because a DTO is not connected to any legs that came before it.
3. The FROM leg, initializes to the present position (PPOS).
4. The TO leg.

Parameters

Parameter	Type	Default value	Description
segmentIndex?	number	undefined	is the index of the segment containing the leg to activate as direct to.
segmentLegIndex?	number	undefined	is the index of the leg in the specified segment to activate as direct to.
isNewDTO?	boolean	true	whether to treat this as a new directo to or not.
course?	number	undefined	is the course for this direct to in degrees magnetic, if specified.
facility?	Facility	undefined	is the new facility to add to the plan and then create a direct to for, for the case of a direct to random.

Returns

void

Inherited from

WTLineFms.createDirectTo

---

createDirectToAirport()

createDirectToAirport(airportFacility): void

Defined in: wtlinesdk/fms/WTLineFms.ts:3126

Method to create a direct to in the flight plan to an arbitrary airport.

This:

• empties out the flight plan;
• sets the destination as the provided airport facility;
• creates a direct-to sequence to that facility.

Parameters

Parameter	Type	Description
airportFacility	AirportFacility	the airport facility to go direct to

Returns

void

Inherited from

WTLineFms.createDirectToAirport

---

createDirectToExistingNextValidLeg()

createDirectToExistingNextValidLeg(globalLegIndex): boolean

Defined in: wtlinesdk/fms/WTLineFms.ts:3342

Creates a direct to existing to the next valid leg in the plan after the input global leg index.

Parameters

Parameter	Type	Description
globalLegIndex	number	The global leg index.

Returns

boolean

Whether a direct to existing was created.

Inherited from

WTLineFms.createDirectToExistingNextValidLeg

---

createDirectToRunwayVisualApproach()

createDirectToRunwayVisualApproach(airportFacility, runway): Promise<void>

Defined in: wtlinesdk/fms/WTLineFms.ts:3157

Method to create a direct to in the flight plan to an arbitrary airport+runway using a visual approach.

This:

• empties out the flight plan;
• sets the destination as the provided airport facility;
• inserts a visual approach to the provided runway;
• creates a direct-to sequence to the FAF of that approach.

Parameters

Parameter	Type	Description
airportFacility	AirportFacility	the airport facility to go direct to
runway	OneWayRunway	the one way runway to insert a visual approach for

Returns

Promise<void>

Inherited from

WTLineFms.createDirectToRunwayVisualApproach

---

createVerticalDirectTo()

createVerticalDirectTo(plan, globalIndex, finalAltitude, isAutomatic): boolean

Defined in: wtlinesdk/fms/WTLineFms.ts:3274

Creates a vertical direct-to to a leg. This creates a manual constraint with an fpa that reaches the desired altitude using a continuous descent from the present position and altitude.

NOTE: This will not delete any constraints - it is the responsibility of the caller to do so.

Parameters

Parameter	Type	Default value	Description
plan	FlightPlan	undefined	the plan to use
globalIndex	number	undefined	the global leg index to apply the constraint to
finalAltitude	number	undefined	the altitude to target, in metres.
isAutomatic	boolean	false	whether this was an automatic VDTO (created with a lateral DTO)

Returns

boolean

whether the vdto was successfully created

Inherited from

WTLineFms.createVerticalDirectTo

---

emptyFlightPlanForEdit()

emptyFlightPlanForEdit(mainPlanIndex, notify): void

Defined in: wtlinesdk/fms/WTLineFms.ts:3387

Empties a main flight plan as part of an edit that resets the flight plan, creating a MOD plan

Parameters

Parameter	Type	Default value	Description
mainPlanIndex	WTLineLegacyMainFlightPlan	undefined	the index of the plan to target the edit to
notify	boolean	true	whether to emit sync events

Returns

void

Inherited from

WTLineFms.emptyFlightPlanForEdit

---

emptyModFlightPlan()

emptyModFlightPlan(notify): void

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21Fms.ts:275

Empties the mod flight plan.

Parameters

Parameter	Type	Default value	Description
notify	boolean	false	whether to emit sync events

Returns

void

Deprecated

use emptyFlightPlanForEdit instead

---

emptyPrimaryFlightPlan()

emptyPrimaryFlightPlan(): Promise<void>

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21Fms.ts:262

Empties the primary flight plan.

Returns

Promise<void>

Deprecated

use emptyFlightPlan instead

---

ensureOnlyOneSegmentOfType()

protected ensureOnlyOneSegmentOfType(planIndex, segmentType, insert): number

Defined in: wtlinesdk/fms/WTLineFms.ts:1211

Method to ensure only one segment of a specific type exists in the flight plan and optionally insert it if needed.

Parameters

Parameter	Type	Default value	Description
planIndex	WTLineLegacyFlightPlans	undefined	is the index of the plan to edit.
segmentType	FlightPlanSegmentType	undefined	is the segment type we want to evaluate.
insert	boolean	true	is whether to insert the segment if missing

Returns

number

segmentIndex of the only segment of this type in the flight plan, -1 if insert is false and and the segment does not exist.

Inherited from

WTLineFms.ensureOnlyOneSegmentOfType

---

execModFlightPlan()

execModFlightPlan(): void

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21Fms.ts:459

Returns

void

Inherit Doc

Overrides

WTLineFms.execModFlightPlan

---

findLastEnrouteSegmentIndex()

findLastEnrouteSegmentIndex(plan): number

Defined in: wtlinesdk/fms/WTLineFms.ts:2118

Method to find the last enroute segment of the supplied flight plan.

Parameters

Parameter	Type	Description
plan	FlightPlan	is the flight plan to find the last enroute segment in.

Returns

number

a segment index.

Inherited from

WTLineFms.findLastEnrouteSegmentIndex

---

getActivePerformancePlan()

getActivePerformancePlan(): PerformancePlan

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21Fms.ts:167

Gets the performance plan for the ACT flight plan.

Returns

PerformancePlan

the performance plan

---

getAirwayDistance()

getAirwayDistance(segmentIndex): number

Defined in: wtlinesdk/fms/WTLineFms.ts:1119

Method to get the distance of an airway segment.

Parameters

Parameter	Type	Description
segmentIndex	number	is the index of the segment of the airway.

Returns

number

the cumulative distance for the airway segment.

Inherited from

WTLineFms.getAirwayDistance

---

getCdiSource()

getCdiSource(): NavSourceId

Defined in: wtlinesdk/fms/WTLineFms.ts:220

Returns

NavSourceId

Inherited from

WTLineFms.getCdiSource

---

getDirectToState()

getDirectToState(planIndex): DirectToState

Defined in: wtlinesdk/fms/WTLineFms.ts:694

Gets the current Direct To State.

Parameters

Parameter	Type	Default value	Description
planIndex	WTLineLegacyFlightPlans	WTLineFmsUtils.PRIMARY_ACT_PLAN_INDEX	The Plan Index to check.

Returns

DirectToState

the DirectToState.

Inherited from

WTLineFms.getDirectToState

---

getDirectToTargetIcao()

getDirectToTargetIcao(): string | undefined

Defined in: wtlinesdk/fms/WTLineFms.ts:728

Gets the ICAO string of the current Direct To target.

Returns

string | undefined

The ICAO string of the current Direct To target, or undefined if Direct To is not active.

Deprecated

use getDirectToTargetIcaoStruct instead

Inherited from

WTLineFms.getDirectToTargetIcao

---

getDirectToTargetIcaoStruct()

getDirectToTargetIcaoStruct(planIndex): IcaoValue | undefined

Defined in: wtlinesdk/fms/WTLineFms.ts:737

Gets the ICAO string of the current Direct To target.

Parameters

Parameter	Type	Default value	Description
planIndex	WTLineLegacyMainFlightPlan	WTLineLegacyFlightPlans.Active	the plan index.

Returns

IcaoValue | undefined

The ICAO string of the current Direct To target, or undefined if Direct To is not active.

Inherited from

WTLineFms.getDirectToTargetIcaoStruct

---

getFlightPlan()

getFlightPlan(index): FlightPlan

Defined in: wtlinesdk/fms/WTLineFms.ts:239

Gets a specified flightplan, or by default the primary flight plan.

Parameters

Parameter	Type	Default value	Description
index	WTLineLegacyFlightPlans	WTLineLegacyFlightPlans.Active	The index of the flight plan.

Returns

FlightPlan

the requested flight plan

Throws

Error if no flight plan exists at the specified index.

Inherited from

WTLineFms.getFlightPlan

---

getFlightPlanAlternate()

getFlightPlanAlternate(planIndex?): string | undefined

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21Fms.ts:486

Gets the ALTN airport of a flight plan

Parameters

Parameter	Type	Description
planIndex?	WTLineLegacyFlightPlans	the flight plan index

Returns

string | undefined

the ALTN airport FS ICAO, or undefined

Deprecated

use WTLineFmsUtils.getFlightPlanAlternate instead

---

getModFlightPlan()

getModFlightPlan(): FlightPlan

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21Fms.ts:186

Handles when a modification is being made to the plan to ensure the plan is in MOD mode

Returns

FlightPlan

The Flight Plan to modify

Deprecated

use getPlanToEdit instead

---

getPilotDefinedWaypoints()

getPilotDefinedWaypoints(): SubscribableArray<FacilityWaypoint<UserFacility>>

Defined in: wtlinesdk/fms/WTLineFms.ts:803

Gets all pilot waypoints

Returns

SubscribableArray<FacilityWaypoint<UserFacility>>

a subscribable array of user facility waypoints

Inherited from

WTLineFms.getPilotDefinedWaypoints

---

getPilotDefinedWaypointsArray()

getPilotDefinedWaypointsArray(): readonly FacilityWaypoint<UserFacility>[]

Defined in: wtlinesdk/fms/WTLineFms.ts:812

Gets all pilot waypoints

Returns

readonly FacilityWaypoint<UserFacility>[]

an array of user facility waypoints

Inherited from

WTLineFms.getPilotDefinedWaypointsArray

---

getPlanForFmcRender()

getPlanForFmcRender(): FlightPlan

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21Fms.ts:204

Gets the current lateral flight plan for the FMC pages based on whether the plan is in MOD or ACT.

Returns

FlightPlan

A Lateral Flight Plan

Deprecated

use getPlanToDisplay instead

---

getPlanIndexForFmcPage()

getPlanIndexForFmcPage(): number

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21Fms.ts:195

Gets the plan index FMC pages should use to monitor events.

Returns

number

A Flight Plan Index

Deprecated

use getPlanIndexToDisplay instead

---

getPlanIndexToDisplay()

getPlanIndexToDisplay(mainPlanIndex): WTLineLegacyFlightPlans

Defined in: wtlinesdk/fms/WTLineFms.ts:396

Gets the current lateral flight plan index for the FMC pages based on whether the plan is in MOD or ACT.

Parameters

Parameter	Type	Description
mainPlanIndex	WTLineLegacyMainFlightPlan	the main plan to target

Returns

WTLineLegacyFlightPlans

A Lateral Flight Plan

Inherited from

WTLineFms.getPlanIndexToDisplay

---

getPlanToDisplay()

getPlanToDisplay(mainPlanIndex): FlightPlan

Defined in: wtlinesdk/fms/WTLineFms.ts:405

Gets the current lateral flight plan for the FMC pages based on whether the plan is in MOD or ACT.

Parameters

Parameter	Type	Description
mainPlanIndex	WTLineLegacyMainFlightPlan	the main plan to target

Returns

FlightPlan

A Lateral Flight Plan

Inherited from

WTLineFms.getPlanToDisplay

---

getPlanToEdit()

getPlanToEdit(index): FlightPlan

Defined in: wtlinesdk/fms/WTLineFms.ts:431

Gets the flight plan to edit depending on the desired plan on which to make a modification, taking into account MOD logic

Parameters

Parameter	Type	Description
index	WTLineLegacyFlightPlans	the index of the plan

Returns

FlightPlan

a flight plan

Inherited from

WTLineFms.getPlanToEdit

---

getPrimaryFlightPlan()

getPrimaryFlightPlan(): FlightPlan

Defined in: wtlinesdk/fms/WTLineFms.ts:256

Gets the primary lateral flight plan.

Returns

FlightPlan

The primary flight plan.

Throws

Error if the primary flight plan does not exist.

Inherited from

WTLineFms.getPrimaryFlightPlan

---

getSecondaryFlightPlan()

getSecondaryFlightPlan(): FlightPlan

Defined in: wtlinesdk/fms/WTLineFms.ts:306

Gets the secondary lateral flight plan.

Returns

FlightPlan

The secondary flight plan.

Throws

Error if the secondary flight plan does not exist.

Inherited from

WTLineFms.getSecondaryFlightPlan

---

getUserFacilities()

getUserFacilities(): UserFacility[]

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21Fms.ts:473

Gets all user facilities.

Returns

UserFacility[]

an array of user facilities

Deprecated

use getPilotDefinedWaypointsArray instead

---

getVerticalPlanForFmcRender()

getVerticalPlanForFmcRender(): VerticalFlightPlan

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21Fms.ts:213

Gets the current vertical flight plan for the FMC pages based on whether the plan is in MOD or ACT.

Returns

VerticalFlightPlan

A Vertical Flight Plan

Deprecated

use getVerticalPlanToDisplay instead

---

getVerticalPlanToDisplay()

getVerticalPlanToDisplay(mainPlanIndex): VerticalFlightPlan

Defined in: wtlinesdk/fms/WTLineFms.ts:414

Gets the current vertical flight plan for the FMC pages based on whether the plan is in MOD or ACT.

Parameters

Parameter	Type	Description
mainPlanIndex	WTLineLegacyMainFlightPlan	the main plan to target

Returns

VerticalFlightPlan

A Vertical Flight Plan

Inherited from

WTLineFms.getVerticalPlanToDisplay

---

hasFlightPlan()

hasFlightPlan(index): boolean

Defined in: wtlinesdk/fms/WTLineFms.ts:229

Checks whether an indexed flight plan exists.

Parameters

Parameter	Type	Description
index	number	A flight plan index.

Returns

boolean

Whether a flight plan at the specified index exists.

Inherited from

WTLineFms.hasFlightPlan

---

hasPrimaryFlightPlan()

hasPrimaryFlightPlan(): boolean

Defined in: wtlinesdk/fms/WTLineFms.ts:247

Checks whether the primary flight plan exists.

Returns

boolean

Whether the primary flight plan exists.

Inherited from

WTLineFms.hasPrimaryFlightPlan

---

hasPrimaryModFlightPlan()

hasPrimaryModFlightPlan(): boolean

Defined in: wtlinesdk/fms/WTLineFms.ts:272

Checks whether the Primary Mod Flight Plan Exists - when modifications to the plan are being made.

Returns

boolean

Whether the Primary Mod Flight Plan Exists flight plan exists.

Inherited from

WTLineFms.hasPrimaryModFlightPlan

---

hasSecondaryFlightPlan()

hasSecondaryFlightPlan(): boolean

Defined in: wtlinesdk/fms/WTLineFms.ts:297

Checks whether the Secondary Flight Plan Exists.

Returns

boolean

Whether the Secondary Flight Plan Exists flight plan exists.

Inherited from

WTLineFms.hasSecondaryFlightPlan

---

initFlightPlans()

initFlightPlans(): Promise<void>

Defined in: wtlinesdk/fms/WTLineFms.ts:215

Initializes and empties the flight plans used by the FMS

Returns

Promise<void>

Inherited from

WTLineFms.initFlightPlans

---

initPrimaryFlightPlan()

initPrimaryFlightPlan(): Promise<void>

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21Fms.ts:222

Initializes the primary flight plan. Does nothing if the primary flight plan already exists.

Returns

Promise<void>

Deprecated

use initFlightPlans instead

---

insertAirwayAtSegment()

insertAirwayAtSegment(planIndex, airway, exit, segmentIndex): Promise<number>

Defined in: wtlinesdk/fms/WTLineFms.ts:3413

Adds an airway and airway segment to the flight plan.

Parameters

Parameter	Type	Description
planIndex	WTLineLegacyFlightPlans	Is the index of the plan to target the edit to.
airway	AirwayData	The airway object.
exit	IntersectionFacility | undefined	The exit intersection facility. If undefined, the airway segment is created containing only a discontinuity.
segmentIndex	number | undefined	Is the segment index for the entry leg.

Returns

Promise<number>

The index of the airway segment that was added to the flight plan.

Inherited from

WTLineFms.insertAirwayAtSegment

---

insertAirwaySegment()

insertAirwaySegment(airway, entry, exit, segmentIndex, legIndex, planIndex): number

Defined in: wtlinesdk/fms/WTLineFms.ts:3535

Adds an airway and airway segment to the flight plan.

Parameters

Parameter	Type	Default value	Description
airway	AirwayData	undefined	The airway object.
entry	IntersectionFacility	undefined	The entry intersection facility.
exit	IntersectionFacility	undefined	The exit intersection facility.
segmentIndex	number	undefined	Is the segment index for the entry leg.
legIndex	number	undefined	Is the leg index of the entry leg in the segment.
planIndex	WTLineLegacyMainFlightPlan	WTLineLegacyFlightPlans.Active	Is the index of the plan to target the edit to.

Returns

number

The index of the airway segment that was added to the flight plan.

Deprecated

use insertAirwayAtSegment instead

Inherited from

WTLineFms.insertAirwaySegment

---

insertApproach()

insertApproach(facility, approachIndex, approachTransitionIndex, visualRunwayNumber?, visualRunwayDesignator?, transStartIndex?, skipCourseReversal?, visualRunwayOffset?, planIndex?): Promise<boolean>

Defined in: wtlinesdk/fms/WTLineFms.ts:2159

Method to add or replace an approach procedure in the flight plan.

Parameters

Parameter	Type	Default value	Description
facility	AirportFacility	undefined	is the facility that contains the procedure to add.
approachIndex	number	undefined	is the index of the approach procedure.
approachTransitionIndex	number	undefined	is the index of the approach transition.
visualRunwayNumber?	number	undefined	is the visual runway number, if any.
visualRunwayDesignator?	RunwayDesignator	undefined	is the visual runway designator, if any.
transStartIndex?	number	undefined	is the starting leg index for the transition, if any.
skipCourseReversal?	boolean	undefined	Whether to skip the course reversal.
visualRunwayOffset?	number	undefined	The visual runway offset.
planIndex?	WTLineLegacyFlightPlans	WTLineLegacyFlightPlans.Active	The plan index to target the edit to.

Returns

Promise<boolean>

A Promise which is fulfilled with whether the approach was inserted.

Inherited from

WTLineFms.insertApproach

---

insertArrival()

insertArrival(facility, arrivalIndex, arrivalRunwayTransitionIndex, enrouteTransitionIndex, oneWayRunway?, planIndex?): void

Defined in: wtlinesdk/fms/WTLineFms.ts:1627

Method to add or replace an arrival procedure in the flight plan.

Parameters

Parameter	Type	Default value	Description
facility	AirportFacility	undefined	is the facility that contains the procedure to add.
arrivalIndex	number	undefined	is the index of the arrival procedure.
arrivalRunwayTransitionIndex	number	undefined	is the index of the arrival runway transition.
enrouteTransitionIndex	number	undefined	is the index of the enroute transition.
oneWayRunway?	OneWayRunway	undefined	is the one way runway to set as the destination leg.
planIndex?	WTLineLegacyFlightPlans	WTLineLegacyFlightPlans.Active	is the index of the plan to target the edit to

Returns

void

Deprecated

Please use loadArrival() instead.

Inherited from

WTLineFms.insertArrival

---

insertDeparture()

insertDeparture(facility, departureIndex, departureRunwayIndex, enrouteTransitionIndex, oneWayRunway?, planIndex?): void

Defined in: wtlinesdk/fms/WTLineFms.ts:1363

Method to add or replace a departure procedure in the flight plan.

Parameters

Parameter	Type	Default value	Description
facility	AirportFacility	undefined	is the facility that contains the procedure to add.
departureIndex	number	undefined	is the index of the departure
departureRunwayIndex	number	undefined	is the index of the runway transition
enrouteTransitionIndex	number	undefined	is the index of the enroute transition
oneWayRunway?	OneWayRunway	undefined	is the one way runway to set as the origin leg.
planIndex?	WTLineLegacyFlightPlans	WTLineLegacyFlightPlans.Active	is the index of the plan to target the edit to

Returns

void

Deprecated

Please use loadDeparture() instead.

Inherited from

WTLineFms.insertDeparture

---

insertHold()

insertHold(segmentIndex, legIndex, holdLeg, planIndex): boolean

Defined in: wtlinesdk/fms/WTLineFms.ts:3974

Inserts a hold-at-waypoint leg to the primary flight plan. The hold leg will be inserted immediately after the specified parent leg. The hold leg must have the same fix as the parent leg.

Parameters

Parameter	Type	Default value	Description
segmentIndex	number	undefined	The index of the segment that contains the hold's parent leg.
legIndex	number	undefined	The index of the hold's parent leg in its segment.
holdLeg	FlightPlanLeg	undefined	The hold leg to add.
planIndex	WTLineLegacyMainFlightPlan	WTLineLegacyFlightPlans.Active	The index of the plan to target the edit to.

Returns

boolean

Whether the hold-at-waypoint leg was successfully inserted.

Inherited from

WTLineFms.insertHold

---

insertPposHold()

insertPposHold(partial?): boolean

Defined in: wtlinesdk/fms/WTLineFms.ts:4015

Inserts a PPOS hold as the active leg

Parameters

Parameter	Type	Description
partial?	Partial<FlightPlanLeg>	an object to modify the PPOS hold leg with, if applicable

Returns

boolean

whether the leg was inserted

Inherited from

WTLineFms.insertPposHold

---

insertWaypoint()

insertWaypoint(facility, segmentIndex?, legIndex?, mainPlanIndex?): boolean

Defined in: wtlinesdk/fms/WTLineFms.ts:843

Method to insert a waypoint to the flightplan.

Parameters

Parameter	Type	Default value	Description
facility	Facility	undefined	is the new facility to add a leg to.
segmentIndex?	number	undefined	is index of the segment to add the waypoint to
legIndex?	number	undefined	is the index to insert the waypoint (if none, append)
mainPlanIndex?	WTLineLegacyMainFlightPlan	WTLineLegacyFlightPlans.Active	is the index of the flight plan on which to target the edit

Returns

boolean

whether the waypoint was successfully inserted.

Inherited from

WTLineFms.insertWaypoint

---

invertFlightplan()

invertFlightplan(): void

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21Fms.ts:286

Method to invert the flightplan.

Returns

void

Deprecated

unused, not applicable

---

isApproachVtf()

isApproachVtf(): boolean

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21Fms.ts:453

Method to check if the approach is VTF.

Returns

boolean

whether the approach is VTF.

Deprecated

unused, not applicable

---

isFirstEnrouteSegment()

isFirstEnrouteSegment(segmentIndex): boolean

Defined in: wtlinesdk/fms/WTLineFms.ts:762

Checks if a segment is the first enroute segment that is not an airway.

Parameters

Parameter	Type	Description
segmentIndex	number	is the segment index of the segment to check

Returns

boolean

whether or not the segment is the first enroute segment that is not an airway.

Inherited from

WTLineFms.isFirstEnrouteSegment

---

loadArrival()

loadArrival(facility, arrivalIndex, runwayTransitionIndex, enrouteTransitionIndex, oneWayRunway?, planIndex?): Promise<boolean>

Defined in: wtlinesdk/fms/WTLineFms.ts:1756

Loads an arrival procedure into the primary flight plan.

Parameters

Parameter	Type	Default value	Description
facility	AirportFacility	undefined	The procedure's parent airport facility.
arrivalIndex	number	undefined	The index of the procedure in the parent airport facility's arrival array.
runwayTransitionIndex	number	undefined	The index of the procedure's runway transition, or -1 if the procedure does not include a runway transition.
enrouteTransitionIndex	number	undefined	The index of the procedure's enroute transition, or -1 if the procedure does not include an enroute transition.
oneWayRunway?	OneWayRunway	undefined	The runway associated with the procedure, or undefined if there is no associated runway.
planIndex?	WTLineLegacyFlightPlans	WTLineLegacyFlightPlans.Active	The index of the plan to target the edit to.

Returns

Promise<boolean>

A Promise which fulfills with whether the specified arrival procedure was successfully loaded.

Inherited from

WTLineFms.loadArrival

---

loadDeparture()

loadDeparture(facility, departureIndex, runwayTransitionIndex, enrouteTransitionIndex, oneWayRunway?, planIndex?): Promise<boolean>

Defined in: wtlinesdk/fms/WTLineFms.ts:1434

Loads a departure procedure into a flight plan.

Parameters

Parameter	Type	Default value	Description
facility	AirportFacility	undefined	The procedure's parent airport facility.
departureIndex	number	undefined	The index of the procedure in the parent airport facility's departure array.
runwayTransitionIndex	number	undefined	The index of the procedure's runway transition, or -1 if the procedure does not include a runway transition.
enrouteTransitionIndex	number	undefined	The index of the procedure's enroute transition, or -1 if the procedure does not include an enroute transition.
oneWayRunway?	OneWayRunway	undefined	The runway associated with the procedure, or undefined if there is no associated runway.
planIndex?	WTLineLegacyFlightPlans	WTLineLegacyFlightPlans.Active	The index of the plan to target the edit to.

Returns

Promise<boolean>

A Promise which fulfills with whether the specified departure procedure was successfully loaded.

Inherited from

WTLineFms.loadDeparture

---

pilotDefinedWaypointExistsWithIdent()

pilotDefinedWaypointExistsWithIdent(ident): boolean

Defined in: wtlinesdk/fms/WTLineFms.ts:794

Returns whether a user facility exists with a given ident

Parameters

Parameter	Type	Description
ident	string	the identifier

Returns

boolean

a boolean

Inherited from

WTLineFms.pilotDefinedWaypointExistsWithIdent

---

populateAirwaySegmentToExitFix()

populateAirwaySegmentToExitFix(planIndex, airwaySegmentIndex, segmentAirway, exitFix): Promise<void>

Defined in: wtlinesdk/fms/WTLineFms.ts:3859

Populates an airway segment given an airway and an exit fix, using the leg before the segment as the entry fix

Parameters

Parameter	Type	Description
planIndex	WTLineLegacyFlightPlans	the index of the plan to modify
airwaySegmentIndex	number	the index of the airway segment
segmentAirway	AirwayData	the airway object to use
exitFix	IntersectionFacility	the exit fix to set

Returns

Promise<void>

Inherited from

WTLineFms.populateAirwaySegmentToExitFix

---

removeAirway()

removeAirway(segmentIndex, planIndex): void

Defined in: wtlinesdk/fms/WTLineFms.ts:3896

Method to remove an airway from the flight plan.

Parameters

Parameter	Type	Default value	Description
segmentIndex	number	undefined	is the segment index of the airway to remove.
planIndex	WTLineLegacyFlightPlans	WTLineLegacyFlightPlans.Active	is the index of the plan to target the edit to.

Returns

void

Inherited from

WTLineFms.removeAirway

---

removeApproach()

removeApproach(planIndex): Promise<void>

Defined in: wtlinesdk/fms/WTLineFms.ts:2824

Method to remove the approach from the flight plan.

Parameters

Parameter	Type	Default value	Description
planIndex	WTLineLegacyFlightPlans	WTLineLegacyFlightPlans.Active	the index of the plan to target the edit to.

Returns

Promise<void>

Inherited from

WTLineFms.removeApproach

---

removeArrival()

removeArrival(planIndex): Promise<void>

Defined in: wtlinesdk/fms/WTLineFms.ts:2782

Method to remove the arrival from the flight plan.

Parameters

Parameter	Type	Default value	Description
planIndex	WTLineLegacyFlightPlans	WTLineLegacyFlightPlans.Active	The index of the plan to target for edit.

Returns

Promise<void>

Inherited from

WTLineFms.removeArrival

---

removeDeparture()

removeDeparture(planIndex): Promise<void>

Defined in: wtlinesdk/fms/WTLineFms.ts:2741

Method to remove the departure from the flight plan.

Parameters

Parameter	Type	Default value	Description
planIndex	WTLineLegacyFlightPlans	WTLineLegacyFlightPlans.Active	the index of the flight plan to target the edit to.

Returns

Promise<void>

Inherited from

WTLineFms.removeDeparture

---

removeUserFacility()

removeUserFacility(userFacility): void

Defined in: wtlinesdk/fms/WTLineFms.ts:785

Removes a user facility.

Parameters

Parameter	Type	Description
userFacility	UserFacility	the facility to remove.

Returns

void

Inherited from

WTLineFms.removeUserFacility

---

removeWaypoint()

removeWaypoint(segmentIndex, segmentLegIndex, skipVectorsCheck, skipFafMapCheck, skipHoldDelete, planIndex): boolean

Defined in: wtlinesdk/fms/WTLineFms.ts:953

Removes a leg to a waypoint from the primary flight plan.

Parameters

Parameter	Type	Default value	Description
segmentIndex	number	undefined	The index of the segment containing the leg to remove.
segmentLegIndex	number	undefined	The index of the leg to remove in its segment.
skipVectorsCheck	boolean	false	Whether to force deletion regardless of vectors legs being before a discontinuity
skipFafMapCheck	boolean	false	Whether to force deletion regardless of FAF/MAP flags
skipHoldDelete	boolean	false	Whether to skip deleting holds associated with this leg
planIndex	WTLineLegacyFlightPlans	WTLineLegacyFlightPlans.Active	The index of the plan to target the edit to.

Returns

boolean

Whether the waypoint was successfully removed.

Inherited from

WTLineFms.removeWaypoint

---

setDestination()

setDestination(airport, runway?, mainPlanIndex?): void

Defined in: wtlinesdk/fms/WTLineFms.ts:1183

Method to add a new destination airport and runway to the flight plan.

Parameters

Parameter	Type	Default value	Description
airport	AirportFacility | undefined	undefined	is the facility of the destination airport.
runway?	OneWayRunway	undefined	is the selected runway at the destination facility.
mainPlanIndex?	WTLineLegacyMainFlightPlan	WTLineLegacyFlightPlans.Active	is the plan index to target the edit to

Returns

void

Inherited from

WTLineFms.setDestination

---

setFacilityInfo()

setFacilityInfo(): Promise<void>

Defined in: wtlinesdk/fms/WTLineFms.ts:484

Sets the Facility Info cache in the WT21Fms.

Returns

Promise<void>

Inherited from

WTLineFms.setFacilityInfo

---

setFlightPlanAlternate()

setFlightPlanAlternate(facility, planIndex): void

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21Fms.ts:500

Sets the ALTN airport of a flight plan

Parameters

Parameter	Type	Default value	Description
facility	AirportFacility | undefined	undefined	the ALTN airport facility, or undefined
planIndex	WTLineLegacyFlightPlans	WTLineLegacyFlightPlans.Active	the flight plan index

Returns

void

Deprecated

use WTLineFmsUtils.setFlightPlanAlternate instead

---

setOrigin()

setOrigin(airport, runway?, planIndex?): void

Defined in: wtlinesdk/fms/WTLineFms.ts:1134

Method to add a new origin airport and runway to the flight plan.

Parameters

Parameter	Type	Default value	Description
airport	AirportFacility | undefined	undefined	is the facility of the origin airport.
runway?	OneWayRunway	undefined	is the new runway
planIndex?	WTLineLegacyMainFlightPlan	WTLineLegacyFlightPlans.Active	is the index of the plan to target the edit to

Returns

void

Inherited from

WTLineFms.setOrigin

---

setUserConstraint()

setUserConstraint(globalLegIndex, verticalData, mainPlanIndex): boolean

Defined in: wtlinesdk/fms/WTLineFms.ts:1059

Sets the speed and altitude constraints for a log.

Parameters

Parameter	Type	Default value	Description
globalLegIndex	number	undefined	Global leg index of the leg to modify.
verticalData	Omit<VerticalData, "phase">	undefined	The vertical data to set on the leg. Will be merged with existing data.
mainPlanIndex	WTLineLegacyMainFlightPlan	WTLineLegacyFlightPlans.Active	The index of the flight plan to target the edit to.

Returns

boolean

Whether the data was set.

Inherited from

WTLineFms.setUserConstraint

---

switchPerformanceProxyToRenderPlan()

switchPerformanceProxyToRenderPlan(): void

Defined in: workingtitle-instruments-wt21/shared/Systems/FMS/WT21Fms.ts:174

Switches the performance proxy to use the FMC render plan

Returns

void

---

toggleLegFlyover()

toggleLegFlyover(planIndex, segmentIndex, localLegIndex, value?): boolean

Defined in: wtlinesdk/fms/WTLineFms.ts:1030

Toggles a leg being marked by fly-over or not

Parameters

Parameter	Type	Description
planIndex	WTLineLegacyFlightPlans	the index of the plan to modify
segmentIndex	number	the segment index
localLegIndex	number	the local leg index
value?	boolean	the value to force (toggled otherwise)

Returns

boolean

whether the leg could be set as flyover or not

Inherited from

WTLineFms.toggleLegFlyover