Class: MfdUserSettingManager
Defined in: workingtitle-instruments-epic2/shared/Settings/MfdUserSettings.ts:154
A manager for MFD user settings. All settings are saved in crew profiles.
Implements
UserSettingManager
<MfdAllUserSettingTypes
>
Constructors
Constructor
new MfdUserSettingManager(
bus
,displayIndices
,config
):MfdUserSettingManager
Defined in: workingtitle-instruments-epic2/shared/Settings/MfdUserSettings.ts:204
Constructor.
Parameters
Parameter | Type | Description |
---|---|---|
bus | EventBus | The event bus. |
displayIndices | DisplayUnitIndices [] | The indices of the Displays for which to get a manager. |
config | AvionicsConfig | The avionics config |
Returns
MfdUserSettingManager
Properties
displayIndices
readonly
displayIndices:DisplayUnitIndices
[]
Defined in: workingtitle-instruments-epic2/shared/Settings/MfdUserSettings.ts:204
The indices of the Displays for which to get a manager.
Methods
getAliasedManager()
getAliasedManager(
displayIndex
):UserSettingManager
<MfdAliasedUserSettingTypes
>
Defined in: workingtitle-instruments-epic2/shared/Settings/MfdUserSettings.ts:250
Gets a manager for aliased MFD user settings for an indexed GDU.
Parameters
Parameter | Type | Description |
---|---|---|
displayIndex | DisplayUnitIndices | The index of the GDU for which to get an aliased setting manager. |
Returns
UserSettingManager
<MfdAliasedUserSettingTypes
>
A manager for aliased MFD user settings for the specified GDU.
Throws
RangeError if index
is less than 1 or greater than the number of GDUs supported by this manager.
getAllSettings()
getAllSettings():
UserSetting
<UserSettingValue
>[]
Defined in: workingtitle-instruments-epic2/shared/Settings/MfdUserSettings.ts:235
Returns
UserSetting
<UserSettingValue
>[]
Inherit Doc
Implementation of
UserSettingManager.getAllSettings
getSetting()
getSetting<
K
>(name
):UserSetting
<NonNullable
<MfdAllUserSettingTypes
[K
]>>
Defined in: workingtitle-instruments-epic2/shared/Settings/MfdUserSettings.ts:225
Type Parameters
Type Parameter |
---|
K extends `terrWxState_${number}` | `trafficEnabled_${number}` | `mapDisplayMode_${number}` | `airportEnabled_${number}` | `vorEnabled_${number}` | `ndbEnabled_${number}` | `intersectionEnabled_${number}` | `pilotEnteredEnabled_${number}` | `hiAltAirwaysEnabled_${number}` | `loAltAirwaysEnabled_${number}` | `terminalAirspacesEnabled_${number}` | `specialAirspacesEnabled_${number}` | `missedAppEnabled_${number}` | `alternateEnabled_${number}` | `constraintsEnabled_${number}` | `boundariesEnabled_${number}` | `majorRoadwaysEnabled_${number}` | `minorRoadwaysEnabled_${number}` | `citiesEnabled_${number}` | `railwaysEnabled_${number}` | `vfrRefPointsEnabled_${number}` | `waterHighlightsEnabled_${number}` | `terrainEnabled_${number}` | `saTerrainEnabled_${number}` | `weatherMode_${number}` | `vsdEnabled_${number}` | `tcasTrendVectorEnabled_${number}` | `aircraftOnChartsEnabled_${number}` | `tfcEnabled_${number}` | `terrWxContrast_${number}` | `mapRange_${number}` | `mapWaypointsDisplay_${number}` | `basicOperatingWeightLbs_${number}` | `passengerWeightLbs_${number}` | `cruiseSpeedKts_${number}` | `cruiseSpeedMach_${number}` | "tcasVerticalRange" | "perfMode" |
Parameters
Parameter | Type |
---|---|
name | K |
Returns
UserSetting
<NonNullable
<MfdAllUserSettingTypes
[K
]>>
Inherit Doc
Implementation of
UserSettingManager.getSetting
mapTo()
mapTo<
M
>(map
):UserSettingManager
<M
&MfdIndexedUserSettingTypes
<number
> &MfdNonIndexedUserSettingTypes
>
Defined in: workingtitle-instruments-epic2/shared/Settings/MfdUserSettings.ts:240
Type Parameters
Type Parameter |
---|
M extends UserSettingRecord |
Parameters
Parameter | Type |
---|---|
map | UserSettingMap <M , MfdAllUserSettingTypes > |
Returns
UserSettingManager
<M
& MfdIndexedUserSettingTypes
<number
> & MfdNonIndexedUserSettingTypes
>
Inherit Doc
Implementation of
UserSettingManager.mapTo
tryGetSetting()
tryGetSetting<
K
>(name
):K
extends`terrWxState_${number}`
|`trafficEnabled_${number}`
|`mapDisplayMode_${number}`
|`airportEnabled_${number}`
|`vorEnabled_${number}`
|`ndbEnabled_${number}`
|`intersectionEnabled_${number}`
|`pilotEnteredEnabled_${number}`
|`hiAltAirwaysEnabled_${number}`
|`loAltAirwaysEnabled_${number}`
|`terminalAirspacesEnabled_${number}`
|`specialAirspacesEnabled_${number}`
|`missedAppEnabled_${number}`
|`alternateEnabled_${number}`
|`constraintsEnabled_${number}`
|`boundariesEnabled_${number}`
|`majorRoadwaysEnabled_${number}`
|`minorRoadwaysEnabled_${number}`
|`citiesEnabled_${number}`
|`railwaysEnabled_${number}`
|`vfrRefPointsEnabled_${number}`
|`waterHighlightsEnabled_${number}`
|`terrainEnabled_${number}`
|`saTerrainEnabled_${number}`
|`weatherMode_${number}`
|`vsdEnabled_${number}`
|`tcasTrendVectorEnabled_${number}`
|`aircraftOnChartsEnabled_${number}`
|`tfcEnabled_${number}`
|`terrWxContrast_${number}`
|`mapRange_${number}`
|`mapWaypointsDisplay_${number}`
|`basicOperatingWeightLbs_${number}`
|`passengerWeightLbs_${number}`
|`cruiseSpeedKts_${number}`
|`cruiseSpeedMach_${number}`
| keyof MfdNonIndexedUserSettingTypes ?UserSetting
<MfdAllUserSettingTypes
[K
<K
>]> :undefined
Defined in: workingtitle-instruments-epic2/shared/Settings/MfdUserSettings.ts:220
Type Parameters
Type Parameter |
---|
K extends string |
Parameters
Parameter | Type |
---|---|
name | K |
Returns
K
extends `terrWxState_${number}`
| `trafficEnabled_${number}`
| `mapDisplayMode_${number}`
| `airportEnabled_${number}`
| `vorEnabled_${number}`
| `ndbEnabled_${number}`
| `intersectionEnabled_${number}`
| `pilotEnteredEnabled_${number}`
| `hiAltAirwaysEnabled_${number}`
| `loAltAirwaysEnabled_${number}`
| `terminalAirspacesEnabled_${number}`
| `specialAirspacesEnabled_${number}`
| `missedAppEnabled_${number}`
| `alternateEnabled_${number}`
| `constraintsEnabled_${number}`
| `boundariesEnabled_${number}`
| `majorRoadwaysEnabled_${number}`
| `minorRoadwaysEnabled_${number}`
| `citiesEnabled_${number}`
| `railwaysEnabled_${number}`
| `vfrRefPointsEnabled_${number}`
| `waterHighlightsEnabled_${number}`
| `terrainEnabled_${number}`
| `saTerrainEnabled_${number}`
| `weatherMode_${number}`
| `vsdEnabled_${number}`
| `tcasTrendVectorEnabled_${number}`
| `aircraftOnChartsEnabled_${number}`
| `tfcEnabled_${number}`
| `terrWxContrast_${number}`
| `mapRange_${number}`
| `mapWaypointsDisplay_${number}`
| `basicOperatingWeightLbs_${number}`
| `passengerWeightLbs_${number}`
| `cruiseSpeedKts_${number}`
| `cruiseSpeedMach_${number}`
| keyof MfdNonIndexedUserSettingTypes ? UserSetting
<MfdAllUserSettingTypes
[K
<K
>]> : undefined
Inherit Doc
Implementation of
UserSettingManager.tryGetSetting
whenSettingChanged()
whenSettingChanged<
K
>(name
):Consumer
<NonNullable
<MfdAllUserSettingTypes
[K
]>>
Defined in: workingtitle-instruments-epic2/shared/Settings/MfdUserSettings.ts:230
Type Parameters
Type Parameter |
---|
K extends `terrWxState_${number}` | `trafficEnabled_${number}` | `mapDisplayMode_${number}` | `airportEnabled_${number}` | `vorEnabled_${number}` | `ndbEnabled_${number}` | `intersectionEnabled_${number}` | `pilotEnteredEnabled_${number}` | `hiAltAirwaysEnabled_${number}` | `loAltAirwaysEnabled_${number}` | `terminalAirspacesEnabled_${number}` | `specialAirspacesEnabled_${number}` | `missedAppEnabled_${number}` | `alternateEnabled_${number}` | `constraintsEnabled_${number}` | `boundariesEnabled_${number}` | `majorRoadwaysEnabled_${number}` | `minorRoadwaysEnabled_${number}` | `citiesEnabled_${number}` | `railwaysEnabled_${number}` | `vfrRefPointsEnabled_${number}` | `waterHighlightsEnabled_${number}` | `terrainEnabled_${number}` | `saTerrainEnabled_${number}` | `weatherMode_${number}` | `vsdEnabled_${number}` | `tcasTrendVectorEnabled_${number}` | `aircraftOnChartsEnabled_${number}` | `tfcEnabled_${number}` | `terrWxContrast_${number}` | `mapRange_${number}` | `mapWaypointsDisplay_${number}` | `basicOperatingWeightLbs_${number}` | `passengerWeightLbs_${number}` | `cruiseSpeedKts_${number}` | `cruiseSpeedMach_${number}` | "tcasVerticalRange" | "perfMode" |
Parameters
Parameter | Type |
---|---|
name | K |
Returns
Consumer
<NonNullable
<MfdAllUserSettingTypes
[K
]>>
Inherit Doc
Implementation of
UserSettingManager.whenSettingChanged