qgsgeocoderresult.h

Go to the documentation of this file.

/***************************************************************************
  qgsgeocoderresult.h
  ---------------
  Date                 : August 2020
  Copyright            : (C) 2020 by Nyall Dawson
  Email                : nyall dot dawson at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSGEOCODERRESULT_H
#define QGSGEOCODERRESULT_H
 
#include "qgis_core.h"
#include "qgscoordinatereferencesystem.h"
#include "qgsgeometry.h"

class CORE_EXPORT QgsGeocoderResult
{
  public:
    static QgsGeocoderResult errorResult( const QString &errorMessage );

    QgsGeocoderResult( const QString &identifier, const QgsGeometry &geometry, const QgsCoordinateReferenceSystem &crs );

    bool isValid() const { return mIsValid; }

    QString error() const { return mErrorString; }

    QString identifier() const { return mIdentifier; }

    QgsGeometry geometry() const { return mGeometry; }

    void setGeometry( const QgsGeometry &geometry ) { mGeometry = geometry; }

    QgsCoordinateReferenceSystem crs() const { return mCrs; }

    void setCrs( const QgsCoordinateReferenceSystem &crs ) { mCrs = crs; }

    QgsRectangle viewport() const { return mViewport; }

    void setViewport( const QgsRectangle &viewport ) { mViewport = viewport; }

    QVariantMap additionalAttributes() const { return mAdditionalAttributes; }

    void setAdditionalAttributes( const QVariantMap &attributes ) { mAdditionalAttributes = attributes; }

    QString group() const;

    void setGroup( const QString &group );

    QString description() const;

    void setDescription( const QString &description );
 
  private:
    QgsGeocoderResult() = default;
 
    bool mIsValid = false;
    QString mErrorString;
 
    QString mIdentifier;
    QString mDescription;
    QString mGroup;
    QgsGeometry mGeometry;
    QgsCoordinateReferenceSystem mCrs;
    QgsRectangle mViewport;
    QVariantMap mAdditionalAttributes;
};
 
#endif // QGSGEOCODERRESULT_H