Class: Epic2Autopilot
Defined in: workingtitle-instruments-epic2/shared/Autopilot/Epic2Autopilot.ts:23
Epic 2 autopilot.
Extends
Constructors
Constructor
new Epic2Autopilot(
bus
,flightPlanner
,config
,stateManager
,settingsManager
,headingDataProvider
,stallDataProvider
):Epic2Autopilot
Defined in: workingtitle-instruments-epic2/shared/Autopilot/Epic2Autopilot.ts:75
Creates an instance of the Epic 2 Autopilot.
Parameters
Parameter | Type | Description |
---|---|---|
bus | EventBus | The event bus. |
flightPlanner | FlightPlanner | This autopilot's associated flight planner. |
config | APConfig | This autopilot's configuration. |
stateManager | Epic2APStateManager | This autopilot's state manager. |
settingsManager | UserSettingManager <PfdAllUserSettingTypes > | The settings manager. |
headingDataProvider | DefaultHeadingDataProvider | The heading data provider to synchronize heading when requested. |
stallDataProvider | DefaultStallWarningDataProvider | The stall data provider for handling abnormal disengagement due to stalls |
Returns
Epic2Autopilot
Overrides
Properties
_apValues
protected
readonly
_apValues:object
Defined in: sdk/autopilot/Autopilot.ts:65
apApproachModeOn
apApproachModeOn:
Subject
<boolean
>
approachHasGP
approachHasGP:
Subject
<boolean
>
approachIsActive
approachIsActive:
Subject
<boolean
>
capturedAltitude
capturedAltitude:
Subject
<number
>
cdiId
cdiId:
string
cdiSource
cdiSource:
Subject
<Readonly
<NavSourceId
>>
isSelectedSpeedInMach
isSelectedSpeedInMach:
Subject
<boolean
>
lateralActive
lateralActive:
Subject
<APLateralModes
>
lateralArmed
lateralArmed:
Subject
<APLateralModes
>
maxBankAngle
maxBankAngle:
Subject
<number
>
maxBankId
maxBankId:
Subject
<number
>
maxNoseDownPitchAngle
maxNoseDownPitchAngle:
Subject
<number
>
maxNoseUpPitchAngle
maxNoseUpPitchAngle:
Subject
<number
>
nav1HasGs
nav1HasGs:
Subject
<boolean
>
nav2HasGs
nav2HasGs:
Subject
<boolean
>
nav3HasGs
nav3HasGs:
Subject
<boolean
>
nav4HasGs
nav4HasGs:
Subject
<boolean
>
selectedAltitude
selectedAltitude:
Subject
<number
>
selectedFlightPathAngle
selectedFlightPathAngle:
Subject
<number
>
selectedHeading
selectedHeading:
Subject
<number
>
selectedIas
selectedIas:
Subject
<number
>
selectedMach
selectedMach:
Subject
<number
>
selectedPitch
selectedPitch:
Subject
<number
>
selectedVerticalSpeed
selectedVerticalSpeed:
Subject
<number
>
simRate
simRate:
Subject
<number
>
verticalActive
verticalActive:
Subject
<APVerticalModes
>
verticalArmed
verticalArmed:
Subject
<APVerticalModes
>
Inherited from
altArmedSubject
protected
readonly
altArmedSubject:Subject
<boolean
>
Defined in: workingtitle-instruments-epic2/shared/Autopilot/Epic2Autopilot.ts:43
altCapArmed
protected
altCapArmed:boolean
=false
Defined in: sdk/autopilot/Autopilot.ts:53
Inherited from
altSelectManager
protected
readonly
altSelectManager:AltitudeSelectManager
Defined in: workingtitle-instruments-epic2/shared/Autopilot/Epic2Autopilot.ts:45
apDriver
protected
readonly
apDriver:AutopilotDriver
Defined in: sdk/autopilot/Autopilot.ts:44
This autopilot's sim autopilot driver.
Inherited from
apValues
readonly
apValues:APValues
Defined in: sdk/autopilot/Autopilot.ts:95
Inherited from
autopilotInitialized
protected
autopilotInitialized:boolean
=false
Defined in: sdk/autopilot/Autopilot.ts:97
Inherited from
Autopilot
.autopilotInitialized
bus
protected
readonly
bus:EventBus
Defined in: sdk/autopilot/Autopilot.ts:107
The event bus.
Inherited from
cdiSource
protected
cdiSource:Readonly
<NavSourceId
>
Defined in: sdk/autopilot/Autopilot.ts:46
Inherited from
config
protected
readonly
config:APConfig
Defined in: sdk/autopilot/Autopilot.ts:109
This autopilot's configuration.
Inherited from
currentAltitude
protected
currentAltitude:number
=0
Defined in: sdk/autopilot/Autopilot.ts:57
Inherited from
externalAutopilotInstalled
readonly
externalAutopilotInstalled:Subject
<boolean
>
Defined in: workingtitle-instruments-epic2/shared/Autopilot/Epic2Autopilot.ts:41
flightPlanner
protected
readonly
flightPlanner:FlightPlanner
Defined in: sdk/autopilot/Autopilot.ts:108
This autopilot's associated flight planner.
Inherited from
flightPlanSynced
protected
flightPlanSynced:boolean
=false
Defined in: sdk/autopilot/Autopilot.ts:60
Inherited from
fmaData
protected
readonly
fmaData:ObjectSubject
<Epic2FmaData
>
Defined in: workingtitle-instruments-epic2/shared/Autopilot/Epic2Autopilot.ts:48
headingSyncController
protected
readonly
headingSyncController:Epic2HeadingSyncController
Defined in: workingtitle-instruments-epic2/shared/Autopilot/Epic2Autopilot.ts:46
inClimb
protected
inClimb:boolean
=false
Defined in: sdk/autopilot/Autopilot.ts:56
Inherited from
lateralArmedModeSubject
protected
readonly
lateralArmedModeSubject:Subject
<APLateralModes
>
Defined in: workingtitle-instruments-epic2/shared/Autopilot/Epic2Autopilot.ts:42
lateralModeFailed
protected
lateralModeFailed:boolean
=false
Defined in: sdk/autopilot/Autopilot.ts:54
Inherited from
lateralModes
protected
readonly
lateralModes:Map
<number
,PlaneDirector
>
Defined in: sdk/autopilot/Autopilot.ts:48
Inherited from
navToNavManager
readonly
navToNavManager:undefined
|NavToNavManager2
Defined in: sdk/autopilot/Autopilot.ts:35
This autopilot's nav-to-nav transfer manager.
Inherited from
requireApproachIsActiveForNavToNav
protected
requireApproachIsActiveForNavToNav:boolean
=true
Defined in: sdk/autopilot/Autopilot.ts:63
Can be set to false in child classes to override behavior for certain aircraft.
Inherited from
Autopilot
.requireApproachIsActiveForNavToNav
stateManager
readonly
stateManager:Epic2APStateManager
Defined in: workingtitle-instruments-epic2/shared/Autopilot/Epic2Autopilot.ts:79
This autopilot's state manager.
Inherited from
togaIsOn
protected
togaIsOn:boolean
=false
Defined in: workingtitle-instruments-epic2/shared/Autopilot/Epic2Autopilot.ts:54
variableBankManager
readonly
variableBankManager:undefined
|Record
<any
,any
>
Defined in: sdk/autopilot/Autopilot.ts:41
This autopilot's variable bank angle Manager.
Inherited from
verticalAltitudeArmed
protected
verticalAltitudeArmed:APAltitudeModes
=APAltitudeModes.NONE
Defined in: sdk/autopilot/Autopilot.ts:51
Inherited from
Autopilot
.verticalAltitudeArmed
verticalApproachArmed
protected
verticalApproachArmed:number
=APVerticalModes.NONE
Defined in: sdk/autopilot/Autopilot.ts:52
Inherited from
Autopilot
.verticalApproachArmed
verticalModes
protected
readonly
verticalModes:Map
<number
,PlaneDirector
>
Defined in: sdk/autopilot/Autopilot.ts:49
Inherited from
vnavCaptureType
protected
vnavCaptureType:VNavAltCaptureType
=VNavAltCaptureType.None
Defined in: sdk/autopilot/Autopilot.ts:58
Inherited from
vnavManager
readonly
vnavManager:undefined
|VNavManager
Defined in: sdk/autopilot/Autopilot.ts:38
This autopilot's VNav Manager.
Inherited from
Methods
approachPressed()
protected
approachPressed(set?
):void
Defined in: workingtitle-instruments-epic2/shared/Autopilot/Epic2Autopilot.ts:218
Handles input from the State Manager when the APPR button is pressed.
Parameters
Parameter | Type | Description |
---|---|---|
set? | boolean | is whether this event commands a specific set |
Returns
void
Overrides
checkModes()
protected
checkModes():void
Defined in: sdk/autopilot/Autopilot.ts:790
Checks if all the active and armed modes are still in their proper state and takes corrective action if not.
Returns
void
Inherited from
checkRollModeActive()
protected
checkRollModeActive():void
Defined in: sdk/autopilot/Autopilot.ts:1106
Checks if the sim AP is in roll mode and sets it if not.
Returns
void
Inherited from
createDirectors()
protected
createDirectors(config
):void
Defined in: sdk/autopilot/Autopilot.ts:163
Creates this autopilot's directors.
Parameters
Parameter | Type | Description |
---|---|---|
config | APConfig | This autopilot's configuration. |
Returns
void
Inherited from
createLateralDirectors()
protected
createLateralDirectors(config
):void
Defined in: sdk/autopilot/Autopilot.ts:172
Creates this autopilot's lateral mode directors.
Parameters
Parameter | Type | Description |
---|---|---|
config | APConfig | This autopilot's configuration. |
Returns
void
Inherited from
Autopilot
.createLateralDirectors
createVerticalDirectors()
protected
createVerticalDirectors(config
):void
Defined in: sdk/autopilot/Autopilot.ts:187
Creates this autopilot's vertical mode directors.
Parameters
Parameter | Type | Description |
---|---|---|
config | APConfig | This autopilot's configuration. |
Returns
void
Inherited from
Autopilot
.createVerticalDirectors
deactivateArmedOrActiveLateralMode()
protected
deactivateArmedOrActiveLateralMode(mode
):boolean
Defined in: sdk/autopilot/Autopilot.ts:519
Attempts to deactivate an armed or active lateral mode.
Parameters
Parameter | Type | Description |
---|---|---|
mode | number | The lateral mode to deactivate. |
Returns
boolean
Whether the specified mode was armed or active and deactivated by this method.
Inherited from
Autopilot
.deactivateArmedOrActiveLateralMode
deactivateArmedOrActiveVerticalMode()
protected
deactivateArmedOrActiveVerticalMode(mode
):boolean
Defined in: sdk/autopilot/Autopilot.ts:565
Attempts to deactivate an armed or active vertical mode.
Parameters
Parameter | Type | Description |
---|---|---|
mode | number | The vertical mode to deactivate. |
Returns
boolean
Whether the specified mode was armed or active and deactivated by this method.
Inherited from
Autopilot
.deactivateArmedOrActiveVerticalMode
getArmableApproachType()
protected
getArmableApproachType():number
Defined in: workingtitle-instruments-epic2/shared/Autopilot/Epic2Autopilot.ts:275
Returns the AP Lateral Mode that can be armed.
Returns
number
The AP Lateral Mode that can be armed.
Overrides
Autopilot
.getArmableApproachType
getDefaultLateralMode()
protected
getDefaultLateralMode():APLateralModes
Defined in: sdk/autopilot/Autopilot.ts:1125
Get the default lateral mode from APConfig
Returns
default lateral mode
Inherited from
Autopilot
.getDefaultLateralMode
getDefaultVerticalMode()
protected
getDefaultVerticalMode():APVerticalModes
Defined in: sdk/autopilot/Autopilot.ts:1137
Get the default vertical mode from APConfig
Returns
default vertical mode
Inherited from
Autopilot
.getDefaultVerticalMode
handleApFdStateChange()
protected
handleApFdStateChange():void
Defined in: sdk/autopilot/Autopilot.ts:1067
Manages the FD state and the modes when AP/FD are off.
Returns
void
Inherited from
Autopilot
.handleApFdStateChange
initLateralModeDirector()
protected
initLateralModeDirector(mode
,director
,setBank?
,driveBank?
):void
Defined in: sdk/autopilot/Autopilot.ts:217
Initializes a lateral mode director.
Parameters
Parameter | Type | Description |
---|---|---|
mode | number | The director's mode. |
director | PlaneDirector | The director to initialize. |
setBank? | (bank ) => void | A function that the director can use to set the flight director's commanded bank angle. |
driveBank? | (bank , rate? ) => void | A function that the director can use to drive the flight director's commanded bank angle. |
Returns
void
Inherited from
Autopilot
.initLateralModeDirector
initLateralModes()
protected
initLateralModes():void
Defined in: sdk/autopilot/Autopilot.ts:201
Initializes this autopilot's lateral modes.
Returns
void
Inherited from
initNavToNavManager()
protected
initNavToNavManager():void
Defined in: sdk/autopilot/Autopilot.ts:327
Initializes the Autopilot with the available Nav To Nav Manager.
Returns
void
Inherited from
initVerticalModeDirector()
protected
initVerticalModeDirector(mode
,director
,setPitch?
,drivePitch?
):void
Defined in: workingtitle-instruments-epic2/shared/Autopilot/Epic2Autopilot.ts:164
Initializes a vertical mode director.
Parameters
Parameter | Type | Description |
---|---|---|
mode | number | The director's mode. |
director | PlaneDirector | The director to initialize. |
setPitch? | (pitch , resetServo? , maxNoseDownPitch? , maxNoseUpPitch? ) => void | A function that the director can use to set the flight director's commanded pitch angle. |
drivePitch? | (pitch , adjustForAoa? , adjustForVerticalWind? , rate? , maxNoseDownPitch? , maxNoseUpPitch? ) => void | A function that the director can use to drive the flight director's commanded pitch angle. |
Returns
void
Overrides
Autopilot
.initVerticalModeDirector
initVerticalModes()
protected
initVerticalModes():void
Defined in: workingtitle-instruments-epic2/shared/Autopilot/Epic2Autopilot.ts:151
Initializes this autopilot's vertical modes.
Returns
void
Overrides
initVNavManager()
protected
initVNavManager():void
Defined in: sdk/autopilot/Autopilot.ts:343
Initializes the Autopilot with the available VNav Manager.
Returns
void
Inherited from
isLateralModeActivatedOrArmed()
protected
isLateralModeActivatedOrArmed(mode
):boolean
Defined in: sdk/autopilot/Autopilot.ts:510
Checks if a lateral mode is armed or active and if so, deactivates it.
Parameters
Parameter | Type | Description |
---|---|---|
mode | number | The lateral mode to check and deactivate. |
Returns
boolean
Whether the specified mode was armed or active and deactivated by this method.
Deprecated
Please use deactivateArmedOrActiveLateralMode()
instead.
Inherited from
Autopilot
.isLateralModeActivatedOrArmed
lateralPressed()
protected
lateralPressed(data
):void
Defined in: sdk/autopilot/Autopilot.ts:406
Handles input from the State Manager when a lateral mode button is pressed.
Parameters
Parameter | Type | Description |
---|---|---|
data | APModePressEvent | is the AP Lateral Mode Event Data |
Returns
void
Inherited from
manageAltitudeCapture()
protected
manageAltitudeCapture():void
Defined in: workingtitle-instruments-epic2/shared/Autopilot/Epic2Autopilot.ts:513
Checks and sets the proper armed altitude mode.
Returns
void
Overrides
Autopilot
.manageAltitudeCapture
monitorAdditionalEvents()
protected
monitorAdditionalEvents():void
Defined in: workingtitle-instruments-epic2/shared/Autopilot/Epic2Autopilot.ts:304
Additional events to be monitored (to be overridden).
Returns
void
Overrides
Autopilot
.monitorAdditionalEvents
monitorApSpeedValues()
protected
monitorApSpeedValues():void
Defined in: workingtitle-instruments-epic2/shared/Autopilot/Epic2Autopilot.ts:497
Overridable method for setting the selected speed values for the A/P to follow.
Returns
void
Overrides
Autopilot
.monitorApSpeedValues
monitorEvents()
protected
monitorEvents():void
Defined in: sdk/autopilot/Autopilot.ts:912
Monitors subevents and bus events.
Returns
void
Inherited from
onAfterUpdate()
protected
onAfterUpdate():void
Defined in: workingtitle-instruments-epic2/shared/Autopilot/Epic2Autopilot.ts:130
This method runs each update cycle after the update occurs.
Returns
void
Overrides
onBeforeUpdate()
protected
onBeforeUpdate():void
Defined in: workingtitle-instruments-epic2/shared/Autopilot/Epic2Autopilot.ts:118
This method runs each update cycle before the update occurs.
Returns
void
Overrides
onEpic2VerticalEvent()
protected
onEpic2VerticalEvent(event
):void
Defined in: workingtitle-instruments-epic2/shared/Autopilot/Epic2Autopilot.ts:603
Handles epic2 specific vertical events from the AP state manager.
Parameters
Parameter | Type | Description |
---|---|---|
event | PitchWheelTurned | The event that occured. |
Returns
void
onInitialized()
protected
onInitialized():void
Defined in: workingtitle-instruments-epic2/shared/Autopilot/Epic2Autopilot.ts:135
This method runs whenever the initialized state of the Autopilot changes.
Returns
void
Overrides
setAltHold()
protected
setAltHold():void
Defined in: sdk/autopilot/Autopilot.ts:778
Method called when the ALT button is pressed.
Returns
void
Inherited from
setLateralActive()
protected
setLateralActive(mode
):void
Defined in: workingtitle-instruments-epic2/shared/Autopilot/Epic2Autopilot.ts:193
Callback to set the lateral active mode.
Parameters
Parameter | Type | Description |
---|---|---|
mode | number | is the mode being set. |
Returns
void
Overrides
setLateralArmed()
protected
setLateralArmed(mode
):void
Defined in: sdk/autopilot/Autopilot.ts:718
Callback to set the lateral armed mode.
Parameters
Parameter | Type | Description |
---|---|---|
mode | number | is the mode being set. |
Returns
void
Inherited from
setVerticalActive()
protected
setVerticalActive(mode
):void
Defined in: sdk/autopilot/Autopilot.ts:729
Callback to set the vertical active mode.
Parameters
Parameter | Type | Description |
---|---|---|
mode | number | is the mode being set. |
Returns
void
Inherited from
setVerticalApproachArmed()
protected
setVerticalApproachArmed(mode
):void
Defined in: sdk/autopilot/Autopilot.ts:765
Callback to set the vertical approach armed mode.
Parameters
Parameter | Type | Description |
---|---|---|
mode | number | is the mode being set. |
Returns
void
Inherited from
Autopilot
.setVerticalApproachArmed
setVerticalArmed()
protected
setVerticalArmed(mode
):void
Defined in: sdk/autopilot/Autopilot.ts:750
Callback to set the vertical armed mode.
Parameters
Parameter | Type | Description |
---|---|---|
mode | number | is the mode being set. |
Returns
void
Inherited from
togaPressed()
protected
togaPressed():void
Defined in: workingtitle-instruments-epic2/shared/Autopilot/Epic2Autopilot.ts:559
Handles input from the State Manager when the TOGA button is pressed (K event AUTO_THROTTLE_TO_GA)
Returns
void
Overrides
update()
update():
void
Defined in: sdk/autopilot/Autopilot.ts:366
Update method for the Autopilot.
Returns
void
Inherited from
updateModes()
protected
updateModes():void
Defined in: sdk/autopilot/Autopilot.ts:827
Runs update on each of the active and armed modes.
Returns
void
Inherited from
updateNavToNavManagerAfter()
protected
updateNavToNavManagerAfter():void
Defined in: sdk/autopilot/Autopilot.ts:905
Updates this autopilot's nav-to-nav manager after directors have been updated.
Returns
void
Inherited from
Autopilot
.updateNavToNavManagerAfter
updateNavToNavManagerBefore()
protected
updateNavToNavManagerBefore():void
Defined in: sdk/autopilot/Autopilot.ts:898
Updates this autopilot's nav-to-nav manager before directors have been updated.
Returns
void
Inherited from
Autopilot
.updateNavToNavManagerBefore
verticalPressed()
protected
verticalPressed(data
):void
Defined in: sdk/autopilot/Autopilot.ts:454
Handles input from the State Manager when a vertical mode button is pressed.
Parameters
Parameter | Type | Description |
---|---|---|
data | APModePressEvent | is the AP Vertical Mode Event Data |
Returns
void