An operation that builds pyramids for a raster. More...
| Header | #include <Build |
| Since | Esri |
| Inherits | Esri |
Public Functions
| virtual | ~ |
| void | cancel() |
| double | progress() const |
| QFuture | result |
Signals
| void | progress |
Detailed Description
A BuildRasterPyramidsOperation is returned by RasterPyramids::buildPyramids(Esri::ArcGISRuntime::BuildRasterPyramidsParameters*). While the build is in progress, the same operation is also available from RasterPyramids::activeBuildOperation. Use this object to observe progress, request cancellation, and await the pyramid information produced by the build.
When the operation completes successfully, the future returned by resultAsync returns information about the pyramid set that was built and RasterPyramids::pyramidInfo is refreshed with that same information.
Member Function Documentation
[override virtual noexcept] BuildRasterPyramidsOperation::~BuildRasterPyramidsOperation ()
Destructor.
void BuildRasterPyramidsOperation::cancel()
Requests cancellation of the pyramid build operation.
Cancellation is cooperative. After cancellation is requested, the operation may continue until the executing code observes the request. If cancellation is observed, resultAsync reports cancellation.
double BuildRasterPyramidsOperation::progress() const
Returns the approximate fraction of pyramid build work completed.
Progress is reported as a value from 0.0 to 1.0 inclusive. A value of 0.0 indicates that no progress has been made, and a value of 1.0 indicates that the build completed successfully.
The value may be approximate and may not change for every unit of work completed. When this value changes, the progressChanged event is fired. If a build fails or is canceled, the value remains at the last reported progress value.
[signal] void BuildRasterPyramidsOperation::progressChanged (double progress)
Called when the value of progress changes.
- progress - The current value of progress.
QFuture<Esri::ArcGISRuntime::RasterPyramidInfo *> BuildRasterPyramidsOperation::resultAsync (QObject *parent = nullptr)
Asynchronously gets the result of the pyramid build operation.
This method does not start the operation. It returns a future that completes when the pyramid build operation completes. If the operation has already completed, the returned future completes with the operation's result or error. If the operation completes successfully, the future returns information about the pyramid set that was built. If the operation fails or is canceled, the future reports the corresponding error.
- parent - The optional parent QObject for the returned result object.
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.