Class: PerformanceVariable<T>
A performance variable, modifiable by the pilot
Type parameters
Name |
---|
T |
Hierarchy
ReadonlyPerformanceVariable
<T
>↳
PerformanceVariable
Properties
data
• data: DataInterface
<T
, T
>
Overrides
ReadonlyPerformanceVariable.data
Defined in
workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/PerformanceCalculators/PerformanceVariable.ts:108
input
• input: Subscribable
<T
>
a subject
Inherited from
ReadonlyPerformanceVariable.input
Defined in
workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/PerformanceCalculators/PerformanceVariable.ts:19
isSubscribable
• Readonly
isSubscribable: true
Inherited from
ReadonlyPerformanceVariable.isSubscribable
Defined in
workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/PerformanceCalculators/PerformanceVariable.ts:9
Methods
get
▸ get(): T
Returns
T
Inherit Doc
Inherited from
ReadonlyPerformanceVariable.get
Defined in
workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/PerformanceCalculators/PerformanceVariable.ts:25
map
▸ map<M
>(fn
, equalityFunc?
): MappedSubscribable
<M
>
Maps this subscribable to a new subscribable.
Type parameters
Name |
---|
M |
Parameters
Name | Type | Description |
---|---|---|
fn | (input : T , previousVal? : M ) => M | The function to use to map to the new subscribable. |
equalityFunc? | (a : M , b : M ) => boolean | The function to use to check for equality between mapped values. Defaults to the strict equality comparison (=== ). |
Returns
MappedSubscribable
<M
>
The mapped subscribable.
Inherited from
ReadonlyPerformanceVariable.map
Defined in
workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/PerformanceCalculators/PerformanceVariable.ts:46
▸ map<M
>(fn
, equalityFunc
, mutateFunc
, initialVal
): MappedSubscribable
<M
>
Maps this subscribable to a new subscribable with a persistent, cached value which is mutated when it changes.
Type parameters
Name |
---|
M |
Parameters
Name | Type | Description |
---|---|---|
fn | (input : T , previousVal? : M ) => M | The function to use to map to the new subscribable. |
equalityFunc | (a : M , b : M ) => boolean | The function to use to check for equality between mapped values. |
mutateFunc | (oldVal : M , newVal : M ) => void | The function to use to change the value of the mapped subscribable. |
initialVal | M | The initial value of the mapped subscribable. |
Returns
MappedSubscribable
<M
>
The mapped subscribable.
Inherited from
ReadonlyPerformanceVariable.map
Defined in
workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/PerformanceCalculators/PerformanceVariable.ts:55
pipe
▸ pipe(to
, paused?
): Subscription
Subscribes to and pipes this subscribable's state to a mutable subscribable. Whenever an update of this subscribable's state is received through the subscription, it will be used as an input to change the other subscribable's state.
Parameters
Name | Type | Description |
---|---|---|
to | MutableSubscribable <any , T > | The mutable subscribable to which to pipe this subscribable's state. |
paused? | boolean | Whether the new subscription should be initialized as paused. Defaults to false . |
Returns
Subscription
The new subscription.
Inherited from
ReadonlyPerformanceVariable.pipe
Defined in
workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/PerformanceCalculators/PerformanceVariable.ts:82
▸ pipe<M
>(to
, map
, paused?
): Subscription
Subscribes to and accepts mapped inputs from another subscribable. Whenever an update of the other subscribable's state is received through the subscription, it will be transformed by the specified mapping function, and the transformed state will be used as an input to change this subscribable's state.
Type parameters
Name |
---|
M |
Parameters
Name | Type | Description |
---|---|---|
to | MutableSubscribable <any , M > | The mutable subscribable to which to pipe this subscribable's mapped state. |
map | (fromVal : T , toVal : M ) => M | The function to use to transform inputs. |
paused? | boolean | Whether the new subscription should be initialized as paused. Defaults to false . |
Returns
Subscription
The new subscription.
Inherited from
ReadonlyPerformanceVariable.pipe
Defined in
workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/PerformanceCalculators/PerformanceVariable.ts:92
sub
▸ sub(fn
, initialNotify?
, paused?
): Subscription
Parameters
Name | Type | Default value |
---|---|---|
fn | (value : T ) => void | undefined |
initialNotify | boolean | false |
paused | boolean | false |
Returns
Subscription
Inherit Doc
Inherited from
ReadonlyPerformanceVariable.sub
Defined in
workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/PerformanceCalculators/PerformanceVariable.ts:30
unsub
▸ unsub(fn
): void
Parameters
Name | Type |
---|---|
fn | (value : T ) => void |
Returns
void
Inherit Doc
Inherited from
ReadonlyPerformanceVariable.unsub
Defined in
workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/PerformanceCalculators/PerformanceVariable.ts:35
computedFrom
▸ computedFrom<T
, I
>(mapFunc
, ...inputs
): ReadonlyPerformanceVariable
<T
>
Creates a new PerformanceVariable mapped from other variables
Type parameters
Name | Type |
---|---|
T | T |
I | extends any [] |
Parameters
Name | Type | Description |
---|---|---|
mapFunc | (inputs : I ) => T | function to map inputs to the output |
...inputs | MappedPerformanceVariableTypes <I > | input performance variables |
Returns
ReadonlyPerformanceVariable
<T
>
computed performance variable
Defined in
workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/PerformanceCalculators/PerformanceVariable.ts:161
fromSubject
▸ fromSubject<T
, R
>(subject
): R
extends true
? ReadonlyPerformanceVariable
<T
> : PerformanceVariable
<T
>
Creates a new PerformanceVariable from a Subject<T>
Type parameters
Name | Type |
---|---|
T | T |
R | extends boolean |
Parameters
Name | Type | Description |
---|---|---|
subject | Subject <T > | the subject to use |
Returns
R
extends true
? ReadonlyPerformanceVariable
<T
> : PerformanceVariable
<T
>
the performance variable
Defined in
workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/PerformanceCalculators/PerformanceVariable.ts:129
withDefaultNullValue
▸ withDefaultNullValue<T
>(): PerformanceVariable
<null
| T
>
Creates a new PerformanceVariable with a default value set to null
Type parameters
Name |
---|
T |
Returns
PerformanceVariable
<null
| T
>
the performance variable
Defined in
workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/PerformanceCalculators/PerformanceVariable.ts:138
withDefaultValue
▸ withDefaultValue<T
>(value
): PerformanceVariable
<T
>
Creates a new PerformanceVariable with a default value
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
value | T | the default value |
Returns
the performance variable
Defined in
workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/PerformanceCalculators/PerformanceVariable.ts:149