Skip to main content

Class: Epic2Fms

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

An EPIC 2 FMS.

Constructors

Constructor

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

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

Ctor.

Parameters

ParameterTypeDescription
busEventBusThe instrument event bus.
flightPlannerFlightPlannerThe flight planner.
verticalPathCalculatorSmoothingPathCalculatoris the VNAV Path Calculator.
isPrimaryFmsbooleanIf this is the primary FMS instance.
avionicsConfigAvionicsConfigThe avionics config.
inertialDataProviderInertialDataProviderThe inertial data provider.
airspeedDataProviderAirspeedDataProviderThe airspeed data provider.
airGroundDataProviderAirGroundDataProviderThe air ground data provider.

Returns

Epic2Fms

Properties

airGroundDataProvider

readonly airGroundDataProvider: AirGroundDataProvider

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

The air ground data provider.


airspeedDataProvider

readonly airspeedDataProvider: AirspeedDataProvider

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

The airspeed data provider.


approachDetails

approachDetails: ApproachDetails

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


avionicsConfig

readonly avionicsConfig: AvionicsConfig

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

The avionics config.


bus

protected readonly bus: EventBus

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

The instrument event bus.


dtoWasCreatedInModPlan

dtoWasCreatedInModPlan: Subject<boolean>

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

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:51

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:47


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:186

The flight planner.


inertialDataProvider

readonly inertialDataProvider: InertialDataProvider

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

The inertial data provider.


isPrimaryFms

protected readonly isPrimaryFms: boolean

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

If this is the primary FMS instance.


performancePlanProxy

readonly performancePlanProxy: PerformancePlanProxy<Epic2PerformancePlan>

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

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:102


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:91

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:97

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


verticalPathCalculator

protected readonly verticalPathCalculator: SmoothingPathCalculator

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

is the VNAV Path Calculator.

Accessors

activePerformancePlan

Get Signature

get activePerformancePlan(): Epic2PerformancePlan

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

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:2434

Method to activate a leg in the flight plan.

Parameters

ParameterTypeDefault valueDescription
segmentIndexnumberundefinedis the index of the segment containing the leg to activate.
legIndexnumberundefinedis the index of the leg in the selected segment activate.
removeExistingDTObooleantrueWhether to check for and remove the existing direct to legs.
useModPlanbooleantrueWhether 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:358

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

Parameters

ParameterTypeDefault valueDescription
planIndexEpic2FlightPlansEpic2FlightPlans.PendingThe plan to activate, defaults to pending plan.
emptySourcePlanbooleantrueWhether 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:2580

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:865

Adds a user facility.

Parameters

ParameterTypeDescription
userFacilityUserFacilitythe facility to add.

Returns

void


canApproachLoad()

canApproachLoad(): boolean

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

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:618

Handles when the CANCEL MOD button is pressed.

Returns

void


canEditPlan()

canEditPlan(): boolean

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

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

Returns

boolean

Whether to allow plan edits or not


createDirectTo()

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

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

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

ParameterTypeDefault valueDescription
segmentIndex?numberundefinedis the index of the segment containing the leg to activate as direct to.
segmentLegIndex?numberundefinedis the index of the leg in the specified segment to activate as direct to.
isNewDTO?booleantruewhether to treat this as a new directo to or not.
course?numberundefinedis the course for this direct to in degrees magnetic, if specified.
facility?Facilityundefinedis 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:2793

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

ParameterTypeDescription
airportFacilityAirportFacilitythe airport facility to go direct to

Returns

void


createDirectToExistingNextValidLeg()

createDirectToExistingNextValidLeg(globalLegIndex): boolean

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

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

Parameters

ParameterTypeDescription
globalLegIndexnumberThe 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:2824

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

ParameterTypeDescription
airportFacilityAirportFacilitythe airport facility to go direct to
runwayOneWayRunwaythe 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:4639

Creates a lat long waypoint

Parameters

ParameterTypeDescription
latLongGeoPointInterfaceThe geopoint representing the lat long

Returns

UserFacility

The created PBD 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:4663

Creates a place bearing distance waypoint

Parameters

ParameterTypeDescription
facilityFacilityThe place
bearingnumberThe bearing
distancenumberThe distance

Returns

UserFacility

The created PBD user facility

Throws

If there are more than 99 user waypoints


createPBPBWaypoint()

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

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

