Class: WT21Fms

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:79

A WT 21 FMS

Constructors

Constructor

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

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:217

Initialize an instance of the FMS for the WT21.

Parameters

Parameter	Type	Description
bus	EventBus	is the event bus
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

Properties

approachDetails

approachDetails: ApproachDetails

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:100

---

basePerformanceManager

readonly basePerformanceManager: BasePerformanceDataManager

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:183

---

bus

readonly bus: EventBus

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:218

is the event bus

---

facilityInfo

facilityInfo: FacilityInfo

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:95

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.

---

facLoader

readonly facLoader: FacilityLoader

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:91

---

fixInfo

readonly fixInfo: WT21FixInfoManager

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:223

The fix info manager.

---

flightPlanner

readonly flightPlanner: FlightPlanner

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:219

is the flight planner

---

fmsPos

readonly fmsPos: FmsPos

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:220

is the FMS position system

---

messageService

readonly messageService: MessageService

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:222

is the message service.

---

performancePlanProxy

readonly performancePlanProxy: PerformancePlanProxy

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:147

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: Subject<boolean>

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:81

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

---

ppos

readonly ppos: GeoPoint

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:88

---

remotePlanInMod

remotePlanInMod: boolean = false

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:84

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

---

verticalDtoWasCreatedInModPlan

verticalDtoWasCreatedInModPlan: boolean = false

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:131

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.

---

verticalDtoWasCreatedInModPlanWasAutomatic

verticalDtoWasCreatedInModPlanWasAutomatic: boolean = false

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:137

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

---

verticalPathCalculator

readonly verticalPathCalculator: SmoothingPathCalculator

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:221

is the VNAV Path Calculator.

Accessors

activePerformancePlan

Get Signature

get activePerformancePlan(): PerformancePlan

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:179

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/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:2759

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

---

activateLeg()

activateLeg(segmentIndex, legIndex, removeExistingDTO): void

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:2724

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

---

activateVtf()

activateVtf(): Promise<void>

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:2789

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>

---

addUserFacility()

addUserFacility(userFacility): void

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:857

Adds a user facility.

Parameters

Parameter	Type	Description
userFacility	UserFacility	the facility to add.

Returns

void

---

canActivateApproach()

canActivateApproach(): boolean

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:2745

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.

---

canActivateLeg()

canActivateLeg(segmentIndex, segmentLegIndex): boolean

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:709

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.

---

canActivateVtf()

canActivateVtf(): boolean

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:2774

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.

---

canApproachLoad()

canApproachLoad(): boolean

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:1956

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.

---

cancelMod()

cancelMod(): void

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:419

Handles when the CANCEL MOD button is pressed.

Returns

void

---

canDirectTo()

canDirectTo(segmentIndex, segmentLegIndex): boolean

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:755

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.

---

canEditPlan()

canEditPlan(): boolean

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:480

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

Returns

boolean

Whether to allow plan edits or not

---

canMissedApproachActivate()

canMissedApproachActivate(): boolean

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:2874

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

Returns

boolean

whether the approach can activate

---

createDirectTo()

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

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:2912

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

---

createDirectToAirport()

createDirectToAirport(airportFacility): void

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:3036

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

---

createDirectToExistingNextValidLeg()

createDirectToExistingNextValidLeg(globalLegIndex): boolean

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:3252

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.

---

createDirectToRunwayVisualApproach()

createDirectToRunwayVisualApproach(airportFacility, runway): Promise<void>

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:3067

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>

---

createVerticalDirectTo()

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

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:3184

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

---

emptyModFlightPlan()

emptyModFlightPlan(notify): void

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:3327

Empties the mod flight plan.

Parameters

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

Returns

void

---

emptyPrimaryFlightPlan()

emptyPrimaryFlightPlan(): Promise<void>

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:3295

Empties the primary flight plan.

Returns

Promise<void>

---

findLastEnrouteSegmentIndex()

findLastEnrouteSegmentIndex(plan): number

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:1941

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.

---

getActivePerformancePlan()

