qgsarcgisrestutils.h

Go to the documentation of this file.

/***************************************************************************
    qgsarcgisrestutils.h
    --------------------
    begin                : Nov 25, 2015
    copyright            : (C) 2015 by Sandro Mani
    email                : [email protected]
 ***************************************************************************
 *                                                                         *
 *   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 QGSARCGISRESTUTILS_H
#define QGSARCGISRESTUTILS_H
 
#include <functional>
#include <memory>
 
#include "qgis_sip.h"
#include "qgscoordinatereferencesystem.h"
#include "qgswkbtypes.h"
 
#include <QStringList>
#include <QTimeZone>
#include <QVariant>
 
class QNetworkReply;
class QgsNetworkAccessManager;
class QgsField;
class QgsGeometry;
class QgsAbstractGeometry;
class QgsAbstractVectorLayerLabeling;
class QgsCoordinateReferenceSystem;
class QgsFeedback;
class QgsSymbol;
class QgsLineSymbol;
class QgsFillSymbol;
class QgsMarkerSymbol;
class QgsFeatureRenderer;
class QgsPoint;
class QgsAbstractGeometry;
class QgsCircularString;
class QgsCompoundCurve;
class QgsMultiPoint;
class QgsMultiSurface;
class QgsMultiLineString;
class QgsPolygon;
class QgsMultiCurve;
class QgsMultiPolygon;
class QgsCurvePolygon;
class QgsFeature;
class QgsLineString;
class QgsCurve;
class QgsSymbolConverterContext;

class CORE_EXPORT QgsArcGisRestContext
{
  public:
    void setTimeZone( const QTimeZone &zone ) { mTimeZone = zone; }

    QTimeZone timeZone() const { return mTimeZone; }

    void setObjectIdFieldName( const QString &name ) { mObjectIdFieldName = name; }

    QString objectIdFieldName() const { return mObjectIdFieldName; }
 
  private:
    QTimeZone mTimeZone;
 
    QString mObjectIdFieldName;
};

class CORE_EXPORT QgsArcGisRestUtils
{
    Q_GADGET
 
  public:
    static QMetaType::Type convertFieldType( const QString &type );

    static Qgis::WkbType convertGeometryType( const QString &type );

    static std::unique_ptr< QgsAbstractGeometry > convertGeometry(
      const QVariantMap &geometry, const QString &esriGeometryType, bool hasM, bool hasZ, bool allowCurves = true, QgsCoordinateReferenceSystem *crs SIP_OUT = nullptr
    );

    static QgsCoordinateReferenceSystem convertSpatialReference( const QVariantMap &spatialReferenceMap );

    static std::unique_ptr< QgsSymbol > convertSymbol( const QVariantMap &definition, QgsSymbolConverterContext &context );

    Q_DECL_DEPRECATED static std::unique_ptr< QgsSymbol > convertSymbol( const QVariantMap &definition ) SIP_DEPRECATED;

    static std::unique_ptr< QgsFeatureRenderer > convertRenderer( const QVariantMap &rendererData, QgsSymbolConverterContext &context );

    Q_DECL_DEPRECATED static std::unique_ptr< QgsFeatureRenderer > convertRenderer( const QVariantMap &rendererData ) SIP_DEPRECATED;

    static std::unique_ptr< QgsAbstractVectorLayerLabeling > convertLabeling( const QVariantList &data );

    static QString convertLabelingExpression( const QString &string );

    static QColor convertColor( const QVariant &data );

    static Qt::PenStyle convertLineStyle( const QString &style );

    static Qt::BrushStyle convertFillStyle( const QString &style );

    static QDateTime convertDateTime( const QVariant &value );

    static QVariantMap geometryToJson( const QgsGeometry &geometry, const QgsArcGisRestContext &context, const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem() );

    static QVariantMap crsToJson( const QgsCoordinateReferenceSystem &crs );

    static QgsRectangle convertRectangle( const QVariant &value );

    enum class FeatureToJsonFlag : int SIP_ENUM_BASETYPE( IntFlag )
    {
      IncludeGeometry = 1 << 0,              
      IncludeNonObjectIdAttributes = 1 << 1, 
      SkipUnsetAttributes = 1 << 2,          
    };
    Q_ENUM( FeatureToJsonFlag );

    Q_DECLARE_FLAGS( FeatureToJsonFlags, FeatureToJsonFlag )
    Q_FLAG( FeatureToJsonFlags )
 
    
    static QVariantMap featureToJson(
      const QgsFeature &feature,
      const QgsArcGisRestContext &context,
      const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem(),
      QgsArcGisRestUtils::FeatureToJsonFlags flags = QgsArcGisRestUtils::FeatureToJsonFlags(
        static_cast< int >( QgsArcGisRestUtils::FeatureToJsonFlag::IncludeGeometry ) | static_cast< int >( QgsArcGisRestUtils::FeatureToJsonFlag::IncludeNonObjectIdAttributes )
      )
    );

    static QVariant variantToAttributeValue( const QVariant &variant, QMetaType::Type expectedType, const QgsArcGisRestContext &context );

    static QVariantMap fieldDefinitionToJson( const QgsField &field );

    static Qgis::ArcGisRestServiceType serviceTypeFromString( const QString &type );

    static Qgis::ArcGisRestServiceCapabilities serviceCapabilitiesFromString( const QString &capabilities );

    static Qgis::DataType dataTypeFromString( const QString &pixelType );
 
#ifndef SIP_RUN
    struct PixelTypeLimitUsefulness
    {
        bool minIsUseful = false;
        bool maxIsUseful = false;
    };
#endif

    SIP_SKIP static PixelTypeLimitUsefulness pixelTypeLimitUsefulness( const QString &pixelType );

    SIP_SKIP static std::optional< std::pair< double, double > > rangeForPixelType( const QString &pixelType );

    static Qgis::RasterColorInterpretation colorInterpretationFromBandName( const QString &bandName );

    static double defaultNoDataForDataType( Qgis::DataType type, bool &ok SIP_OUT );
 
  private:
    static void applyVisualVariables( const QVariantMap &rendererData, QgsSymbol *symbol, QgsSymbolConverterContext &context );

    static std::unique_ptr< QgsPoint > convertPoint( const QVariantList &list, Qgis::WkbType type );

    static std::unique_ptr< QgsCircularString > convertCircularString( const QVariantMap &data, Qgis::WkbType type, const QgsPoint &startPoint );

    static std::unique_ptr< QgsCurve > convertCompoundCurve( const QVariantList &list, Qgis::WkbType type );

    static std::unique_ptr< QgsLineString > convertLineString( const QVariantList &list, Qgis::WkbType type );

    static std::unique_ptr< QgsPoint > convertGeometryPoint( const QVariantMap &data, Qgis::WkbType pointType );

    static std::unique_ptr< QgsMultiPoint > convertMultiPoint( const QVariantMap &geometryData, Qgis::WkbType pointType );

    static std::unique_ptr< QgsMultiCurve > convertGeometryPolyline( const QVariantMap &data, Qgis::WkbType pointType, bool allowCurves );

    static std::unique_ptr< QgsMultiSurface > convertGeometryPolygon( const QVariantMap &data, Qgis::WkbType pointType, bool allowCurves );

    static std::unique_ptr< QgsPolygon > convertEnvelope( const QVariantMap &data );
 
    static QVariantMap pointToJson( const QgsPoint *point );
    static QVariantMap multiPointToJson( const QgsMultiPoint *multiPoint );
    static QVariantList lineStringToJsonPath( const QgsLineString *line );
    static QVariantList curveToJsonCurve( const QgsCurve *curve, bool includeStart );
    static QVariantMap lineStringToJson( const QgsLineString *line );
    static QVariantMap curveToJson( const QgsCurve *curve );
    static QVariantMap multiLineStringToJson( const QgsMultiLineString *multiLine );
    static QVariantMap multiCurveToJson( const QgsMultiCurve *multiCurve );
    static QVariantList polygonToJsonRings( const QgsPolygon *polygon );
    static QVariantList curvePolygonToJsonRings( const QgsCurvePolygon *polygon );
    static QVariantMap polygonToJson( const QgsPolygon *polygon );
    static QVariantMap curvePolygonToJson( const QgsCurvePolygon *polygon );
    static QVariantMap multiPolygonToJson( const QgsMultiPolygon *polygon );
    static QVariantMap multiSurfaceToJson( const QgsMultiSurface *multiSurface );
 
    friend class TestQgsArcGisRestUtils;
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsArcGisRestUtils::FeatureToJsonFlags )
 
#endif // QGSARCGISRESTUTILS_H