Class: PerformanceVariable<T>
Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/PerformanceCalculators/PerformanceVariable.ts:106
A performance variable, modifiable by the pilot
Extends
Type Parameters
Type Parameter |
---|
T |
Properties
data
data:
DataInterface
<T
>
Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/PerformanceCalculators/PerformanceVariable.ts:108
Overrides
ReadonlyPerformanceVariable
.data
input
input:
Subscribable
<T
>
Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/PerformanceCalculators/PerformanceVariable.ts:19
a subject
Inherited from
ReadonlyPerformanceVariable
.input
isSubscribable
readonly
isSubscribable:true
=true
Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/PerformanceCalculators/PerformanceVariable.ts:9
Flags this object as a Subscribable.
Inherited from
ReadonlyPerformanceVariable
.isSubscribable
Methods
get()
get():
T
Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/PerformanceCalculators/PerformanceVariable.ts:25
Returns
T
Inherit Doc
Inherited from
ReadonlyPerformanceVariable
.get
map()
Call Signature
map<
M
>(fn
,equalityFunc?
):MappedSubscribable
<M
>
Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/PerformanceCalculators/PerformanceVariable.ts:46
Maps this subscribable to a new subscribable.
Type Parameters
Type Parameter |
---|
M |
Parameters
Parameter | Type | Description |
---|---|---|
fn | (input , previousVal? ) => M | The function to use to map to the new subscribable. |
equalityFunc? | (a , b ) => 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
Call Signature
map<
M
>(fn
,equalityFunc
,mutateFunc
,initialVal
):MappedSubscribable
<M
>
Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/PerformanceCalculators/PerformanceVariable.ts:55
Maps this subscribable to a new subscribable with a persistent, cached value which is mutated when it changes.
Type Parameters
Type Parameter |
---|
M |
Parameters
Parameter | Type | Description |
---|---|---|
fn | (input , previousVal? ) => M | The function to use to map to the new subscribable. |
equalityFunc | (a , b ) => boolean | The function to use to check for equality between mapped values. |
mutateFunc | (oldVal , newVal ) => 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
pipe()
Call Signature
pipe(
to
,paused?
):Subscription
Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/PerformanceCalculators/PerformanceVariable.ts:82
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
Parameter | 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
Call Signature
pipe<
M
>(to
,map
,paused?
):Subscription
Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/PerformanceCalculators/PerformanceVariable.ts:92
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
Type Parameter |
---|
M |
Parameters
Parameter | Type | Description |
---|---|---|
to | MutableSubscribable <any , M > | The mutable subscribable to which to pipe this subscribable's mapped state. |
map | (fromVal , toVal ) => 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
sub()
sub(
fn
,initialNotify
,paused
):Subscription
Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/PerformanceCalculators/PerformanceVariable.ts:30
Parameters
Parameter | Type | Default value |
---|---|---|
fn | (value ) => void | undefined |
initialNotify | boolean | false |
paused | boolean | false |
Returns
Subscription
Inherit Doc
Inherited from
ReadonlyPerformanceVariable
.sub
unsub()
unsub(
fn
):void
Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/PerformanceCalculators/PerformanceVariable.ts:35
Parameters
Parameter | Type |
---|---|
fn | (value ) => void |
Returns
void
Inherit Doc
Inherited from
ReadonlyPerformanceVariable
.unsub
computedFrom()
static
computedFrom<T
,I
>(mapFunc
, ...inputs
):ReadonlyPerformanceVariable
<T
>
Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/PerformanceCalculators/PerformanceVariable.ts:161
Creates a new PerformanceVariable mapped from other variables
Type Parameters
Type Parameter |
---|
T |
I extends any [] |
Parameters
Parameter | Type | Description |
---|---|---|
mapFunc | (inputs ) => T | function to map inputs to the output |
...inputs | MappedPerformanceVariableTypes <I > | input performance variables |
Returns
ReadonlyPerformanceVariable
<T
>
computed performance variable
fromSubject()
static
fromSubject<T
,R
>(subject
):R
extendstrue
?ReadonlyPerformanceVariable
<T
> :PerformanceVariable
<T
>
Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/PerformanceCalculators/PerformanceVariable.ts:129
Creates a new PerformanceVariable from a Subject<T>
Type Parameters
Type Parameter |
---|
T |
R extends boolean |
Parameters
Parameter | Type | Description |
---|---|---|
subject | Subject <T > | the subject to use |
Returns
R
extends true
? ReadonlyPerformanceVariable
<T
> : PerformanceVariable
<T
>
the performance variable
withDefaultNullValue()
static
withDefaultNullValue<T
>():PerformanceVariable
<null
|T
>
Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/PerformanceCalculators/PerformanceVariable.ts:138
Creates a new PerformanceVariable with a default value set to null
Type Parameters
Type Parameter |
---|
T |
Returns
PerformanceVariable
<null
| T
>
the performance variable
withDefaultValue()
static
withDefaultValue<T
>(value
):PerformanceVariable
<T
>
Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/FMC/PerformanceCalculators/PerformanceVariable.ts:149
Creates a new PerformanceVariable with a default value
Type Parameters
Type Parameter |
---|
T |
Parameters
Parameter | Type | Description |
---|---|---|
value | T | the default value |
Returns
PerformanceVariable
<T
>
the performance variable