Class: FmsSpeedUserSettingManager
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/FmsSpeedUserSettings.ts:113
A manager for FMS speed user settings.
Implements
Constructors
Constructor
new FmsSpeedUserSettingManager(
bus,fmsSpeedsConfig):FmsSpeedUserSettingManager
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/FmsSpeedUserSettings.ts:129
Constructor.
Parameters
| Parameter | Type | Description |
|---|---|---|
bus | EventBus | The event bus. |
fmsSpeedsConfig | FmsSpeedsConfig | Definitions for each aircraft configuration speed limit for which to create a setting. |
Returns
FmsSpeedUserSettingManager
Properties
climbSchedules
readonlyclimbSchedules: readonlyReadonly<FmsSpeedClimbSchedule>[]
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/FmsSpeedUserSettings.ts:117
configurationSpeedDefinitions
readonlyconfigurationSpeedDefinitions: readonlyReadonly<FmsConfigurationSpeedDefinition>[]
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/FmsSpeedUserSettings.ts:115
Definitions for aircraft configuration speed limits, in order from highest to lowest speed.
cruiseSchedules
readonlycruiseSchedules: readonlyReadonly<FmsSpeedCruiseSchedule>[]
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/FmsSpeedUserSettings.ts:118
descentSchedules
readonlydescentSchedules: readonlyReadonly<FmsSpeedDescentSchedule>[]
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/FmsSpeedUserSettings.ts:119
Methods
getAllSettings()
getAllSettings():
UserSetting<UserSettingValue>[]
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/FmsSpeedUserSettings.ts:360
Gets an array of all settings of this manager.
Returns
UserSetting<UserSettingValue>[]
an array of all settings of this manager.
Implementation of
UserSettingManager.getAllSettings
getSetting()
getSetting<
K>(name):UserSettingFromManager<FmsSpeedUserSettingTypes,K>
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/FmsSpeedUserSettings.ts:350
Gets a setting from this manager.
Type Parameters
| Type Parameter |
|---|
K extends `fmsSpeedConfigurationLimit_${number}` | "fmsSpeedClimbScheduleIndex" | "fmsSpeedClimbIas" | "fmsSpeedClimbMach" | "fmsSpeedPilotClimbIas" | "fmsSpeedPilotClimbMach" | "fmsSpeedCruiseScheduleIndex" | "fmsSpeedCruiseIas" | "fmsSpeedCruiseMach" | "fmsSpeedPilotCruiseIas" | "fmsSpeedPilotCruiseMach" | "fmsSpeedDescentScheduleIndex" | "fmsSpeedDescentIas" | "fmsSpeedDescentMach" | "fmsSpeedDescentFpa" | "fmsSpeedPilotDescentIas" | "fmsSpeedPilotDescentMach" | "fmsSpeedPilotDescentFpa" | "fmsSpeedClimbAltitudeCeiling" | "fmsSpeedClimbAltitudeLimit" | "fmsSpeedDescentAltitudeCeiling" | "fmsSpeedDescentAltitudeLimit" | "fmsSpeedDepartureCeiling" | "fmsSpeedDepartureRadius" | "fmsSpeedDepartureLimit" | "fmsSpeedArrivalCeiling" | "fmsSpeedArrivalRadius" | "fmsSpeedArrivalLimit" | "fmsSpeedUserTargetIas" | "fmsSpeedUserTargetMach" | "fmsSpeedUserTargetIsMach" |
Parameters
| Parameter | Type | Description |
|---|---|---|
name | K | The name of the setting to get. |
Returns
UserSettingFromManager<FmsSpeedUserSettingTypes, K>
The requested setting.
Throws
Error if no setting with the specified name exists.
Implementation of
mapTo()
mapTo<
M>(map):UserSettingManager<M&FmsSpeedUserSettingTypes>
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/FmsSpeedUserSettings.ts:365
Maps a subset of this manager's settings to ones with aliased names, and creates a new setting manager which supports accessing the settings using their aliases.
Type Parameters
| Type Parameter |
|---|
M extends UserSettingRecord |
Parameters
| Parameter | Type | Description |
|---|---|---|
map | UserSettingMap<M, FmsSpeedUserSettingTypes> | A map defining the aliases of a subset of this manager's settings, with aliased setting names as keys and original setting names as values. |
Returns
UserSettingManager<M & FmsSpeedUserSettingTypes>
A new setting manager which supports accessing a subset of this manager's settings using aliased names.
Implementation of
tryGetSetting()
tryGetSetting<
K>(name):OptionalUserSettingFromManager<FmsSpeedUserSettingTypes,K>
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/FmsSpeedUserSettings.ts:345
Attempts to get a setting from this manager.
Type Parameters
| Type Parameter |
|---|
K extends string |
Parameters
| Parameter | Type | Description |
|---|---|---|
name | K | The name of the setting to get. |
Returns
OptionalUserSettingFromManager<FmsSpeedUserSettingTypes, K>
The requested setting, or undefined if no such setting exists.
Implementation of
UserSettingManager.tryGetSetting
whenSettingChanged()
whenSettingChanged<
K>(name):UserSettingConsumerFromManager<FmsSpeedUserSettingTypes,K>
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/FmsSpeedUserSettings.ts:355
Gets a consumer which notifies handlers when the value of a setting changes.
Type Parameters
| Type Parameter |
|---|
K extends `fmsSpeedConfigurationLimit_${number}` | "fmsSpeedClimbScheduleIndex" | "fmsSpeedClimbIas" | "fmsSpeedClimbMach" | "fmsSpeedPilotClimbIas" | "fmsSpeedPilotClimbMach" | "fmsSpeedCruiseScheduleIndex" | "fmsSpeedCruiseIas" | "fmsSpeedCruiseMach" | "fmsSpeedPilotCruiseIas" | "fmsSpeedPilotCruiseMach" | "fmsSpeedDescentScheduleIndex" | "fmsSpeedDescentIas" | "fmsSpeedDescentMach" | "fmsSpeedDescentFpa" | "fmsSpeedPilotDescentIas" | "fmsSpeedPilotDescentMach" | "fmsSpeedPilotDescentFpa" | "fmsSpeedClimbAltitudeCeiling" | "fmsSpeedClimbAltitudeLimit" | "fmsSpeedDescentAltitudeCeiling" | "fmsSpeedDescentAltitudeLimit" | "fmsSpeedDepartureCeiling" | "fmsSpeedDepartureRadius" | "fmsSpeedDepartureLimit" | "fmsSpeedArrivalCeiling" | "fmsSpeedArrivalRadius" | "fmsSpeedArrivalLimit" | "fmsSpeedUserTargetIas" | "fmsSpeedUserTargetMach" | "fmsSpeedUserTargetIsMach" |
Parameters
| Parameter | Type | Description |
|---|---|---|
name | K | The name of a setting. |
Returns
UserSettingConsumerFromManager<FmsSpeedUserSettingTypes, K>
a consumer which notifies handlers when the value of the setting changes.
Throws
Error if no setting with the specified name exists.
Deprecated
Please use getSetting(name).sub() instead.