Creates a place bearing distance waypoint

Parameters

ParameterTypeDescription
facilityAFacilityPlace 1
bearingAnumberBearing 1
facilityBFacilityPlace 2
bearingBnumberBearing 2

Returns

null | UserFacility

The created PBPB user facility

Throws

If there are more than 99 user waypoints


createVerticalDirectTo()

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

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

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

ParameterTypeDefault valueDescription
planFlightPlanundefinedthe plan to use
globalIndexnumberundefinedthe global leg index to apply the constraint to
finalAltitudenumberundefinedthe altitude to target, in metres.
isAutomaticbooleanfalsewhether 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:4608

Deletes a flight plan's visual approach

Parameters

ParameterTypeDescription
planIndexnumberthe plan index

Returns

void


directToRecovery()

directToRecovery(): void

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

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:319

Empties a specified flight plan.

Parameters

ParameterTypeDefault valueDescription
planIndexEpic2FlightPlansEpic2FlightPlans.ActiveThe 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:3459

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

Parameters

ParameterTypeDescription
planFlightPlanis 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:162

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:794

Gets the current Direct To State.

Parameters

ParameterTypeDefault valueDescription
planIndexEpic2FlightPlansEpic2FlightPlans.ActiveThe Plan Index to check.

Returns

DirectToState

the DirectToState.


getDirectToTargetIcao()

getDirectToTargetIcao(): undefined | string

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

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.


getFinalApproachTrueCourse()

getFinalApproachTrueCourse(facility, approach): Promise<number>

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

Get the true course for the final approach

Parameters

ParameterTypeDescription
facilityAirportFacilityDestination airport facility
approachApproachProcedureThe approach

Returns

Promise<number>

the true course for the final approach.


getFlightPlan()

getFlightPlan(index): FlightPlan

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

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

Parameters

ParameterTypeDefault valueDescription
indexEpic2FlightPlansEpic2FlightPlans.ActiveThe 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-epic2/shared/Fms/Epic2Fms.ts:563

Gets the ALTN airport of a flight plan

Parameters

ParameterTypeDescription
planIndex?numberthe flight plan index

Returns

undefined | string

the ALTN airport FS ICAO, or undefined


getFlightPlanVisualApproach()

getFlightPlanVisualApproach(planIndex): undefined | string

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

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

Parameters

ParameterTypeDescription
planIndexnumberthe plan index

Returns

undefined | string

a string


getFlightPlanVisualApproachVfrVpa()

getFlightPlanVisualApproachVfrVpa(planIndex): undefined | number

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

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

Parameters

ParameterTypeDescription
planIndexnumberthe plan index

Returns

undefined | number

a number, in degrees


getModFlightPlan()

getModFlightPlan(): FlightPlan

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

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:495

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:484

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

Returns

number

A Flight Plan Index


getUserFacilities()

getUserFacilities(): UserFacility[]

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

Gets all user facilities.

Returns

UserFacility[]

an array of user facilities


getVerticalPlanForFmcRender()

getVerticalPlanForFmcRender(): VerticalFlightPlan

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

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


initFlightPlans()

initFlightPlans(): Promise<void>

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

Initialises the flight plans on the primary instrument.

Returns

Promise<void>


insertAirwaySegment()

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

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

Adds an airway and airway segment to the flight plan.

Parameters

ParameterTypeDescription
airwayAirwayObjectThe airway object.
entryIntersectionFacilityThe entry intersection facility.
exitIntersectionFacilityThe exit intersection facility.
segmentIndexnumberIs the segment index for the entry leg.
legIndexnumberIs the leg index of the entry leg in the segment of the

Returns

void


insertApproach()

insertApproach(description): Promise<boolean>

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

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

Parameters

ParameterTypeDescription
descriptionApproachProcedureDescriptionthe 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:1563

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

Parameters

ParameterTypeDescription
facilityAirportFacilityis the facility that contains the procedure to add.
arrivalIndexnumberis the index of the arrival procedure.
arrivalRunwayTransitionIndexnumberis the index of the arrival runway transition.
enrouteTransitionIndexnumberis the index of the enroute transition.
oneWayRunway?OneWayRunwayis the one way runway to set as the destination leg.

Returns

void


insertDeparture()

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

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

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

Parameters

