Class: GduUserSettingManager
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/GduUserSettings.ts:25
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:43
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:32
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:100
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:85
Returns
UserSetting
<UserSettingValue
>[]
Inherit Doc
Implementation of
UserSettingManager.getAllSettings
getSetting()
getSetting<
K
>(name
):UserSetting
<NonNullable
<GduAllUserSettingTypes
[K
]>>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/GduUserSettings.ts:75
Type Parameters
Type Parameter |
---|
K extends `gduAdcIndex_${number}_g3x` | `gduAhrsIndex_${number}_g3x` |
Parameters
Parameter | Type |
---|---|
name | K |
Returns
UserSetting
<NonNullable
<GduAllUserSettingTypes
[K
]>>
Inherit Doc
Implementation of
UserSettingManager.getSetting
mapTo()
mapTo<
M
>(map
):UserSettingManager
<M
&GduAllUserSettingTypes
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/GduUserSettings.ts:90
Type Parameters
Type Parameter |
---|
M extends UserSettingRecord |
Parameters
Parameter | Type |
---|---|
map | UserSettingMap <M , GduAllUserSettingTypes > |
Returns
UserSettingManager
<M
& GduAllUserSettingTypes
>
Inherit Doc
Implementation of
UserSettingManager.mapTo
tryGetSetting()
tryGetSetting<
K
>(name
):K
extends`gduAdcIndex_${number}_g3x`
|`gduAhrsIndex_${number}_g3x`
?UserSetting
<GduAllUserSettingTypes
[K
<K
>]> :undefined
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/GduUserSettings.ts:70
Type Parameters
Type Parameter |
---|
K extends string |
Parameters
Parameter | Type |
---|---|
name | K |
Returns
K
extends `gduAdcIndex_${number}_g3x`
| `gduAhrsIndex_${number}_g3x`
? UserSetting
<GduAllUserSettingTypes
[K
<K
>]> : undefined
Inherit Doc
Implementation of
UserSettingManager.tryGetSetting
whenSettingChanged()
whenSettingChanged<
K
>(name
):Consumer
<NonNullable
<GduAllUserSettingTypes
[K
]>>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/GduUserSettings.ts:80
Type Parameters
Type Parameter |
---|
K extends `gduAdcIndex_${number}_g3x` | `gduAhrsIndex_${number}_g3x` |
Parameters
Parameter | Type |
---|---|
name | K |
Returns
Consumer
<NonNullable
<GduAllUserSettingTypes
[K
]>>
Inherit Doc
Implementation of
UserSettingManager.whenSettingChanged