BooleanFieldFunction class final
A function that returns a BooleanField when evaluated.
Use BooleanFieldFunction.evaluate to compute the result of this function.
Results are updated when changes are made to parameters of this function (or to parameters of functions from which it is composed).
Operator overloads are available via BooleanFieldOperators to combine fields with &, ^, |, and ~.
- Implemented types
- Available extensions
Constructors
- BooleanFieldFunction.create(BooleanField result)
-
Creates a BooleanFieldFunction with a predefined result.
factory
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
clip(
Envelope extent) → BooleanFieldFunction - Composes a function that clips this function's field result such that it does not extend beyond the provided extent.
-
evaluate(
) → Future< BooleanField> - Evaluate the result of the function.
-
hasData(
) → BooleanFieldFunction - Composes a function that identifies, point-wise, where this function's field result has data across its extent.
-
logicalAnd(
BooleanFieldFunction otherField) → BooleanFieldFunction - Composes a function that indicates if, point-wise, both this function's field result and another are true.
-
logicalNot(
) → BooleanFieldFunction - Composes a function that indicates if, point-wise, this function's field result is false.
-
logicalOr(
BooleanFieldFunction otherField) → BooleanFieldFunction - Composes a function that indicates if, point-wise, either this function's field result or another are true.
-
logicalXor(
BooleanFieldFunction otherField) → BooleanFieldFunction - Composes a function that indicates if, point-wise, either this function's field result or another are true, but not both.
-
mask(
BooleanFieldFunction selection) → BooleanFieldFunction - Composes a function that applies a mask to this function's field result.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
replaceWithOtherFieldIf(
{required BooleanFieldFunction selection, required BooleanFieldFunction otherField}) → BooleanFieldFunction - Composes a function that preserves values from this function's field result or replaces them with values from another.
-
replaceWithValueIf(
{required BooleanFieldFunction selection, required bool value}) → BooleanFieldFunction - Composes a function that preserves values from this function's field result or replaces them with a constant value, point-wise across the extent of this function's field result based on a selection.
-
toDiscreteFieldFunction(
) → DiscreteFieldFunction - Composes a function that casts, point-wise, boolean values from this function's field result to integer values across its extent.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator &(
BooleanFieldFunction otherField) → BooleanFieldFunction -
Available on BooleanFieldFunction, provided by the BooleanFieldOperators extension
Composes a function that indicates if, point-wise, both this function's result andotherare true, using BooleanFieldFunction.logicalAnd. -
operator ==(
Object other) → bool -
The equality operator.
inherited
-
operator ^(
BooleanFieldFunction otherField) → BooleanFieldFunction -
Available on BooleanFieldFunction, provided by the BooleanFieldOperators extension
Composes a function that indicates if, point-wise, either this function's result orotherare true, but not both, using BooleanFieldFunction.logicalXor. -
operator |(
BooleanFieldFunction otherField) → BooleanFieldFunction -
Available on BooleanFieldFunction, provided by the BooleanFieldOperators extension
Composes a function that indicates if, point-wise, either this function's result orotheris true, using BooleanFieldFunction.logicalOr. -
operator ~(
) → BooleanFieldFunction -
Available on BooleanFieldFunction, provided by the BooleanFieldOperators extension
Composes a function that indicates if, point-wise, this function's result is false, using BooleanFieldFunction.logicalNot.