Class: Epic2Fms

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:27

An EPIC 2 FMS.

Constructors

Constructor

new Epic2Fms(bus, facLoader, flightPlanner, verticalPathCalculator, isPrimaryFms, avionicsConfig, inertialDataProvider, airspeedDataProvider, airGroundDataProvider): Epic2Fms

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:186

Ctor.

Parameters

Parameter	Type	Description
bus	EventBus	The instrument event bus.
facLoader	FacilityLoader	The facility loader.
flightPlanner	FlightPlanner	The flight planner.
verticalPathCalculator	SmoothingPathCalculator	is the VNAV Path Calculator.
isPrimaryFms	boolean	If this is the primary FMS instance.
avionicsConfig	AvionicsConfig	The avionics config.
inertialDataProvider	InertialDataProvider	The inertial data provider.
airspeedDataProvider	AirspeedDataProvider	The airspeed data provider.
airGroundDataProvider	AirGroundDataProvider	The air ground data provider.

Returns

Epic2Fms

Properties

airGroundDataProvider

readonly airGroundDataProvider: AirGroundDataProvider

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:195

The air ground data provider.

---

airspeedDataProvider

readonly airspeedDataProvider: AirspeedDataProvider

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:194

The airspeed data provider.

---

approachDetails

approachDetails: ApproachDetails

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:55

---

avionicsConfig

readonly avionicsConfig: AvionicsConfig

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:192

The avionics config.

---

bus

protected readonly bus: EventBus

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:187

The instrument event bus.

---

dtoWasCreatedInModPlan

dtoWasCreatedInModPlan: Subject<boolean>

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:85

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

---

facilityInfo

facilityInfo: FacilityInfo

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:50

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-epic2/shared/Fms/Epic2Fms.ts:188

The facility loader.

---

flightLogger

readonly flightLogger: Epic2FlightLogger

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:39

---

flightPlanner

protected readonly flightPlanner: FlightPlanner

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:189

The flight planner.

---

inertialDataProvider

readonly inertialDataProvider: InertialDataProvider

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:193

The inertial data provider.

---

isPrimaryFms

protected readonly isPrimaryFms: boolean

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:191

If this is the primary FMS instance.

---

performancePlanProxy

readonly performancePlanProxy: PerformancePlanProxy<Epic2PerformancePlan>

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:109

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.

---

performancePlanRepository

readonly performancePlanRepository: PerformancePlanRepository<Epic2PerformancePlan, "wt.epic2.perf">

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:103

---

planInMod

readonly planInMod: Subject<boolean>

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:30

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-epic2/shared/Fms/Epic2Fms.ts:37

---

remotePlanInMod

remotePlanInMod: boolean = false

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:33

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-epic2/shared/Fms/Epic2Fms.ts:90

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-epic2/shared/Fms/Epic2Fms.ts:96

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

---

verticalPathCalculator

readonly verticalPathCalculator: SmoothingPathCalculator

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:190

is the VNAV Path Calculator.

Accessors

activePerformancePlan

Get Signature

get activePerformancePlan(): Epic2PerformancePlan

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:132

Returns the active performance plan

Returns

Epic2PerformancePlan

the performance plan for the active flight plan index

Methods

activateLeg()

activateLeg(segmentIndex, legIndex, removeExistingDTO, useModPlan): void

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:2833

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.
useModPlan	boolean	true	Whether to activate from the mod plan, defaults to true

Returns

void

---

activatePlan()

activatePlan(planIndex, emptySourcePlan): void

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:363

Activates the pending or secondary plan (copies to active).

Parameters

Parameter	Type	Default value	Description
planIndex	Epic2FlightPlans	Epic2FlightPlans.Pending	The plan to activate, defaults to pending plan.
emptySourcePlan	boolean	true	Whether to empty the source plan after activating. Defaults to true.

Returns

void

Throws

When an attempt is made to activate the active plan.

---

activateVtf()

activateVtf(): Promise<void>

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:2979

Activates vectors-to-final. Activating vectors-to-final activates the primary flight plan's vectors-to-final leg. If the primary flight plan has no or VTF approach loaded, this method has no effect.

Returns

Promise<void>

---

addUserFacility()

addUserFacility(userFacility): void

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:870

Adds a user facility.

Parameters

Parameter	Type	Description
userFacility	UserFacility	the facility to add.

Returns

void

---

canApproachLoad()

canApproachLoad(): boolean

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:3884

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-epic2/shared/Fms/Epic2Fms.ts:623

Handles when the CANCEL MOD button is pressed.

Returns

void

---

canEditPlan()

canEditPlan(): boolean

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:524

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

Returns

boolean

Whether to allow plan edits or not

---

clearApproach()

clearApproach(): void

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:2056

Clears the previously selected approach if any. Creates a mod plan for the modification if it doesn't already exist.

Returns

void

---

clearArrival()

clearArrival(): void

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:1672

Clears the previously selected arrival if any. Creates a mod plan for the modification if it doesn't already exist.

Returns

void

---

createDirectTo()

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

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:3048

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-epic2/shared/Fms/Epic2Fms.ts:3192

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-epic2/shared/Fms/Epic2Fms.ts:3414

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-epic2/shared/Fms/Epic2Fms.ts:3223

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>

