Class: GduUserSettingManager

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/GduUserSettings.ts:30

A manager for GDU user settings.

Implements

• UserSettingManager<GduAllUserSettingTypes>

Constructors

Constructor

new GduUserSettingManager(bus, gduDefsConfig): GduUserSettingManager

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/GduUserSettings.ts:48

Creates a new instance of GduUserSettingManager.

Parameters

Parameter	Type	Description
bus	EventBus	The event bus.
gduDefsConfig	GduDefsConfig	A configuration object which defines GDU options.

Returns

GduUserSettingManager

Properties

gduCount

readonly gduCount: number

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/GduUserSettings.ts:37

The number of GDUs supported by this manager.

Methods

getAliasedManager()

getAliasedManager(index): UserSettingManager<GduUserSettingTypes>

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

Gets a manager for aliased GDU user settings for an indexed GDU.

Parameters

Parameter	Type	Description
index	number	The index of the GDU for which to get an aliased setting manager.

Returns

UserSettingManager<GduUserSettingTypes>

A manager for aliased GDU 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: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/GduUserSettings.ts:90

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

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/GduUserSettings.ts:80

Gets a setting from this manager.

Type Parameters

Type Parameter
K extends `gduAdcIndex_${number}_g3x` | `gduAhrsIndex_${number}_g3x`

Parameters

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

Returns

UserSettingFromManager<GduAllUserSettingTypes, K>

The requested setting.

Throws

Error if no setting with the specified name exists.

Implementation of

UserSettingManager.getSetting

---

mapTo()

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

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

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

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

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/GduUserSettings.ts:75

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

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

Implementation of

UserSettingManager.tryGetSetting

---

whenSettingChanged()

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

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

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

Type Parameters

Type Parameter
K extends `gduAdcIndex_${number}_g3x` | `gduAhrsIndex_${number}_g3x`

Parameters

Parameter	Type	Description
name	K	The name of a setting.

Returns

UserSettingConsumerFromManager<GduAllUserSettingTypes, 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