QGeoTiledMapReply Class
The QGeoTiledMapReply class manages a tile fetch operation started by an instance of QGeoTiledManagerEngine. More...
Header: | #include <QGeoTiledMapReply> |
Inherits: | QObject |
Public Types
enum | Error { NoError, CommunicationError, ParseError, UnknownError } |
Public Functions
QGeoTiledMapReply(const QGeoTileSpec &spec, QObject *parent = nullptr) | |
QGeoTiledMapReply(Error error, const QString &errorString, QObject *parent = nullptr) | |
virtual | ~QGeoTiledMapReply() |
virtual void | abort() |
Error | error() const |
QString | errorString() const |
bool | isCached() const |
bool | isFinished() const |
QByteArray | mapImageData() const |
QString | mapImageFormat() const |
QGeoTileSpec | tileSpec() const |
Protected Functions
void | setCached(bool cached) |
void | setError(Error error, const QString &errorString) |
void | setFinished(bool finished) |
void | setMapImageData(const QByteArray &data) |
void | setMapImageFormat(const QString &format) |
Detailed Description
\inmodule
QtLocation \ingroup
QtLocation-impl \since
5.6 \internal
Instances of QGeoTiledMapReply manage the state and results of these operations.
The isFinished(), error() and errorString() methods provide information on whether the operation has completed and if it completed successfully.
The finished() and errorOccurred(QGeoTiledMapReply::Error,QString) signals can be used to monitor the progress of the operation.
It is possible that a newly created QGeoTiledMapReply may be in a finished state, most commonly because an error has occurred. Since such an instance will never emit the finished() or errorOccurred(QGeoTiledMapReply::Error,QString) signals, it is important to check the result of isFinished() before making the connections to the signals.
If the operation completes successfully the results are accessed by mapImageData() and mapImageFormat().
Member Type Documentation
enum QGeoTiledMapReply::Error
Describes an error which prevented the completion of the operation.
Constant | Value | Description |
---|---|---|
QGeoTiledMapReply::NoError | 0 | No error has occurred. |
QGeoTiledMapReply::CommunicationError | 1 | An error occurred while communicating with the service provider. |
QGeoTiledMapReply::ParseError | 2 | The response from the service provider was in an unrecognizable format supported by the service provider. |
QGeoTiledMapReply::UnknownError | 3 | An error occurred which does not fit into any of the other categories. |
Member Function Documentation
QGeoTiledMapReply::QGeoTiledMapReply(const QGeoTileSpec &spec, QObject *parent = nullptr)
Constructs a tiled map reply object based on request, with parent parent.
QGeoTiledMapReply::QGeoTiledMapReply(Error error, const QString &errorString, QObject *parent = nullptr)
Constructs a tiled map reply object with a given error and errorString and the specified parent.
[virtual noexcept]
QGeoTiledMapReply::~QGeoTiledMapReply()
Destroys this tiled map reply object.
[virtual]
void QGeoTiledMapReply::abort()
Cancels the operation immediately.
This will do nothing if the reply is finished.
Error QGeoTiledMapReply::error() const
Returns the error state of this reply.
If the result is QGeoTiledMapReply::NoError then no error has occurred.
See also setError().
QString QGeoTiledMapReply::errorString() const
Returns the textual representation of the error state of this reply.
If no error has occurred this will return an empty string. It is possible that an error occurred which has no associated textual representation, in which case this will also return an empty string.
To determine whether an error has occurred, check to see if QGeoTiledMapReply::error() is equal to QGeoTiledMapReply::NoError.
bool QGeoTiledMapReply::isCached() const
Returns whether the reply is coming from a cache.
bool QGeoTiledMapReply::isFinished() const
Return true if the operation completed successfully or encountered an error which cause the operation to come to a halt.
QByteArray QGeoTiledMapReply::mapImageData() const
Returns the tile image data.
See also setMapImageData().
QString QGeoTiledMapReply::mapImageFormat() const
Returns the format of the tile image.
See also setMapImageFormat().
[protected]
void QGeoTiledMapReply::setCached(bool cached)
Sets whether the reply is coming from a cache to cached.
See also isCached().
[protected]
void QGeoTiledMapReply::setError(Error error, const QString &errorString)
Sets the error state of this reply to error and the textual representation of the error to errorString.
This will also cause errorOccurred() and finished() signals to be emitted, in that order.
See also error().
[protected]
void QGeoTiledMapReply::setFinished(bool finished)
Sets whether or not this reply has finished to finished.
If finished is true, this will cause the finished() signal to be emitted.
If the operation completed successfully, QGeoTiledMapReply::setMapImageData() should be called before this function. If an error occurred, QGeoTiledMapReply::setError() should be used instead.
[protected]
void QGeoTiledMapReply::setMapImageData(const QByteArray &data)
Sets the tile image data to data.
See also mapImageData().
[protected]
void QGeoTiledMapReply::setMapImageFormat(const QString &format)
Sets the format of the tile image to format.
See also mapImageFormat().
QGeoTileSpec QGeoTiledMapReply::tileSpec() const
Returns the request which corresponds to this reply.