QGIS API Documentation 3.99.0-Master (c22de0620c0)
Loading...
Searching...
No Matches
qgsarcgisrestutils.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsarcgisrestutils.h
3 --------------------
4 begin : Nov 25, 2015
5 copyright : (C) 2015 by Sandro Mani
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15#ifndef QGSARCGISRESTUTILS_H
16#define QGSARCGISRESTUTILS_H
17
18#include <functional>
19#include <memory>
20
21#include "qgis_sip.h"
23#include "qgswkbtypes.h"
24
25#include <QStringList>
26#include <QTimeZone>
27#include <QVariant>
28
29class QNetworkReply;
31class QgsField;
32class QgsGeometry;
36class QgsFeedback;
37class QgsSymbol;
38class QgsLineSymbol;
39class QgsFillSymbol;
40class QgsMarkerSymbol;
42class QgsPoint;
46class QgsMultiPoint;
47class QgsMultiSurface;
49class QgsPolygon;
50class QgsMultiCurve;
51class QgsMultiPolygon;
52class QgsCurvePolygon;
53class QgsFeature;
54class QgsLineString;
55class QgsCurve;
56
65class CORE_EXPORT QgsArcGisRestContext
66{
67 public:
68
74 void setTimeZone( const QTimeZone &zone ) { mTimeZone = zone; }
75
81 QTimeZone timeZone() const { return mTimeZone; }
82
88 void setObjectIdFieldName( const QString &name ) { mObjectIdFieldName = name; }
89
95 QString objectIdFieldName() const { return mObjectIdFieldName; }
96
97 private:
98
99 QTimeZone mTimeZone;
100
101 QString mObjectIdFieldName;
102
103};
104
113class CORE_EXPORT QgsArcGisRestUtils
114{
115 Q_GADGET
116
117 public:
118
122 static QMetaType::Type convertFieldType( const QString &type );
123
127 static Qgis::WkbType convertGeometryType( const QString &type );
128
143 static std::unique_ptr< QgsAbstractGeometry > convertGeometry( const QVariantMap &geometry, const QString &esriGeometryType, bool hasM, bool hasZ, bool allowCurves = true, QgsCoordinateReferenceSystem *crs SIP_OUT = nullptr );
144
148 static QgsCoordinateReferenceSystem convertSpatialReference( const QVariantMap &spatialReferenceMap );
149
155 static std::unique_ptr< QgsSymbol > convertSymbol( const QVariantMap &definition );
156
162 static std::unique_ptr< QgsFeatureRenderer > convertRenderer( const QVariantMap &rendererData );
163
169 static std::unique_ptr< QgsAbstractVectorLayerLabeling > convertLabeling( const QVariantList &data );
170
174 static QString convertLabelingExpression( const QString &string );
175
179 static QColor convertColor( const QVariant &data );
180
184 static Qt::PenStyle convertLineStyle( const QString &style );
185
189 static Qt::BrushStyle convertFillStyle( const QString &style );
190
194 static QDateTime convertDateTime( const QVariant &value );
195
203 static QVariantMap geometryToJson( const QgsGeometry &geometry, const QgsArcGisRestContext &context, const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem() );
204
212 static QVariantMap crsToJson( const QgsCoordinateReferenceSystem &crs );
213
221 static QgsRectangle convertRectangle( const QVariant &value );
222
228 enum class FeatureToJsonFlag : int SIP_ENUM_BASETYPE( IntFlag )
229 {
230 IncludeGeometry = 1 << 0,
231 IncludeNonObjectIdAttributes = 1 << 1,
232 SkipUnsetAttributes = 1 << 2,
233 };
235
242 Q_FLAG( FeatureToJsonFlags )
243
244
249 static QVariantMap featureToJson( const QgsFeature &feature,
250 const QgsArcGisRestContext &context,
253
259 static QVariant variantToAttributeValue( const QVariant &variant, QMetaType::Type expectedType, const QgsArcGisRestContext &context );
260
266 static QVariantMap fieldDefinitionToJson( const QgsField &field );
267
273 static Qgis::ArcGisRestServiceType serviceTypeFromString( const QString &type );
274
275 private:
276
280 static std::unique_ptr< QgsPoint > convertPoint( const QVariantList &list, Qgis::WkbType type );
281
287 static std::unique_ptr< QgsCircularString > convertCircularString( const QVariantMap &data, Qgis::WkbType type, const QgsPoint &startPoint );
288
292 static std::unique_ptr< QgsCurve > convertCompoundCurve( const QVariantList &list, Qgis::WkbType type );
293
297 static std::unique_ptr< QgsLineString > convertLineString( const QVariantList &list, Qgis::WkbType type );
298
302 static std::unique_ptr< QgsPoint > convertGeometryPoint( const QVariantMap &data, Qgis::WkbType pointType );
303
307 static std::unique_ptr< QgsMultiPoint > convertMultiPoint( const QVariantMap &geometryData, Qgis::WkbType pointType );
308
314 static std::unique_ptr< QgsMultiCurve > convertGeometryPolyline( const QVariantMap &data, Qgis::WkbType pointType, bool allowCurves );
315
321 static std::unique_ptr< QgsMultiSurface > convertGeometryPolygon( const QVariantMap &data, Qgis::WkbType pointType, bool allowCurves );
322
326 static std::unique_ptr< QgsPolygon > convertEnvelope( const QVariantMap &data );
327
328 static std::unique_ptr< QgsLineSymbol > parseEsriLineSymbolJson( const QVariantMap &symbolData );
329 static std::unique_ptr< QgsFillSymbol > parseEsriFillSymbolJson( const QVariantMap &symbolData );
330 static std::unique_ptr< QgsFillSymbol > parseEsriPictureFillSymbolJson( const QVariantMap &symbolData );
331 static std::unique_ptr< QgsMarkerSymbol > parseEsriMarkerSymbolJson( const QVariantMap &symbolData );
332 static std::unique_ptr< QgsMarkerSymbol > parseEsriPictureMarkerSymbolJson( const QVariantMap &symbolData );
333 static std::unique_ptr< QgsMarkerSymbol > parseEsriTextMarkerSymbolJson( const QVariantMap &symbolData );
334
335 static Qgis::MarkerShape parseEsriMarkerShape( const QString &style );
336
337 static QVariantMap pointToJson( const QgsPoint *point );
338 static QVariantMap multiPointToJson( const QgsMultiPoint *multiPoint );
339 static QVariantList lineStringToJsonPath( const QgsLineString *line );
340 static QVariantList curveToJsonCurve( const QgsCurve *curve, bool includeStart );
341 static QVariantMap lineStringToJson( const QgsLineString *line );
342 static QVariantMap curveToJson( const QgsCurve *curve );
343 static QVariantMap multiLineStringToJson( const QgsMultiLineString *multiLine );
344 static QVariantMap multiCurveToJson( const QgsMultiCurve *multiCurve );
345 static QVariantList polygonToJsonRings( const QgsPolygon *polygon );
346 static QVariantList curvePolygonToJsonRings( const QgsCurvePolygon *polygon );
347 static QVariantMap polygonToJson( const QgsPolygon *polygon );
348 static QVariantMap curvePolygonToJson( const QgsCurvePolygon *polygon );
349 static QVariantMap multiPolygonToJson( const QgsMultiPolygon *polygon );
350 static QVariantMap multiSurfaceToJson( const QgsMultiSurface *multiSurface );
351
353};
354
356
357#endif // QGSARCGISRESTUTILS_H
ArcGisRestServiceType
Available ArcGIS REST service types.
Definition qgis.h:4480
MarkerShape
Marker shapes.
Definition qgis.h:3166
WkbType
The WKB type describes the number of dimensions a geometry has.
Definition qgis.h:291
Abstract base class for all geometries.
Abstract base class - its implementations define different approaches to the labeling of a vector lay...
Contains the context of a ArcGIS REST service operation.
void setTimeZone(const QTimeZone &zone)
Sets the time zone for datetime values.
QTimeZone timeZone() const
Returns the time zone for datetime values.
QString objectIdFieldName() const
Returns the name of the objectId field.
void setObjectIdFieldName(const QString &name)
Sets the name of the objectId field.
Utility functions for working with ArcGIS REST services.
static std::unique_ptr< QgsAbstractGeometry > convertGeometry(const QVariantMap &geometry, const QString &esriGeometryType, bool hasM, bool hasZ, bool allowCurves=true, QgsCoordinateReferenceSystem *crs=nullptr)
Converts an ESRI REST geometry JSON definition to a QgsAbstractGeometry.
static QVariantMap fieldDefinitionToJson(const QgsField &field)
Converts a field's definition to an ArcGIS REST JSON representation.
static QgsCoordinateReferenceSystem convertSpatialReference(const QVariantMap &spatialReferenceMap)
Converts a spatial reference JSON definition to a QgsCoordinateReferenceSystem value.
static QDateTime convertDateTime(const QVariant &value)
Converts a date time value to a QDateTime.
static Qgis::WkbType convertGeometryType(const QString &type)
Converts an ESRI REST geometry type to a WKB type.
static QString convertLabelingExpression(const QString &string)
Converts an ESRI labeling expression to a QGIS expression string.
static QVariantMap geometryToJson(const QgsGeometry &geometry, const QgsArcGisRestContext &context, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem())
Converts a geometry to an ArcGIS REST JSON representation.
friend class TestQgsArcGisRestUtils
static Qgis::ArcGisRestServiceType serviceTypeFromString(const QString &type)
Converts a string value to a REST service type.
static QVariant variantToAttributeValue(const QVariant &variant, QMetaType::Type expectedType, const QgsArcGisRestContext &context)
Converts a variant to a REST attribute value.
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)))
Converts a feature to an ArcGIS REST JSON representation.
static Qt::PenStyle convertLineStyle(const QString &style)
Converts an ESRI line style to a Qt pen style.
Q_ENUM(FeatureToJsonFlag)
FeatureToJsonFlag
Flags which control the behavior of converting features to JSON.
@ IncludeGeometry
Whether to include the geometry definition.
@ IncludeNonObjectIdAttributes
Whether to include any non-objectId attributes.
static std::unique_ptr< QgsSymbol > convertSymbol(const QVariantMap &definition)
Converts a symbol JSON definition to a QgsSymbol.
static std::unique_ptr< QgsFeatureRenderer > convertRenderer(const QVariantMap &rendererData)
Converts renderer JSON data to an equivalent QgsFeatureRenderer.
static QMetaType::Type convertFieldType(const QString &type)
Converts an ESRI REST field type to a QVariant type.
static Qt::BrushStyle convertFillStyle(const QString &style)
Converts an ESRI fill style to a Qt brush style.
static QVariantMap crsToJson(const QgsCoordinateReferenceSystem &crs)
Converts a crs to an ArcGIS REST JSON representation.
static std::unique_ptr< QgsAbstractVectorLayerLabeling > convertLabeling(const QVariantList &data)
Converts labeling JSON data to an equivalent QGIS vector labeling.
QFlags< FeatureToJsonFlag > FeatureToJsonFlags
Flags which control the behavior of converting features to JSON.
static QColor convertColor(const QVariant &data)
Converts ESRI JSON color data to a QColor object.
static QgsRectangle convertRectangle(const QVariant &value)
Converts a rectangle value to a QgsRectangle.
Circular string geometry type.
Compound curve geometry type.
Represents a coordinate reference system (CRS).
Curve polygon geometry type.
Abstract base class for curved geometry type.
Definition qgscurve.h:36
Abstract base class for all 2D vector feature renderers.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:60
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition qgsfeedback.h:44
Encapsulate a field in an attribute table or data source.
Definition qgsfield.h:56
A fill symbol type, for rendering Polygon and MultiPolygon geometries.
A geometry is the spatial representation of a feature.
Line string geometry type, with support for z-dimension and m-values.
A line symbol type, for rendering LineString and MultiLineString geometries.
A marker symbol type, for rendering Point and MultiPoint geometries.
Multi curve geometry collection.
Multi line string geometry collection.
Multi point geometry collection.
Multi polygon geometry collection.
Multi surface geometry collection.
QNetworkAccessManager with additional QGIS specific logic.
Point geometry type, with support for z-dimension and m-values.
Definition qgspoint.h:53
Polygon geometry type.
Definition qgspolygon.h:37
A rectangle specified with double values.
Abstract base class for all rendered symbols.
Definition qgssymbol.h:231
#define SIP_ENUM_BASETYPE(type)
Definition qgis_sip.h:274
#define SIP_OUT
Definition qgis_sip.h:57
Q_DECLARE_OPERATORS_FOR_FLAGS(QgsProjectionSelectionWidget::CrsOptions)