A function that returns a BooleanField when evaluated. More...
| Header | #include <Boolean |
| Since | Esri |
| Inherits | Esri |
Public Functions
| virtual | ~ |
| Esri | clip(const Esri |
| QFuture | evaluate |
| Esri | has |
| Esri | logical |
| Esri | logical |
| Esri | logical |
| Esri | logical |
| Esri | mask( |
| Esri | replace |
| Esri | replace |
| Esri | to |
Static Public Members
| Esri | create( |
Detailed Description
Use evaluateAsync 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).
Relevant samples:
- Apply map algebra: Apply map algebra to an elevation raster to floor, mask, and categorize the elevation values into discrete integer-based categories.
See also ContinuousFieldFunction, DiscreteFieldFunction, BooleanField, and evaluateAsync.
Member Function Documentation
[override virtual noexcept] BooleanFieldFunction::~BooleanFieldFunction ()
Destructor.
Esri::ArcGISRuntime::BooleanFieldFunction *BooleanFieldFunction::clip(const Esri::ArcGISRuntime::Envelope &extent) const
Returns composes a function that clips this function's field result such that it does not extend beyond the provided extent.
- extent - The extent to clip the field to.
[static] Esri::ArcGISRuntime::BooleanFieldFunction *BooleanFieldFunction::create(Esri::ArcGISRuntime::BooleanField *result, QObject *parent = nullptr)
Returns a BooleanFieldFunction with a predefined result.
- result - The predefined function result.
- parent - The optional parent QObject.
Enables a BooleanField to be used in contexts that expect a BooleanFieldFunction by setting the result of the function to be set explicitly.
evaluateAsync returns the given result.
QFuture<Esri::ArcGISRuntime::BooleanField *> BooleanFieldFunction::evaluateAsync (QObject *parent = nullptr)
Evaluate the result of the function with an optional parent for the returned future.
This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.
See Working with QFuture for further details.
Esri::ArcGISRuntime::BooleanFieldFunction *BooleanFieldFunction::hasData () const
Returns a function that identifies, point-wise, where this function's field result has data across its extent.
The result values are true where this function's field result has data and false where it has no data. All values in the result will have data.
The function result extent equals that of this function's field result.
Esri::ArcGISRuntime::BooleanFieldFunction *BooleanFieldFunction::logicalAnd (Esri::ArcGISRuntime::BooleanFieldFunction *otherField ) const
Returns a function that indicates if, point-wise, both this function's field result and another are true.
- otherField - Another boolean field function.
The function result has no data where both of the given fields have no data, or where one of the fields has no data and the other is true. The result is false where one of the given fields has no data and the other is false.
The function result extent is the union of the extents of the given fields.
The spatial reference of both fields must be equivalent.
Esri::ArcGISRuntime::BooleanFieldFunction *BooleanFieldFunction::logicalNot () const
Returns a function that indicates if, point-wise, this function's field result is false.
The function result has no data where this function's field result has no data.
The function result extent equals that of this function's field result.
Esri::ArcGISRuntime::BooleanFieldFunction *BooleanFieldFunction::logicalOr (Esri::ArcGISRuntime::BooleanFieldFunction *otherField ) const
Returns a function that indicates if, point-wise, either this function's field result or another are true.
- otherField - Another boolean field function.
The function result has no data where both of the given fields have no data or where one of the given fields has no data and the other is false.
The function result is true where one of the given fields has no data and the other is true.
The function result extent is the union of the extents of the given fields.
The spatial reference of both fields must be equivalent.
Esri::ArcGISRuntime::BooleanFieldFunction *BooleanFieldFunction::logicalXor (Esri::ArcGISRuntime::BooleanFieldFunction *otherField ) const
Returns a function that indicates if, point-wise, either this function's field result or another are true, but not both.
- otherField - Another boolean field function.
The function result has no data where either of the given fields has no data.
The function result extent is the intersection of the extents of the given fields.
The spatial reference of both fields must be equivalent.
Esri::ArcGISRuntime::BooleanFieldFunction *BooleanFieldFunction::mask(Esri::ArcGISRuntime::BooleanFieldFunction *selection) const
Returns a function that applies a mask to this function's field result.
- selection - A selection.
Where the selection is true, values from this function's field result are preserved. Where the selection is false, the field has no data.
The function result has no data where this function's field result or the selection has no data.
The function result extent is the intersection of this function's field result and the selection.
The spatial reference of this function's field result and the selection must be equivalent.
Esri::ArcGISRuntime::BooleanFieldFunction *BooleanFieldFunction::replaceIf (Esri::ArcGISRuntime::BooleanFieldFunction *selection, Esri::ArcGISRuntime::BooleanFieldFunction *otherField ) const
Returns a function that preserves values from this function's field result or replaces them with values from another.
- selection - A selection.
- otherField - The boolean field to draw values from when replacing.
Values are replaced, point-wise across the spatial intersection of the selection with the union of the two function's field results. The function result extent is the intersection of the selection with the union of this function's field result and the other. Where the selection is true, values from the other field are returned. Where false, values from this function's field result are returned.
The function result has no data where the selection or the selected field has no data.
The spatial reference of this function's field result, the other, and the selection must be equivalent.
Esri::ArcGISRuntime::BooleanFieldFunction *BooleanFieldFunction::replaceIf (Esri::ArcGISRuntime::BooleanFieldFunction *selection, bool value) const
Returns 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.
- selection - A selection.
- value - The boolean value to be used when replacing.
Where the selection is true, the specified constant value is returned. Where false, values from this function's field result are returned. The function result has no data where the selection or this function's field result has no data.
The function result extent is the intersection of the selection with this function's field result.
The spatial reference of this function's field result and the selection must be equivalent.
Esri::ArcGISRuntime::DiscreteFieldFunction *BooleanFieldFunction::toDiscreteFieldFunction () const
Returns a function that casts, point-wise, boolean values from this function's field result to integer values across its extent.
Boolean values of true and false become 1 and 0, respectively. The function result has no data where this function's field result has no data.
The function result extent equals that of this function's field result.