---

createLLWaypoint()

createLLWaypoint(latLong): UserFacility

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:5074

Creates a lat long waypoint

Parameters

Parameter	Type	Description
latLong	GeoPointInterface	The geopoint representing the lat long

Returns

UserFacility

The created LL user facility

Throws

If there are more than 99 user waypoints

---

createPBDWaypoint()

createPBDWaypoint(facility, bearing, distance): UserFacility

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:5091

Creates a place bearing distance waypoint

Parameters

Parameter	Type	Description
facility	Facility	The place
bearing	number	The bearing
distance	number	The distance

Returns

UserFacility

The created PBD user facility

Throws

If there are more than 99 user waypoints

---

createPBPBWaypoint()

createPBPBWaypoint(facilityA, bearingA, facilityB, bearingB): UserFacility | null

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:5109

Creates a place bearing distance waypoint

Parameters

Parameter	Type	Description
facilityA	Facility	Place 1
bearingA	number	Bearing 1
facilityB	Facility	Place 2
bearingB	number	Bearing 2

Returns

UserFacility | null

The created PBPB user facility

Throws

If there are more than 99 user waypoints, or the radials do not intersect.

---

createVerticalDirectTo()

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

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:3346

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

---

deleteFlightPlanVisualApproach()

deleteFlightPlanVisualApproach(planIndex): void

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:5017

Deletes a flight plan's visual approach

Parameters

Parameter	Type	Description
planIndex	number	the plan index

Returns

void

---

directToRecovery()

directToRecovery(): void

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:733

Will run direct to recovery, restoring any legs removed by the direct to.

Returns

void

Throws

if the active leg is not the target of a dto

---

emptyFlightPlan()

emptyFlightPlan(planIndex): void

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:324

Empties a specified flight plan.

Parameters

Parameter	Type	Default value	Description
planIndex	Epic2FlightPlans	Epic2FlightPlans.Active	The plan index to empty. Defaults to the active plan index.

Returns

void

---

findLastEnrouteSegmentIndex()

findLastEnrouteSegmentIndex(plan): number

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:3868

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(): Epic2PerformancePlan

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:163

Gets the performance plan for the ACT flight plan.

Returns

Epic2PerformancePlan

the performance plan

---

getDirectToState()

getDirectToState(planIndex): DirectToState

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:799

Gets the current Direct To State.

Parameters

Parameter	Type	Default value	Description
planIndex	Epic2FlightPlans	Epic2FlightPlans.Active	The Plan Index to check.

Returns

DirectToState

the DirectToState.

---

getDirectToTargetIcao()

getDirectToTargetIcao(): string | undefined

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:832

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.

---

getFinalApproachTrueCourse()

getFinalApproachTrueCourse(facility, approach): Promise<number>

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:4921

Get the true course for the final approach

Parameters

Parameter	Type	Description
facility	AirportFacility	Destination airport facility
approach	ApproachProcedure	The approach

Returns

Promise<number>

the true course for the final approach.

---

getFlightPlan()

getFlightPlan(index): FlightPlan

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:418

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

Parameters

Parameter	Type	Default value	Description
index	Epic2FlightPlans	Epic2FlightPlans.Active	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?): string | undefined

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:568

Gets the ALTN airport of a flight plan

Parameters

Parameter	Type	Description
planIndex?	number	the flight plan index

Returns

string | undefined

the ALTN airport FS ICAO, or undefined

---

getFlightPlanVisualApproach()

getFlightPlanVisualApproach(planIndex): string | undefined

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:4998

Returns a flight plan's visual approach, as the runway designator of the approach

Parameters

Parameter	Type	Description
planIndex	number	the plan index

Returns

string | undefined

a string

---

getFlightPlanVisualApproachVfrVpa()

getFlightPlanVisualApproachVfrVpa(planIndex): number | undefined

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:5028

Returns a flight plan's visual approach VFR vertical path angle

Parameters

Parameter	Type	Description
planIndex	number	the plan index

Returns

number | undefined

a number, in degrees

---

getModFlightPlan()

getModFlightPlan(): FlightPlan

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:476

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-epic2/shared/Fms/Epic2Fms.ts:500

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-epic2/shared/Fms/Epic2Fms.ts:489

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

Returns

number

A Flight Plan Index

---

getPrimaryFlightPlan()

getPrimaryFlightPlan(): FlightPlan

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:435

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-epic2/shared/Fms/Epic2Fms.ts:887

Gets all user facilities.

Returns

UserFacility[]

an array of user facilities

---

getVerticalPlanForFmcRender()

getVerticalPlanForFmcRender(): VerticalFlightPlan

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:512

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

---

hasPrimaryFlightPlan()

hasPrimaryFlightPlan(): boolean

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:426

Checks whether the primary flight plan exists.

Returns

boolean

Whether the primary flight plan exists.

---

initFlightPlans()

initFlightPlans(): Promise<void>

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:296

Initialises the flight plans on the primary instrument.

Returns

Promise<void>

---