getActivePerformancePlan(): PerformancePlan

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:197

Gets the performance plan for the ACT flight plan.

Returns

PerformancePlan

the performance plan

---

getAirwayDistance()

getAirwayDistance(segmentIndex): number

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:1185

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.

---

getCdiSource()

getCdiSource(): NavSourceId

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:295

Returns

NavSourceId

---

getDirectToState()

getDirectToState(planIndex): DirectToState

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:786

Gets the current Direct To State.

Parameters

Parameter	Type	Default value	Description
planIndex	number	WT21FmsUtils.PRIMARY_ACT_PLAN_INDEX	The Plan Index to check.

Returns

DirectToState

the DirectToState.

---

getDirectToTargetIcao()

getDirectToTargetIcao(): undefined | string

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:819

Gets the ICAO string of the current Direct To target.

Returns

undefined | string

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

---

getFlightPlan()

getFlightPlan(index): FlightPlan

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:314

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

Parameters

Parameter	Type	Default value	Description
index	number	WT21FmsUtils.PRIMARY_ACT_PLAN_INDEX	The index of the flight plan.

Returns

FlightPlan

the requested flight plan

Throws

Error if no flight plan exists at the specified index.

---

getFlightPlanAlternate()

getFlightPlanAlternate(planIndex?): undefined | string

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:556

Gets the ALTN airport of a flight plan

Parameters

Parameter	Type	Description
planIndex?	number	the flight plan index

Returns

undefined | string

the ALTN airport FS ICAO, or undefined

---

getModFlightPlan()

getModFlightPlan(): FlightPlan

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:432

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

---

getPlanForFmcRender()

getPlanForFmcRender(): FlightPlan

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:456

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

---

getPlanIndexForFmcPage()

getPlanIndexForFmcPage(): number

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:445

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

Returns

number

A Flight Plan Index

---

getPrimaryFlightPlan()

getPrimaryFlightPlan(): FlightPlan

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:331

Gets the primary lateral flight plan.

Returns

FlightPlan

The primary flight plan.

Throws

Error if the primary flight plan does not exist.

---

getUserFacilities()

getUserFacilities(): UserFacility[]

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:874

Gets all user facilities.

Returns

UserFacility[]

an array of user facilities

---

getVerticalPlanForFmcRender()

getVerticalPlanForFmcRender(): VerticalFlightPlan

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:468

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

---

hasFlightPlan()

hasFlightPlan(index): boolean

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:304

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.

---

hasPrimaryFlightPlan()

hasPrimaryFlightPlan(): boolean

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:322

Checks whether the primary flight plan exists.

Returns

boolean

Whether the primary flight plan exists.

---

hasPrimaryModFlightPlan()

hasPrimaryModFlightPlan(): boolean

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:347

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.

---

initPrimaryFlightPlan()

initPrimaryFlightPlan(): Promise<void>

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:282

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

Returns

Promise<void>

---

insertAirwaySegment()

insertAirwaySegment(airway, entry, exit, segmentIndex, legIndex): void

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:3357

Adds an airway and airway segment to the flight plan.

Parameters

Parameter	Type	Description
airway	AirwayObject	The airway object.
entry	IntersectionFacility	The entry intersection facility.
exit	IntersectionFacility	The exit intersection facility.
segmentIndex	number	Is the segment index for the entry leg.
legIndex	number	Is the leg index of the entry leg in the segment of the

Returns

void

---

insertApproach()

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

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:1981

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

Parameters

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

Returns

Promise<boolean>

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

---

insertArrival()

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

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:1649

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

Parameters

Parameter	Type	Description
facility	AirportFacility	is the facility that contains the procedure to add.
arrivalIndex	number	is the index of the arrival procedure.
arrivalRunwayTransitionIndex	number	is the index of the arrival runway transition.
enrouteTransitionIndex	number	is the index of the enroute transition.
oneWayRunway?	OneWayRunway	is the one way runway to set as the destination leg.

Returns

void

---

insertDeparture()

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

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:1524

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

