PersistedNumSignal class

A PersistedSignal that stores a numeric value.

Inheritance
Available extensions

Constructors

PersistedNumSignal(num val, String key, {SignalsKeyValueStore? store})
Creates a new NumSignal.

Properties

autoDispose bool
Throws and error if read after dispose and can be disposed on last unsubscribe.
getter/setter pairinherited
bitLength int

Available on ReadonlySignal<int>, provided by the IntSignalExtension extension

Returns the minimum number of bits required to store this integer.
no setter
debugLabel String?
Debug label for Debug Mode
finalinherited
disposed bool
Check if the effect is disposed
getter/setter pairinherited
equalityCheck bool Function(num a, num b)
Optional method to check if to values are the same
getter/setter pairinherited
globalId int
finalinherited
hashCode int
The hash code for this object.
no setterinherited
internalValue num
no setterinherited
isEven bool

Available on ReadonlySignal<int>, provided by the IntSignalExtension extension

Returns true if and only if this integer is even.
no setter
isFinite bool

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

Whether this number is finite.
no setter
isInfinite bool

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

Whether this number is positive infinity or negative infinity.
no setter
isInitialized bool
Check if a signal value is set (does not subscribe)
no setterinherited
isNaN bool

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

Whether this number is a Not-a-Number value.
no setter
isNegative bool

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

Whether this number is negative.
no setter
isOdd bool

Available on ReadonlySignal<int>, provided by the IntSignalExtension extension

Returns true if and only if this integer is odd.
no setter
key String
The key to use for storing the value.
finalinherited
loaded bool
Whether the signal has been loaded from the store.
getter/setter pairinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
sign double

Available on ReadonlySignal<double>, provided by the DoubleSignalExtension extension

The sign of the double's numerical value.
no setter
sign int

Available on ReadonlySignal<int>, provided by the IntSignalExtension extension

Returns the sign of this integer.
no setter
sign num

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

Negative one, zero or positive one depending on the sign and numerical value of this number.
no setter
store SignalsKeyValueStore
The store to use for storing the value.
finalinherited
value num
Compute the current value
getter/setter pairinherited
version int
Version numbers should always be >= 0, because the special value -1 is used by Nodes to signify potentially unused but recyclable nodes.
getter/setter pairinherited

Methods

abs() num

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

The absolute value of this number.
abs() int

Available on ReadonlySignal<int>, provided by the IntSignalExtension extension

Returns the absolute value of this integer.
abs() double

Available on ReadonlySignal<double>, provided by the DoubleSignalExtension extension

afterCreate(num val) → void
Internal hook for after a signal is created
inherited
beforeUpdate(num val) → void
Internal hook for after a signal is updated
inherited
call() num
Return the value when invoked
inherited
ceil() int

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

The least integer no smaller than this.
ceil() int

Available on ReadonlySignal<int>, provided by the IntSignalExtension extension

Returns this.
ceil() int

Available on ReadonlySignal<double>, provided by the DoubleSignalExtension extension

Returns the least integer that is not smaller than this number.
ceilToDouble() double

Available on ReadonlySignal<double>, provided by the DoubleSignalExtension extension

Returns the least integer double value no smaller than this.
ceilToDouble() double

Available on ReadonlySignal<int>, provided by the IntSignalExtension extension

Returns this.toDouble().
ceilToDouble() double

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

Returns the least double integer value no smaller than this.
clamp(num lowerLimit, num upperLimit) num

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

Returns this num clamped to be in the range lowerLimit-upperLimit.
decode(String value) num
Decodes the value from a string.
override
dispose() → void
Dispose the signal
inherited
encode(num value) String
Encodes the value to a string.
override
floor() int

Available on ReadonlySignal<double>, provided by the DoubleSignalExtension extension

Returns the greatest integer no greater than this number.
floor() int

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

The greatest integer no greater than this number.
floor() int

Available on ReadonlySignal<int>, provided by the IntSignalExtension extension

Returns this.
floorToDouble() double

Available on ReadonlySignal<int>, provided by the IntSignalExtension extension

Returns this.toDouble().
floorToDouble() double

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

Returns the greatest double integer value no greater than this.
floorToDouble() double

Available on ReadonlySignal<double>, provided by the DoubleSignalExtension extension

Returns the greatest integer double value no greater than this.
gcd(int other) int

Available on ReadonlySignal<int>, provided by the IntSignalExtension extension

Returns the greatest common divisor of this integer and other.
get() num
Helper method to get the current value
inherited
init() Future<void>
Initializes the signal by loading the value from the store.
inherited
internalRefresh() bool
inherited
load() Future<num>
Loads the value from the store.
inherited
modInverse(int modulus) int

Available on ReadonlySignal<int>, provided by the IntSignalExtension extension

Returns the modular multiplicative inverse of this integer modulo modulus.
modPow(int exponent, int modulus) int

Available on ReadonlySignal<int>, provided by the IntSignalExtension extension

Returns this integer to the power of exponent modulo modulus.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onDispose(void cleanup()) → void Function()
Add a cleanup function to be called when the signal is disposed
inherited
overrideWith(num val) Signal<num>
Override the current signal with a new value as if it was created with it
inherited
peek() num
In the rare instance that you have an effect that should write to another signal based on the previous value, but you don't want the effect to be subscribed to that signal, you can read a signals's previous value via signal.peek().
inherited
readonly() ReadonlySignal<num>
Returns a readonly signal
inherited
remainder(num other) double

Available on ReadonlySignal<double>, provided by the DoubleSignalExtension extension

remainder(num other) num

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

