LuciadCPillar 2024.0.08
luciad::IMultilevelTiledRasterDataRetrieverCallback Class Referenceabstract

Interface with callback methods for the raster data retriever to call. More...

#include <luciad/models/rasters/IMultilevelTiledRasterDataRetriever.h>

Public Member Functions

virtual ~IMultilevelTiledRasterDataRetrieverCallback ()=default
 
virtual void onCanceled (MultilevelTileCoordinate tileCoordinate)=0
 Call this method when the request for the raster tile data was canceled. More...
 
virtual void onDataAvailable (MultilevelTileCoordinate tileCoordinate, const DataEntity &data)=0
 Call this method when you have retrieved the raster tile data in its raw form. More...
 
virtual void onDataNotAvailable (MultilevelTileCoordinate tileCoordinate)=0
 Call this method when there is no data available for the tile coordindate. More...
 
virtual void onError (MultilevelTileCoordinate tileCoordinate, const std::string &message)=0
 Call this method when there is an error to retrieve the raster tile data. More...
 
virtual void onImageAvailable (MultilevelTileCoordinate tileCoordinate, const std::shared_ptr< Image > &image)=0
 Call this method when you have retrieved the raster tile data and have decoded it as an image. More...
 

Detailed Description

Interface with callback methods for the raster data retriever to call.

There is usually no need to make a user implementation. An implementation to call the methods on is provided by the raster model implementation that has been created using either a MultilevelTiledRasterModelBuilder or a QuadTreeRasterModelBuilder.

Since
2022.1

Constructor & Destructor Documentation

◆ ~IMultilevelTiledRasterDataRetrieverCallback()

virtual luciad::IMultilevelTiledRasterDataRetrieverCallback::~IMultilevelTiledRasterDataRetrieverCallback ( )
virtualdefault

Member Function Documentation

◆ onCanceled()

virtual void luciad::IMultilevelTiledRasterDataRetrieverCallback::onCanceled ( MultilevelTileCoordinate  tileCoordinate)
pure virtual

Call this method when the request for the raster tile data was canceled.

Parameters
tileCoordinatethe tile coordinate for which the request was canceled.

◆ onDataAvailable()

virtual void luciad::IMultilevelTiledRasterDataRetrieverCallback::onDataAvailable ( MultilevelTileCoordinate  tileCoordinate,
const DataEntity data 
)
pure virtual

Call this method when you have retrieved the raster tile data in its raw form.

Supported mime types for the raster tile data:

Imagery:

  • image/png
  • image/jpeg
  • image/tiff (containing RGB(A))

Elevation:

  • image/tiff (containing a single channel with floating point data)
Parameters
tileCoordinatethe tile coordinate for which the raster tile data was retrieved.
datathe raster tile data.

◆ onDataNotAvailable()

virtual void luciad::IMultilevelTiledRasterDataRetrieverCallback::onDataNotAvailable ( MultilevelTileCoordinate  tileCoordinate)
pure virtual

Call this method when there is no data available for the tile coordindate.

Parameters
tileCoordinatethe tile coordinate for which there is no raster tile data.

◆ onError()

virtual void luciad::IMultilevelTiledRasterDataRetrieverCallback::onError ( MultilevelTileCoordinate  tileCoordinate,
const std::string &  message 
)
pure virtual

Call this method when there is an error to retrieve the raster tile data.

Parameters
tileCoordinatethe tile coordinate for which there is no raster tile data.
messagea message to detail what went wrong.

◆ onImageAvailable()

virtual void luciad::IMultilevelTiledRasterDataRetrieverCallback::onImageAvailable ( MultilevelTileCoordinate  tileCoordinate,
const std::shared_ptr< Image > &  image 
)
pure virtual

Call this method when you have retrieved the raster tile data and have decoded it as an image.

Supported image types:

Imagery:

Elevation:

Parameters
tileCoordinatethe tile coordinate for which the raster tile data was retrieved.
imagethe raster tile data decoded into an image.