insertAirwaySegment()

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

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:3614

Adds an airway and airway segment to the flight plan.

Parameters

Parameter	Type	Description
airway	AirwayData	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.

Returns

number

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

---

insertApproach()

insertApproach(description): Promise<boolean>

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:2078

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

Parameters

Parameter	Type	Description
description	ApproachProcedureDescription	the approach procedure description

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-epic2/shared/Fms/Epic2Fms.ts:1697

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

Deprecated

Please use loadArrival() instead.

---

insertDeparture()

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

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:1445

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

Deprecated

Please use loadDeparture() instead.

---

insertHold()

insertHold(segmentIndex, legIndex, holdLeg): boolean

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:3438

Inserts a hold-at-waypoint leg to the 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-epic2/shared/Fms/Epic2Fms.ts:3465

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?, addDisco?): boolean

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:927

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)
addDisco?	boolean	true	whether to insert a discontinuity after it

Returns

boolean

whether the waypoint was successfully inserted.

---

interceptLeg()

interceptLeg(segmentIndex, legIndex, course): void

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:3556

Intercepts the chosen leg with that course

Parameters

Parameter	Type	Description
segmentIndex	number	The index of the segment which contains the leg being intercepted
legIndex	number	The index of the leg within the segment that is being intercepted
course	number	The magnetic course with which to intercept the leg

Returns

void

---

isFirstEnrouteSegment()

isFirstEnrouteSegment(segmentIndex): boolean

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:855

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.

---

loadArrival()

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

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:1806

Loads an arrival procedure into the primary flight plan.

Parameters

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

Returns

Promise<boolean>

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

---

loadDeparture()

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

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:1501

Loads a departure procedure into the primary flight plan.

Parameters

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

Returns

Promise<boolean>

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

---

removeAirway()

removeAirway(segmentIndex): void

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:3790

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-epic2/shared/Fms/Epic2Fms.ts:2722

Method to remove the approach from the flight plan.

Returns

Promise<void>

---

removeArrival()

removeArrival(): Promise<void>

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:2691

Method to remove the arrival from the flight plan.

Returns

Promise<void>

---

removeDeparture()

removeDeparture(): Promise<void>

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:2660

Method to remove the departure from the flight plan.

Returns

Promise<void>

---

removeDirectToExisting()

removeDirectToExisting(planIndex, lateralLegIndex?, calculate?, resetOrigin?): void

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:756

Removes the direct to existing legs from the primary flight plan. If a direct to existing is currently active, this will effectively cancel it.

Parameters

Parameter	Type	Default value	Description
planIndex	Epic2FlightPlans	Epic2FlightPlans.Pending	The flight plan index.
lateralLegIndex?	number	undefined	The index of the leg to set as the active lateral leg after the removal operation. Defaults to the index of the current active primary flight plan leg.
calculate?	boolean	true	Whether to calculate the flight plan
resetOrigin?	boolean	false	Whether to reset the dto origin variable

Returns

void

---

removeUserFacility()

removeUserFacility(userFacility): void

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:878

Removes a user facility.

Parameters

Parameter	Type	Description
userFacility	UserFacility	the facility to remove.

Returns

void

---

removeWaypoint()

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

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:1117

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.
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-epic2/shared/Fms/Epic2Fms.ts:1256

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

Parameters

Parameter	Type	Description
airport	AirportFacility | undefined	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-epic2/shared/Fms/Epic2Fms.ts:541

Sets the Facility Info cache in the Fms.

Returns

Promise<void>

---

setFlightPlanAlternate()

setFlightPlanAlternate(facility): void

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:579

Sets the ALTN airport of a flight plan

Parameters

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

Returns

void

---

setFlightPlanVisualApproach()

setFlightPlanVisualApproach(planIndex, runwayDesignator): void

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:5008

Returns a flight plan's visual approach, as the runway designator of the approach

Parameters

Parameter	Type	Description
planIndex	number	the plan index
runwayDesignator	string | undefined	the visual approach's runway designator

Returns

void

---

setFlightPlanVisualApproachVfrVpa()

setFlightPlanVisualApproachVfrVpa(planIndex, vpa): void

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:5038

Sets a flight plan's visual approach VFR vertical path angle

Parameters

Parameter	Type	Description
planIndex	number	the plan index
vpa	number | undefined	the visual approach's VFR vertical path angle, in degrees

Returns

void

---

setOrigin()

setOrigin(airport, runway?): void

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:1222

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

Parameters

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

Returns

void

---

setRnavMinima()

setRnavMinima(minima): void

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:4887

Sets the RNAV minima in the FMS approach details

Parameters

Parameter	Type	Description
minima	RnavMinima	The RNAV minima to set

Returns

void

---

setUserConstraint()

setUserConstraint(globalLegIndex, verticalData): boolean

Defined in: workingtitle-instruments-epic2/shared/Fms/Epic2Fms.ts:1164

Sets the speed and altitude constraints for a flight plan leg.

Parameters

Parameter	Type	Description
globalLegIndex	number	The global 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-epic2/shared/Fms/Epic2Fms.ts:170

Switches the performance proxy to use the FMC render plan

Returns

void