ParameterTypeDescription
facilityAirportFacilityis the facility that contains the procedure to add.
departureIndexnumberis the index of the departure
departureRunwayIndexnumberis the index of the runway transition
enrouteTransitionIndexnumberis the index of the enroute transition
oneWayRunway?OneWayRunwayis the one way runway to set as the origin leg.

Returns

void


insertHold()

insertHold(segmentIndex, legIndex, holdLeg): boolean

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

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

ParameterTypeDescription
segmentIndexnumberThe index of the segment that contains the hold's parent leg.
legIndexnumberThe index of the hold's parent leg in its segment.
holdLegFlightPlanLegThe 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:3066

Inserts a PPOS hold as the active leg

Parameters

ParameterTypeDescription
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:922

Method to insert a waypoint to the flightplan.

Parameters

ParameterTypeDefault valueDescription
facilityFacilityundefinedis the new facility to add a leg to.
segmentIndex?numberundefinedis index of the segment to add the waypoint to
legIndex?numberundefinedis the index to insert the waypoint (if none, append)
addDisco?booleantruewhether 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:3158

Intercepts the chosen leg with that course

Parameters

ParameterTypeDescription
segmentIndexnumberThe index of the segment which contains the leg being intercepted
legIndexnumberThe index of the leg within the segment that is being intercepted
coursenumberThe course with which to intercept the leg

Returns

void


isFirstEnrouteSegment()

isFirstEnrouteSegment(segmentIndex): boolean

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

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

Parameters

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

Method to remove an airway from the flight plan.

Parameters

ParameterTypeDescription
segmentIndexnumberis the segment index of the airway to remove.

Returns

void


removeApproach()

removeApproach(): Promise<void>

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

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:2292

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:2261

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:751

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

ParameterTypeDefault valueDescription
planIndexEpic2FlightPlansEpic2FlightPlans.PendingThe flight plan index.
lateralLegIndex?numberundefinedThe 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?booleantrueWhether to calculate the flight plan
resetOrigin?booleanfalseWhether to reset the dto origin variable

Returns

void


removeUserFacility()

removeUserFacility(userFacility): void

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

Removes a user facility.

Parameters

ParameterTypeDescription
userFacilityUserFacilitythe facility to remove.

Returns

void


removeWaypoint()

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

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

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

Parameters

ParameterTypeDefault valueDescription
segmentIndexnumberundefinedThe index of the segment containing the leg to remove.
segmentLegIndexnumberundefinedThe index of the leg to remove in its segment.
skipFafMapCheckbooleanfalseWhether to force deletion regardless of FAF/MAP flags
skipHoldDeletebooleanfalseWhether 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:1251

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

Parameters

ParameterTypeDescription
airportundefined | AirportFacilityis the facility of the destination airport.
runway?OneWayRunwayis the selected runway at the destination facility.

Returns

void


setFacilityInfo()

setFacilityInfo(): Promise<void>

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

Sets the Facility Info cache in the Fms.

Returns

Promise<void>


setFlightPlanAlternate()

setFlightPlanAlternate(facility): void

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

Sets the ALTN airport of a flight plan

Parameters

ParameterTypeDescription
facilityundefined | AirportFacilitythe ALTN airport facility, or undefined

Returns

void


setFlightPlanVisualApproach()

setFlightPlanVisualApproach(planIndex, runwayDesignator): void

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

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

Parameters

ParameterTypeDescription
planIndexnumberthe plan index
runwayDesignatorundefined | stringthe visual approach's runway designator

Returns

void


setFlightPlanVisualApproachVfrVpa()

setFlightPlanVisualApproachVfrVpa(planIndex, vpa): void

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

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

Parameters

ParameterTypeDescription
planIndexnumberthe plan index
vpaundefined | numberthe 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:1217

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

Parameters

ParameterTypeDescription
airportundefined | AirportFacilityis the facility of the origin airport.
runway?OneWayRunwayis the onewayrunway

Returns

void


setRnavMinima()

setRnavMinima(minima): void

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

Sets the RNAV minima in the FMS approach details

Parameters

ParameterTypeDescription
minimaRnavMinimaThe RNAV minima to set

Returns

void


setUserConstraint()

setUserConstraint(globalLegIndex, verticalData): boolean

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

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

Parameters

ParameterTypeDescription
globalLegIndexnumberThe global index of the leg to modify.
verticalDataOmit<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:169

Switches the performance proxy to use the FMC render plan

Returns

void