Class: Autopilot<Config>
Defined in: src/sdk/autopilot/Autopilot.ts:123
An Autopilot.
Type Parameters
Type Parameter | Default type |
---|---|
Config extends APConfig | APConfig |
Constructors
Constructor
new Autopilot<
Config
>(bus
,flightPlanner
,config
,stateManager
):Autopilot
<Config
>
Defined in: src/sdk/autopilot/Autopilot.ts:201
Creates an instance of the Autopilot.
Parameters
Parameter | Type | Description |
---|---|---|
bus | EventBus | The event bus. |
flightPlanner | FlightPlanner | This autopilot's associated flight planner. |
config | Config | This autopilot's configuration. |
stateManager | APStateManager | This autopilot's state manager. |
Returns
Autopilot
<Config
>
Properties
_apValues
protected
readonly
_apValues:object
Defined in: src/sdk/autopilot/Autopilot.ts:160
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
>
altCapArmed
protected
altCapArmed:boolean
=false
Defined in: src/sdk/autopilot/Autopilot.ts:148
apDriver
protected
readonly
apDriver:AutopilotDriver
Defined in: src/sdk/autopilot/Autopilot.ts:139
This autopilot's sim autopilot driver.
apValues
readonly
apValues:APValues
Defined in: src/sdk/autopilot/Autopilot.ts:190
autopilotInitialized
protected
autopilotInitialized:boolean
=false
Defined in: src/sdk/autopilot/Autopilot.ts:192
bus
protected
readonly
bus:EventBus
Defined in: src/sdk/autopilot/Autopilot.ts:202
The event bus.
cdiSource
protected
cdiSource:Readonly
<NavSourceId
>
Defined in: src/sdk/autopilot/Autopilot.ts:141
config
protected
readonly
config:Config
Defined in: src/sdk/autopilot/Autopilot.ts:204
This autopilot's configuration.
currentAltitude
protected
currentAltitude:number
=0
Defined in: src/sdk/autopilot/Autopilot.ts:152
directors
readonly
directors:APDirectors
Defined in: src/sdk/autopilot/Autopilot.ts:125
This autopilot's plane directors.
flightPlanner
protected
readonly
flightPlanner:FlightPlanner
Defined in: src/sdk/autopilot/Autopilot.ts:203
This autopilot's associated flight planner.
flightPlanSynced
protected
flightPlanSynced:boolean
=false
Defined in: src/sdk/autopilot/Autopilot.ts:155
inClimb
protected
inClimb:boolean
=false
Defined in: src/sdk/autopilot/Autopilot.ts:151
lateralModeFailed
protected
lateralModeFailed:boolean
=false
Defined in: src/sdk/autopilot/Autopilot.ts:149
lateralModes
protected
lateralModes:Map
<APLateralModes
,PlaneDirector
>
Defined in: src/sdk/autopilot/Autopilot.ts:143
navToNavManager
readonly
navToNavManager:undefined
|NavToNavManager
|NavToNavManager2
Defined in: src/sdk/autopilot/Autopilot.ts:128
This autopilot's nav-to-nav transfer manager.
navToNavManagerToUse
protected
readonly
navToNavManagerToUse:undefined
|NavToNavManager2
Defined in: src/sdk/autopilot/Autopilot.ts:130
requireApproachIsActiveForNavToNav
protected
requireApproachIsActiveForNavToNav:boolean
=true
Defined in: src/sdk/autopilot/Autopilot.ts:158
Can be set to false in child classes to override behavior for certain aircraft.
stateManager
readonly
stateManager:APStateManager
Defined in: src/sdk/autopilot/Autopilot.ts:205
This autopilot's state manager.
variableBankManager
readonly
variableBankManager:undefined
|Record
<any
,any
>
Defined in: src/sdk/autopilot/Autopilot.ts:136
This autopilot's variable bank angle Manager.
verticalAltitudeArmed
protected
verticalAltitudeArmed:APAltitudeModes
=APAltitudeModes.NONE
Defined in: src/sdk/autopilot/Autopilot.ts:146
verticalApproachArmed
protected
verticalApproachArmed:APVerticalModes
=APVerticalModes.NONE
Defined in: src/sdk/autopilot/Autopilot.ts:147
verticalModes
protected
verticalModes:Map
<APVerticalModes
,PlaneDirector
>
Defined in: src/sdk/autopilot/Autopilot.ts:145
vnavCaptureType
protected
vnavCaptureType:VNavAltCaptureType
=VNavAltCaptureType.None
Defined in: src/sdk/autopilot/Autopilot.ts:153
vnavManager
readonly
vnavManager:undefined
|VNavManager
Defined in: src/sdk/autopilot/Autopilot.ts:133
This autopilot's VNav Manager.
Methods
approachPressed()
protected
approachPressed(set?
):void
Defined in: src/sdk/autopilot/Autopilot.ts:536
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
checkModes()
protected
checkModes():void
Defined in: src/sdk/autopilot/Autopilot.ts:1032
Checks if all the active and armed modes are still in their proper state and takes corrective action if not.
Returns
void
checkRollModeActive()
protected
checkRollModeActive():void
Defined in: src/sdk/autopilot/Autopilot.ts:1350
Checks if the sim AP is in roll mode and sets it if not.
Returns
void
deactivateArmedOrActiveLateralMode()
protected
deactivateArmedOrActiveLateralMode(mode
):boolean
Defined in: src/sdk/autopilot/Autopilot.ts:463
Attempts to deactivate an armed or active lateral mode.
Parameters
Parameter | Type | Description |
---|---|---|
mode | APLateralModes | The lateral mode to deactivate. |
Returns
boolean
Whether the specified mode was armed or active and deactivated by this method.
deactivateArmedOrActiveVerticalMode()
protected
deactivateArmedOrActiveVerticalMode(mode
):boolean
Defined in: src/sdk/autopilot/Autopilot.ts:509
Attempts to deactivate an armed or active vertical mode.
Parameters
Parameter | Type | Description |
---|---|---|
mode | APVerticalModes | The vertical mode to deactivate. |
Returns
boolean
Whether the specified mode was armed or active and deactivated by this method.
getArmableApproachType()
protected
getArmableApproachType():APLateralModes
Defined in: src/sdk/autopilot/Autopilot.ts:615
Returns the AP Lateral Mode that can be armed.
Returns
The AP Lateral Mode that can be armed.
getDefaultLateralMode()
protected
getDefaultLateralMode():APLateralModes
Defined in: src/sdk/autopilot/Autopilot.ts:1369
Get the default lateral mode from APConfig
Returns
default lateral mode
getDefaultVerticalMode()
protected
getDefaultVerticalMode():APVerticalModes
Defined in: src/sdk/autopilot/Autopilot.ts:1381
Get the default vertical mode from APConfig
Returns
default vertical mode
handleApFdStateChange()
protected
handleApFdStateChange():void
Defined in: src/sdk/autopilot/Autopilot.ts:1312
Manages the FD state and the modes when AP/FD are off.
Returns
void
initLateralModes()
protected
initLateralModes():void
Defined in: src/sdk/autopilot/Autopilot.ts:729
Initializes the Autopilot with the available lateral modes from the config.
Returns
void
initNavToNavManager()
protected
initNavToNavManager():void
Defined in: src/sdk/autopilot/Autopilot.ts:856
Initializes the Autopilot with the available Nav To Nav Manager.
Returns
void
initVerticalModes()
protected
initVerticalModes():void
Defined in: src/sdk/autopilot/Autopilot.ts:895
Initializes the Autopilot with the available vertical modes from the config.
Returns
void
initVNavManager()
protected
initVNavManager():void
Defined in: src/sdk/autopilot/Autopilot.ts:872
Initializes the Autopilot with the available VNav Manager.
Returns
void
isLateralModeActivatedOrArmed()
protected
isLateralModeActivatedOrArmed(mode
):boolean
Defined in: src/sdk/autopilot/Autopilot.ts:454
Checks if a lateral mode is armed or active and if so, deactivates it.
Parameters
Parameter | Type | Description |
---|---|---|
mode | APLateralModes | 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.
lateralPressed()
protected
lateralPressed(data
):void
Defined in: src/sdk/autopilot/Autopilot.ts:350
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
manageAltitudeCapture()
protected
manageAltitudeCapture():void
Defined in: src/sdk/autopilot/Autopilot.ts:1101
Checks and sets the proper armed altitude mode.
Returns
void
monitorAdditionalEvents()
protected
monitorAdditionalEvents():void
Defined in: src/sdk/autopilot/Autopilot.ts:1305
Additional events to be monitored (to be overridden).
Returns
void
monitorApSpeedValues()
protected
monitorApSpeedValues():void
Defined in: src/sdk/autopilot/Autopilot.ts:1289
Overridable method for setting the selected speed values for the A/P to follow.
Returns
void
monitorEvents()
protected
monitorEvents():void
Defined in: src/sdk/autopilot/Autopilot.ts:1157
Monitors subevents and bus events.
Returns
void
onAfterUpdate()
protected
onAfterUpdate():void
Defined in: src/sdk/autopilot/Autopilot.ts:335
This method runs each update cycle after the update occurs.
Returns
void
onBeforeUpdate()
protected
onBeforeUpdate():void
Defined in: src/sdk/autopilot/Autopilot.ts:328
This method runs each update cycle before the update occurs.
Returns
void
onInitialized()
protected
onInitialized():void
Defined in: src/sdk/autopilot/Autopilot.ts:342
This method runs whenever the initialized state of the Autopilot changes.
Returns
void
setAltHold()
protected
setAltHold():void
Defined in: src/sdk/autopilot/Autopilot.ts:718
Method called when the ALT button is pressed.
Returns
void
setLateralActive()
protected
setLateralActive(mode
):void
Defined in: src/sdk/autopilot/Autopilot.ts:645
Callback to set the lateral active mode.
Parameters
Parameter | Type | Description |
---|---|---|
mode | APLateralModes | is the mode being set. |
Returns
void
setVerticalActive()
protected
setVerticalActive(mode
):void
Defined in: src/sdk/autopilot/Autopilot.ts:673
Callback to set the vertical active mode.
Parameters
Parameter | Type | Description |
---|---|---|
mode | APVerticalModes | is the mode being set. |
Returns
void
setVerticalApproachArmed()
protected
setVerticalApproachArmed(mode
):void
Defined in: src/sdk/autopilot/Autopilot.ts:709
Callback to set the vertical approach armed mode.
Parameters
Parameter | Type | Description |
---|---|---|
mode | APVerticalModes | is the mode being set. |
Returns
void
setVerticalArmed()
protected
setVerticalArmed(mode
):void
Defined in: src/sdk/autopilot/Autopilot.ts:694
Callback to set the vertical armed mode.
Parameters
Parameter | Type | Description |
---|---|---|
mode | APVerticalModes | is the mode being set. |
Returns
void
togaPressed()
protected
togaPressed():void
Defined in: src/sdk/autopilot/Autopilot.ts:567
Handles input from the State Manager when the TOGA button is pressed (K event AUTO_THROTTLE_TO_GA)
Returns
void
update()
update():
void
Defined in: src/sdk/autopilot/Autopilot.ts:312
Update method for the Autopilot.
Returns
void
updateModes()
protected
updateModes():void
Defined in: src/sdk/autopilot/Autopilot.ts:1069
Runs update on each of the active and armed modes.
Returns
void
updateNavToNavManagerAfter()
protected
updateNavToNavManagerAfter():void
Defined in: src/sdk/autopilot/Autopilot.ts:1150
Updates this autopilot's nav-to-nav manager after directors have been updated.
Returns
void
updateNavToNavManagerBefore()
protected
updateNavToNavManagerBefore():void
Defined in: src/sdk/autopilot/Autopilot.ts:1143
Updates this autopilot's nav-to-nav manager before directors have been updated.
Returns
void
verticalPressed()
protected
verticalPressed(data
):void
Defined in: src/sdk/autopilot/Autopilot.ts:398
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