Parameters

Parameter	Type	Description
facility	AirportFacility	is the facility that contains the procedure to add.
departureIndex	number	is the index of the departure
departureRunwayIndex	number	is the index of the runway transition
enrouteTransitionIndex	number	is the index of the enroute transition
oneWayRunway?	OneWayRunway	is the one way runway to set as the origin leg.

Returns

void

---

insertHold()

insertHold(segmentIndex, legIndex, holdLeg): boolean

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:3600

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	Description
segmentIndex	number	The index of the segment that contains the hold's parent leg.
legIndex	number	The index of the hold's parent leg in its segment.
holdLeg	FlightPlanLeg	The hold leg to add.

Returns

boolean

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

---

insertPposHold()

insertPposHold(partial?): boolean

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:3638

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

---

insertWaypoint()

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

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:913

Method to insert a waypoint to the flightplan.

Parameters

Parameter	Type	Description
facility	Facility	is the new facility to add a leg to.
segmentIndex?	number	is index of the segment to add the waypoint to
legIndex?	number	is the index to insert the waypoint (if none, append)

Returns

boolean

whether the waypoint was successfully inserted.

---

invertFlightplan()

invertFlightplan(): void

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:1291

Method to invert the flightplan. TODO Does the WT21 support this?

Returns

void

---

isApproachVtf()

isApproachVtf(): boolean

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:2862

Method to check if the approach is VTF.

Returns

boolean

whether the approach is VTF.

---

isFirstEnrouteSegment()

isFirstEnrouteSegment(segmentIndex): boolean

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:842

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.

---

removeAirway()

removeAirway(segmentIndex): void

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:3528

Method to remove an airway from the flight plan.

Parameters

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

Returns

void

---

removeApproach()

removeApproach(): Promise<void>

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:2615

Method to remove the approach from the flight plan.

Returns

Promise<void>

---

removeArrival()

removeArrival(): Promise<void>

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:2584

Method to remove the arrival from the flight plan.

Returns

Promise<void>

---

removeDeparture()

removeDeparture(): Promise<void>

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:2555

Method to remove the departure from the flight plan.

Returns

Promise<void>

---

removeUserFacility()

removeUserFacility(userFacility): void

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:865

Removes a user facility.

Parameters

Parameter	Type	Description
userFacility	UserFacility	the facility to remove.

Returns

void

---

removeWaypoint()

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

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:1089

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

Returns

boolean

Whether the waypoint was successfully removed.

---

setDestination()

setDestination(airport, runway?): void

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:1232

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

Parameters

Parameter	Type	Description
airport	undefined | AirportFacility	is the facility of the destination airport.
runway?	OneWayRunway	is the selected runway at the destination facility.

Returns

void

---

setFacilityInfo()

setFacilityInfo(): Promise<void>

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:529

Sets the Facility Info cache in the WT21Fms.

Returns

Promise<void>

---

setFlightPlanAlternate()

setFlightPlanAlternate(facility): void

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:567

Sets the ALTN airport of a flight plan

Parameters

Parameter	Type	Description
facility	undefined | AirportFacility	the ALTN airport facility, or undefined

Returns

void

---

setOrigin()

setOrigin(airport, runway?): void

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:1199

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

Parameters

Parameter	Type	Description
airport	undefined | AirportFacility	is the facility of the origin airport.
runway?	OneWayRunway	is the onewayrunway

Returns

void

---

setUserConstraint()

setUserConstraint(globalLegIndex, verticalData): boolean

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:1127

Sets the speed and altitude constraints for a log.

Parameters

Parameter	Type	Description
globalLegIndex	number	Global leg index of the leg to modify.
verticalData	Omit<VerticalData, "phase">	The vertical data to set on the leg. Will be merged with existing data.

Returns

boolean

Whether the data was set.

---

switchPerformanceProxyToRenderPlan()

switchPerformanceProxyToRenderPlan(): void

Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/FlightPlan/WT21Fms.ts:204

Switches the performance proxy to use the FMC render plan

Returns

void