Class: VSpeedUserSettingManager

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/VSpeedUserSettings.ts:20

A manager for reference V-speed user settings.

Implements

• UserSettingManager<VSpeedUserSettingTypes>

Constructors

Constructor

new VSpeedUserSettingManager(bus, vSpeedDefs): VSpeedUserSettingManager

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/VSpeedUserSettings.ts:32

Creates a new instance of VSpeedUserSettingManager.

Parameters

Parameter	Type	Description
bus	EventBus	The event bus.
vSpeedDefs	readonly VSpeedDefinition[]	Definitions for each reference V-speed for which to create settings.

Returns

VSpeedUserSettingManager

Properties

vSpeedDefs

readonly vSpeedDefs: readonly VSpeedDefinition[]

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/VSpeedUserSettings.ts:22

An map of groups (keyed on group type) containing the reference V-speeds for which this manager contains settings.

Methods

getAllSettings()

getAllSettings(): UserSetting<UserSettingValue>[]

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/VSpeedUserSettings.ts:100

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<VSpeedUserSettingTypes, K>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/VSpeedUserSettings.ts:90

Gets a setting from this manager.

Type Parameters

Type Parameter
K extends `vSpeedDefaultValue_${string}` | `vSpeedUserValue_${string}` | `vSpeedFmsValue_${string}` | `vSpeedFmsConfigMiscompare_${string}` | `vSpeedShow_${string}`

Parameters

Parameter	Type	Description
name	K	The name of the setting to get.

Returns

UserSettingFromManager<VSpeedUserSettingTypes, K>

The requested setting.

Throws

Error if no setting with the specified name exists.

Implementation of

UserSettingManager.getSetting

---

mapTo()

mapTo<M>(map): UserSettingManager<M & VSpeedUserSettingTypes>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/VSpeedUserSettings.ts:105

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, VSpeedUserSettingTypes>	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 & VSpeedUserSettingTypes>

A new setting manager which supports accessing a subset of this manager's settings using aliased names.

Implementation of

UserSettingManager.mapTo

---

tryGetSetting()

tryGetSetting<K>(name): OptionalUserSettingFromManager<VSpeedUserSettingTypes, K>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/VSpeedUserSettings.ts:85

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<VSpeedUserSettingTypes, K>

The requested setting, or undefined if no such setting exists.

Implementation of

UserSettingManager.tryGetSetting

---

whenSettingChanged()

whenSettingChanged<K>(name): UserSettingConsumerFromManager<VSpeedUserSettingTypes, K>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/VSpeedUserSettings.ts:95

Gets a consumer which notifies handlers when the value of a setting changes.

Type Parameters

Type Parameter
K extends `vSpeedDefaultValue_${string}` | `vSpeedUserValue_${string}` | `vSpeedFmsValue_${string}` | `vSpeedFmsConfigMiscompare_${string}` | `vSpeedShow_${string}`

Parameters

Parameter	Type	Description
name	K	The name of a setting.

Returns

UserSettingConsumerFromManager<VSpeedUserSettingTypes, 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.

Implementation of

UserSettingManager.whenSettingChanged