Class: DefaultUnitsUserSettingManager
Defined in: workingtitle-instruments-epic2/shared/Settings/UnitsUserSettings.ts:131
A default implementation of UnitsUserSettingManager which sources setting values from another setting manager.
Implements
Constructors
Constructor
new DefaultUnitsUserSettingManager(
sourceSettingManager
):DefaultUnitsUserSettingManager
Defined in: workingtitle-instruments-epic2/shared/Settings/UnitsUserSettings.ts:169
Parameters
Parameter | Type |
---|---|
sourceSettingManager | UserSettingManager <UnitsUserSettingTypes > |
Returns
DefaultUnitsUserSettingManager
Inherit Doc
Properties
altitudeUnits
readonly
altitudeUnits:Subscribable
<Unit
<Distance
>>
Defined in: workingtitle-instruments-epic2/shared/Settings/UnitsUserSettings.ts:148
The altitude units to use for the current altitude units setting.
Implementation of
UnitsUserSettingManager
.altitudeUnits
distanceUnitsLarge
readonly
distanceUnitsLarge:Subscribable
<Unit
<Distance
>>
Defined in: workingtitle-instruments-epic2/shared/Settings/UnitsUserSettings.ts:139
The large distance units to use (nautical mile, kilometer, etc.) for the current distance units setting.
Implementation of
UnitsUserSettingManager
.distanceUnitsLarge
distanceUnitsSmall
readonly
distanceUnitsSmall:Subscribable
<Unit
<Distance
>>
Defined in: workingtitle-instruments-epic2/shared/Settings/UnitsUserSettings.ts:142
The small distance units to use (foot, meter, etc.) for the current distance units setting.
Implementation of
UnitsUserSettingManager
.distanceUnitsSmall
fuelFlowUnits
readonly
fuelFlowUnits:Subscribable
<Unit
<WeightFlux
>>
Defined in: workingtitle-instruments-epic2/shared/Settings/UnitsUserSettings.ts:166
The fuel flow units to use for the current fuel units setting.
Implementation of
UnitsUserSettingManager
.fuelFlowUnits
fuelUnits
readonly
fuelUnits:Subscribable
<Unit
<Weight
>>
Defined in: workingtitle-instruments-epic2/shared/Settings/UnitsUserSettings.ts:163
The fuel units to use for the current fuel units setting.
Implementation of
UnitsUserSettingManager
.fuelUnits
navAngleUnits
readonly
navAngleUnits:Subscribable
<NavAngleUnit
>
Defined in: workingtitle-instruments-epic2/shared/Settings/UnitsUserSettings.ts:136
The nav angle units to use for the current nav angle units setting.
Implementation of
UnitsUserSettingManager
.navAngleUnits
speedUnits
readonly
speedUnits:Subscribable
<Unit
<Speed
>>
Defined in: workingtitle-instruments-epic2/shared/Settings/UnitsUserSettings.ts:145
The speed units to use for the current distance units setting.
Implementation of
UnitsUserSettingManager
.speedUnits
temperatureDeltaUnits
readonly
temperatureDeltaUnits:Subscribable
<Unit
<TemperatureDelta
>>
Defined in: workingtitle-instruments-epic2/shared/Settings/UnitsUserSettings.ts:157
The temperature delta units to use for the current temperature units setting.
Implementation of
UnitsUserSettingManager
.temperatureDeltaUnits
temperatureUnits
readonly
temperatureUnits:Subscribable
<Unit
<Temperature
>>
Defined in: workingtitle-instruments-epic2/shared/Settings/UnitsUserSettings.ts:154
The temperature units to use for the current temperature units setting.
Implementation of
UnitsUserSettingManager
.temperatureUnits
verticalSpeedUnits
readonly
verticalSpeedUnits:Subscribable
<Unit
<Speed
>>
Defined in: workingtitle-instruments-epic2/shared/Settings/UnitsUserSettings.ts:151
The vertical speed units to use for the current altitude units setting.
Implementation of
UnitsUserSettingManager
.verticalSpeedUnits
weightUnits
readonly
weightUnits:Subscribable
<Unit
<Weight
>>
Defined in: workingtitle-instruments-epic2/shared/Settings/UnitsUserSettings.ts:160
The weight units to use for the current weight units setting.
Implementation of
UnitsUserSettingManager
.weightUnits
Methods
getAllSettings()
getAllSettings():
UserSetting
<UserSettingValue
>[]
Defined in: workingtitle-instruments-epic2/shared/Settings/UnitsUserSettings.ts:264
Gets an array of all settings of this manager.
Returns
UserSetting
<UserSettingValue
>[]
an array of all settings of this manager.
Implementation of
UnitsUserSettingManager
.getAllSettings
getSetting()
getSetting<
K
>(name
):UserSettingFromManager
<UnitsUserSettingTypes
,K
>
Defined in: workingtitle-instruments-epic2/shared/Settings/UnitsUserSettings.ts:254
Gets a setting from this manager.
Type Parameters
Type Parameter |
---|
K extends keyof UnitsUserSettingTypes |
Parameters
Parameter | Type | Description |
---|---|---|
name | K | The name of the setting to get. |
Returns
UserSettingFromManager
<UnitsUserSettingTypes
, K
>
The requested setting.
Throws
Error if no setting with the specified name exists.
Implementation of
UnitsUserSettingManager
.getSetting
mapTo()
mapTo<
M
>(map
):UserSettingManager
<M
&UnitsUserSettingTypes
>
Defined in: workingtitle-instruments-epic2/shared/Settings/UnitsUserSettings.ts:269
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 , UnitsUserSettingTypes > | 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
& UnitsUserSettingTypes
>
A new setting manager which supports accessing a subset of this manager's settings using aliased names.
Implementation of
tryGetSetting()
tryGetSetting<
K
>(name
):OptionalUserSettingFromManager
<UnitsUserSettingTypes
,K
>
Defined in: workingtitle-instruments-epic2/shared/Settings/UnitsUserSettings.ts:249
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
<UnitsUserSettingTypes
, K
>
The requested setting, or undefined
if no such setting exists.
Implementation of
UnitsUserSettingManager
.tryGetSetting
whenSettingChanged()
whenSettingChanged<
K
>(name
):UserSettingConsumerFromManager
<UnitsUserSettingTypes
,K
>
Defined in: workingtitle-instruments-epic2/shared/Settings/UnitsUserSettings.ts:259
Gets a consumer which notifies handlers when the value of a setting changes.
Type Parameters
Type Parameter |
---|
K extends keyof UnitsUserSettingTypes |
Parameters
Parameter | Type | Description |
---|---|---|
name | K | The name of a setting. |
Returns
UserSettingConsumerFromManager
<UnitsUserSettingTypes
, 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.