Class: ToldUserSettings
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/ToldUserSettings.ts:199
Utility class for retrieving and working with TOLD (takeoff/landing) performance calculation user settings managers.
Extends
DefaultUserSettingManager
<ToldUserSettingTypes
>
Constructors
Constructor
new ToldUserSettings(
bus
,settingDefs
,keepLocal
):ToldUserSettings
Defined in: src/sdk/settings/UserSetting.ts:191
Constructor.
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
bus | EventBus | undefined | The bus used by this manager to publish setting change events. |
settingDefs | readonly UserSettingDefinition <string | number | boolean >[] | undefined | The setting definitions used to initialize this manager's settings. |
keepLocal | boolean | false | If present and true, values will be kept local to the instrument on which they're set. |
Returns
ToldUserSettings
Inherited from
DefaultUserSettingManager<ToldUserSettingTypes>.constructor
Properties
bus
protected
readonly
bus:EventBus
Defined in: src/sdk/settings/UserSetting.ts:192
The bus used by this manager to publish setting change events.
Inherited from
DefaultUserSettingManager.bus
publisher
protected
readonly
publisher:Publisher
<ToldUserSettingTypes
>
Defined in: src/sdk/settings/UserSetting.ts:177
Inherited from
DefaultUserSettingManager.publisher
settings
protected
readonly
settings:Map
<string
,UserSettingManagerEntry
<string
|number
|boolean
>>
Defined in: src/sdk/settings/UserSetting.ts:175
Inherited from
DefaultUserSettingManager.settings
subscriber
protected
readonly
subscriber:EventSubscriber
<ToldUserSettingTypes
>
Defined in: src/sdk/settings/UserSetting.ts:178
Inherited from
DefaultUserSettingManager.subscriber
syncPublisher
protected
readonly
syncPublisher:Publisher
<UserSettingManagerSyncEvents
>
Defined in: src/sdk/settings/UserSetting.ts:180
Inherited from
DefaultUserSettingManager.syncPublisher
syncSubscriber
protected
readonly
syncSubscriber:EventSubscriber
<UserSettingManagerSyncEvents
>
Defined in: src/sdk/settings/UserSetting.ts:181
Inherited from
DefaultUserSettingManager.syncSubscriber
Methods
getAllSettings()
getAllSettings():
UserSetting
<UserSettingValue
>[]
Defined in: src/sdk/settings/UserSetting.ts:270
Returns
UserSetting
<UserSettingValue
>[]
Inherit Doc
Inherited from
DefaultUserSettingManager.getAllSettings
getSetting()
getSetting<
K
>(name
):UserSetting
<NonNullable
<ToldUserSettingTypes
[K
]>>
Defined in: src/sdk/settings/UserSetting.ts:260
Type Parameters
Type Parameter |
---|
K extends "toldDatabaseVersion" | "toldEnabled" | "toldOriginIcao" | "toldTakeoffDistanceRequired" | "toldTakeoffWeight" | "toldTakeoffRunwaySurface" | "toldTakeoffWindDirection" | "toldTakeoffWindSpeed" | "toldTakeoffTemperature" | "toldTakeoffCanUseRat" | "toldTakeoffUseRat" | "toldTakeoffPressure" | "toldTakeoffRunwayLength" | "toldTakeoffRunwayElevation" | "toldTakeoffRunwayHeading" | "toldTakeoffRunwayGradient" | "toldTakeoffPressureAltitude" | "toldTakeoffFlapsIndex" | "toldTakeoffFlapsIndexDefault" | "toldTakeoffAntiIceOn" | "toldTakeoffThrustReversers" | "toldTakeoffFactor" | "toldTakeoffRolling" | "toldTakeoffRollingDefault" | "toldTakeoffCalcResult" | "toldTakeoffVSpeedsAccepted" | "toldDestinationDefaultApplied" | "toldDestinationIcao" | "toldLandingDistanceRequired" | "toldLandingCanUsePredictedWeight" | "toldLandingUsePredictedWeight" | "toldLandingWeight" | "toldLandingRunwaySurface" | "toldLandingWindDirection" | "toldLandingWindSpeed" | "toldLandingTemperature" | "toldLandingPressure" | "toldLandingRunwayLength" | "toldLandingRunwayElevation" | "toldLandingRunwayHeading" | "toldLandingRunwayGradient" | "toldLandingPressureAltitude" | "toldLandingFlapsIndex" | "toldLandingFlapsIndexDefault" | "toldLandingAntiIceOn" | "toldLandingThrustReversers" | "toldLandingFactor" | "toldLandingFactorDefault" | "toldLandingAutothrottleOn" | "toldLandingCalcResult" | "toldLandingVSpeedsAccepted" |
Parameters
Parameter | Type |
---|---|
name | K |
Returns
UserSetting
<NonNullable
<ToldUserSettingTypes
[K
]>>
Inherit Doc
Inherited from
DefaultUserSettingManager.getSetting
mapTo()
mapTo<
M
>(map
):MappedUserSettingManager
<M
,ToldUserSettingTypes
>
Defined in: src/sdk/settings/UserSetting.ts:285
Type Parameters
Type Parameter |
---|
M extends UserSettingRecord |
Parameters
Parameter | Type |
---|---|
map | UserSettingMap <M , T > |
Returns
MappedUserSettingManager
<M
, ToldUserSettingTypes
>
Inherit Doc
Inherited from
DefaultUserSettingManager.mapTo
onSettingValueChanged()
protected
onSettingValueChanged<K
>(entry
,value
):void
Defined in: src/sdk/settings/UserSetting.ts:294
A callback which is called when one of this manager's settings has its value changed locally.
Type Parameters
Type Parameter |
---|
K extends keyof ToldUserSettingTypes |
Parameters
Parameter | Type | Description |
---|---|---|
entry | UserSettingManagerEntry <ToldUserSettingTypes [K ]> | The entry for the setting that was changed. |
value | ToldUserSettingTypes [K ] | The new value of the setting. |
Returns
void
Inherited from
DefaultUserSettingManager.onSettingValueChanged
onSettingValueSynced()
protected
onSettingValueSynced<K
>(entry
,data
):void
Defined in: src/sdk/settings/UserSetting.ts:304
A callback which is called when a setting changed event is received over the event bus.
Type Parameters
Type Parameter |
---|
K extends keyof ToldUserSettingTypes |
Parameters
Parameter | Type | Description |
---|---|---|
entry | UserSettingManagerEntry <ToldUserSettingTypes [K ]> | The entry for the setting that was changed. |
data | UserSettingManagerSyncData <ToldUserSettingTypes [K ]> | The sync data. |
Returns
void
Inherited from
DefaultUserSettingManager.onSettingValueSynced
syncSettingFromEvent()
protected
syncSettingFromEvent<K
>(entry
,data
):void
Defined in: src/sdk/settings/UserSetting.ts:323
Syncs a setting using data received from a sync event.
Type Parameters
Type Parameter |
---|
K extends keyof ToldUserSettingTypes |
Parameters
Parameter | Type | Description |
---|---|---|
entry | UserSettingManagerEntry <ToldUserSettingTypes [K ]> | The entry for the setting to sync. |
data | UserSettingManagerSyncData <ToldUserSettingTypes [K ]> | The sync event data. |
Returns
void
Inherited from
DefaultUserSettingManager.syncSettingFromEvent
tryGetSetting()
tryGetSetting<
K
>(name
):undefined
|UserSetting
<NonNullable
<ToldUserSettingTypes
[K
]>>
Defined in: src/sdk/settings/UserSetting.ts:255
Type Parameters
Type Parameter |
---|
K extends string |
Parameters
Parameter | Type |
---|---|
name | K |
Returns
undefined
| UserSetting
<NonNullable
<ToldUserSettingTypes
[K
]>>
Inherit Doc
Inherited from
DefaultUserSettingManager.tryGetSetting
whenSettingChanged()
whenSettingChanged<
K
>(name
):Consumer
<NonNullable
<ToldUserSettingTypes
[K
]>>
Defined in: src/sdk/settings/UserSetting.ts:275
Type Parameters
Type Parameter |
---|
K extends "toldDatabaseVersion" | "toldEnabled" | "toldOriginIcao" | "toldTakeoffDistanceRequired" | "toldTakeoffWeight" | "toldTakeoffRunwaySurface" | "toldTakeoffWindDirection" | "toldTakeoffWindSpeed" | "toldTakeoffTemperature" | "toldTakeoffCanUseRat" | "toldTakeoffUseRat" | "toldTakeoffPressure" | "toldTakeoffRunwayLength" | "toldTakeoffRunwayElevation" | "toldTakeoffRunwayHeading" | "toldTakeoffRunwayGradient" | "toldTakeoffPressureAltitude" | "toldTakeoffFlapsIndex" | "toldTakeoffFlapsIndexDefault" | "toldTakeoffAntiIceOn" | "toldTakeoffThrustReversers" | "toldTakeoffFactor" | "toldTakeoffRolling" | "toldTakeoffRollingDefault" | "toldTakeoffCalcResult" | "toldTakeoffVSpeedsAccepted" | "toldDestinationDefaultApplied" | "toldDestinationIcao" | "toldLandingDistanceRequired" | "toldLandingCanUsePredictedWeight" | "toldLandingUsePredictedWeight" | "toldLandingWeight" | "toldLandingRunwaySurface" | "toldLandingWindDirection" | "toldLandingWindSpeed" | "toldLandingTemperature" | "toldLandingPressure" | "toldLandingRunwayLength" | "toldLandingRunwayElevation" | "toldLandingRunwayHeading" | "toldLandingRunwayGradient" | "toldLandingPressureAltitude" | "toldLandingFlapsIndex" | "toldLandingFlapsIndexDefault" | "toldLandingAntiIceOn" | "toldLandingThrustReversers" | "toldLandingFactor" | "toldLandingFactorDefault" | "toldLandingAutothrottleOn" | "toldLandingCalcResult" | "toldLandingVSpeedsAccepted" |
Parameters
Parameter | Type |
---|---|
name | K |
Returns
Consumer
<NonNullable
<ToldUserSettingTypes
[K
]>>
Inherit Doc
Inherited from
DefaultUserSettingManager.whenSettingChanged
getManager()
static
getManager(bus
):DefaultUserSettingManager
<ToldUserSettingTypes
>
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/ToldUserSettings.ts:207
Gets an instance of the TOLD (takeoff/landing) performance calculation user settings manager.
Parameters
Parameter | Type | Description |
---|---|---|
bus | EventBus | The event bus. |
Returns
DefaultUserSettingManager
<ToldUserSettingTypes
>
An instance of the TOLD (takeoff/landing) performance calculation user settings manager.
parseLandingResultString()
static
parseLandingResultString(resultString
):undefined
|ToldLandingPerformanceResult
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/ToldUserSettings.ts:464
Parses a landing performance result object from a string.
Parameters
Parameter | Type | Description |
---|---|---|
resultString | string | The stringified result object. |
Returns
undefined
| ToldLandingPerformanceResult
The landing performance result object parsed from the specified string, or undefined
if the string
does not define such an object.
parseTakeoffResultString()
static
parseTakeoffResultString(resultString
):undefined
|ToldTakeoffPerformanceResult
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/ToldUserSettings.ts:428
Parses a takeoff performance result object from a string.
Parameters
Parameter | Type | Description |
---|---|---|
resultString | string | The stringified result object. |
Returns
undefined
| ToldTakeoffPerformanceResult
The takeoff performance result object parsed from the specified string, or undefined
if the string
does not define such an object.