The remainder of the truncating division of this by other.
round() int

Available on ReadonlySignal<double>, provided by the DoubleSignalExtension extension

Returns the integer closest to this number.
round() int

Available on ReadonlySignal<int>, provided by the IntSignalExtension extension

Returns this.
round() int

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

The integer closest to this number.
roundToDouble() double

Available on ReadonlySignal<int>, provided by the IntSignalExtension extension

Returns this.toDouble().
roundToDouble() double

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

The double integer value closest to this value.
roundToDouble() double

Available on ReadonlySignal<double>, provided by the DoubleSignalExtension extension

Returns the integer double value closest to this.
save(num value) Future<void>
Saves the value to the store.
inherited
set(num val, {bool force = false}) bool
Set the current value by a method
inherited
subscribe(void fn(num value)) → void Function()
Subscribe to value changes with a dispose function
inherited
subscribeToNode(Node node) → void
inherited
toDouble() double

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

This number as a double.
toInt() int

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

Truncates this num to an integer and returns the result as an int.
toJson() → dynamic
Convert value to JSON
inherited
toRadixString(int radix) String

Available on ReadonlySignal<int>, provided by the IntSignalExtension extension

Converts this int to a string representation in the given radix.
toSigned(int width) int

Available on ReadonlySignal<int>, provided by the IntSignalExtension extension

Returns the least significant width bits of this integer, extending the highest retained bit to the sign. This is the same as truncating the value to fit in width bits using an signed 2-s complement representation. The returned value has the same bit value in all positions higher than width.
toString() String
A string representation of this object.
inherited
toStringAsExponential([int? fractionDigits]) String

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

An exponential string-representation of this number.
toStringAsFixed(int fractionDigits) String

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

A decimal-point string-representation of this number.
toStringAsPrecision(int precision) String

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

A string representation with precision significant digits.
toUnsigned(int width) int

Available on ReadonlySignal<int>, provided by the IntSignalExtension extension

Returns the least significant width bits of this integer as a non-negative number (i.e. unsigned representation). The returned value has zeros in all bit positions higher than width.
truncate() int

Available on ReadonlySignal<int>, provided by the IntSignalExtension extension

Returns this.
truncate() int

Available on ReadonlySignal<double>, provided by the DoubleSignalExtension extension

Returns the integer obtained by discarding any fractional part of this number.
truncate() int

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

The integer obtained by discarding any fractional digits from this.
truncateToDouble() double

Available on ReadonlySignal<double>, provided by the DoubleSignalExtension extension

Returns the integer double value obtained by discarding any fractional digits from this.
truncateToDouble() double

Available on ReadonlySignal<int>, provided by the IntSignalExtension extension

Returns this.toDouble().
truncateToDouble() double

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

Returns the double integer value obtained by discarding any fractional digits from the double value of this.
unsubscribeFromNode(Node node) → void
inherited

Operators

operator %(num other) double

Available on ReadonlySignal<double>, provided by the DoubleSignalExtension extension

operator %(num other) num

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

Euclidean modulo of this number by other.
operator &(int other) int

Available on ReadonlySignal<int>, provided by the IntSignalExtension extension

Bit-wise and operator.
operator *(num other) double

Available on ReadonlySignal<double>, provided by the DoubleSignalExtension extension

operator *(num other) num

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

Multiplies this number by other.
operator +(num other) double

Available on ReadonlySignal<double>, provided by the DoubleSignalExtension extension

operator +(num other) num

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

Adds other to this number.
operator -(num other) double

Available on ReadonlySignal<double>, provided by the DoubleSignalExtension extension

operator -(num other) num

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

Subtracts other from this number.
operator /(num other) double

Available on ReadonlySignal<double>, provided by the DoubleSignalExtension extension

operator /(num other) double

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

Divides this number by other.
operator <(num other) bool

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

Whether this number is numerically smaller than other.
operator <<(int shiftAmount) int

Available on ReadonlySignal<int>, provided by the IntSignalExtension extension

Shift the bits of this integer to the left by shiftAmount.
operator <=(num other) bool

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

Whether this number is numerically smaller than or equal to other.
operator ==(Object other) bool
The equality operator.
inherited
operator >(num other) bool

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

Whether this number is numerically greater than other.
operator >=(num other) bool

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

Whether this number is numerically greater than or equal to other.
operator >>(int shiftAmount) int

Available on ReadonlySignal<int>, provided by the IntSignalExtension extension

Shift the bits of this integer to the right by shiftAmount.
operator >>>(int shiftAmount) int

Available on ReadonlySignal<int>, provided by the IntSignalExtension extension

Bitwise unsigned right shift by shiftAmount bits.
operator ^(int other) int

Available on ReadonlySignal<int>, provided by the IntSignalExtension extension

Bit-wise exclusive-or operator.
operator unary-() double

Available on ReadonlySignal<double>, provided by the DoubleSignalExtension extension

operator unary-() int

Available on ReadonlySignal<int>, provided by the IntSignalExtension extension

Return the negative value of this integer.
operator unary-() num

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

The negation of this value.
operator |(int other) int

Available on ReadonlySignal<int>, provided by the IntSignalExtension extension

Bit-wise or operator.
operator ~() int

Available on ReadonlySignal<int>, provided by the IntSignalExtension extension

The bit-wise negate operator.
operator ~/(num other) int

Available on ReadonlySignal<double>, provided by the DoubleSignalExtension extension

operator ~/(num other) int

Available on ReadonlySignal<num>, provided by the NumSignalExtension extension

Truncating division operator.