QGIS API Documentation  3.17.0-Master (a035f434f4)
qgsserverprojectutils.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsserverprojectutils.h
3  -----------------------
4  begin : December 19, 2016
5  copyright : (C) 2016 by Paul Blottiere
6  email : paul dot blottiere at oslandia dot com
7  ***************************************************************************/
8 
9 /***************************************************************************
10  * *
11  * This program is free software; you can redistribute it and/or modify *
12  * it under the terms of the GNU General Public License as published by *
13  * the Free Software Foundation; either version 2 of the License, or *
14  * (at your option) any later version. *
15  * *
16  ***************************************************************************/
17 
18 #ifndef QGSSERVERPROJECTUTILS_H
19 #define QGSSERVERPROJECTUTILS_H
20 
21 #include <QString>
22 #include <QHash>
23 #include <cmath>
24 
25 #include "qgis_server.h"
26 #include "qgis_sip.h"
27 
28 class QgsProject;
29 class QgsRectangle;
30 
31 #ifdef SIP_RUN
32 % ModuleHeaderCode
33 #include "qgsserverprojectutils.h"
34 % End
35 #endif
36 
37 
45 {
46 
52  SERVER_EXPORT double ceilWithPrecision( double number, int places ) SIP_SKIP;
53 
59  SERVER_EXPORT double floorWithPrecision( double number, int places ) SIP_SKIP;
60 
66  SERVER_EXPORT bool owsServiceCapabilities( const QgsProject &project );
67 
73  SERVER_EXPORT QString owsServiceTitle( const QgsProject &project );
74 
80  SERVER_EXPORT QString owsServiceAbstract( const QgsProject &project );
81 
87  SERVER_EXPORT QStringList owsServiceKeywords( const QgsProject &project );
88 
94  SERVER_EXPORT QString owsServiceOnlineResource( const QgsProject &project );
95 
101  SERVER_EXPORT QString owsServiceContactOrganization( const QgsProject &project );
102 
108  SERVER_EXPORT QString owsServiceContactPosition( const QgsProject &project );
109 
115  SERVER_EXPORT QString owsServiceContactPerson( const QgsProject &project );
116 
122  SERVER_EXPORT QString owsServiceContactMail( const QgsProject &project );
123 
129  SERVER_EXPORT QString owsServiceContactPhone( const QgsProject &project );
130 
136  SERVER_EXPORT QString owsServiceFees( const QgsProject &project );
137 
143  SERVER_EXPORT QString owsServiceAccessConstraints( const QgsProject &project );
144 
150  SERVER_EXPORT int wmsMaxWidth( const QgsProject &project );
151 
157  SERVER_EXPORT int wmsMaxHeight( const QgsProject &project );
158 
164  SERVER_EXPORT int wmsImageQuality( const QgsProject &project );
165 
172  SERVER_EXPORT int wmsTileBuffer( const QgsProject &project );
173 
179  SERVER_EXPORT int wmsMaxAtlasFeatures( const QgsProject &project );
180 
187  SERVER_EXPORT double wmsDefaultMapUnitsPerMm( const QgsProject &project );
188 
194  SERVER_EXPORT bool wmsUseLayerIds( const QgsProject &project );
195 
201  SERVER_EXPORT bool wmsInfoFormatSia2045( const QgsProject &project );
202 
208  SERVER_EXPORT bool wmsFeatureInfoAddWktGeometry( const QgsProject &project );
209 
215  SERVER_EXPORT bool wmsFeatureInfoSegmentizeWktGeometry( const QgsProject &project );
216 
222  SERVER_EXPORT int wmsFeatureInfoPrecision( const QgsProject &project );
223 
229  SERVER_EXPORT QString wmsFeatureInfoDocumentElement( const QgsProject &project );
230 
236  SERVER_EXPORT QString wmsFeatureInfoDocumentElementNs( const QgsProject &project );
237 
243  SERVER_EXPORT QString wmsFeatureInfoSchema( const QgsProject &project );
244 
250  SERVER_EXPORT QHash<QString, QString> wmsFeatureInfoLayerAliasMap( const QgsProject &project );
251 
257  SERVER_EXPORT bool wmsInspireActivate( const QgsProject &project );
258 
264  SERVER_EXPORT QString wmsInspireLanguage( const QgsProject &project );
265 
271  SERVER_EXPORT QString wmsInspireMetadataUrl( const QgsProject &project );
272 
278  SERVER_EXPORT QString wmsInspireMetadataUrlType( const QgsProject &project );
279 
285  SERVER_EXPORT QString wmsInspireTemporalReference( const QgsProject &project );
286 
292  SERVER_EXPORT QString wmsInspireMetadataDate( const QgsProject &project );
293 
299  SERVER_EXPORT QStringList wmsRestrictedComposers( const QgsProject &project );
300 
306  SERVER_EXPORT QString wmsServiceUrl( const QgsProject &project );
307 
313  SERVER_EXPORT QString wmsRootName( const QgsProject &project );
314 
320  SERVER_EXPORT QStringList wmsRestrictedLayers( const QgsProject &project );
321 
327  SERVER_EXPORT QStringList wmsOutputCrsList( const QgsProject &project );
328 
334  SERVER_EXPORT QgsRectangle wmsExtent( const QgsProject &project );
335 
341  SERVER_EXPORT QString wfsServiceUrl( const QgsProject &project );
342 
348  SERVER_EXPORT QStringList wfsLayerIds( const QgsProject &project );
349 
357  SERVER_EXPORT int wfsLayerPrecision( const QgsProject &project, const QString &layerId );
358 
364  SERVER_EXPORT QStringList wfstUpdateLayerIds( const QgsProject &project );
365 
371  SERVER_EXPORT QStringList wfstInsertLayerIds( const QgsProject &project );
372 
378  SERVER_EXPORT QStringList wfstDeleteLayerIds( const QgsProject &project );
379 
385  SERVER_EXPORT QString wcsServiceUrl( const QgsProject &project );
386 
392  SERVER_EXPORT QStringList wcsLayerIds( const QgsProject &project );
393 
400  SERVER_EXPORT QString wmtsServiceUrl( const QgsProject &project );
401 };
402 
403 #endif
SERVER_EXPORT QString wmsInspireMetadataUrl(const QgsProject &project)
Returns the Inspire metadata URL.
SERVER_EXPORT QStringList wmsOutputCrsList(const QgsProject &project)
Returns the WMS output CRS list.
A rectangle specified with double values.
Definition: qgsrectangle.h:41
SERVER_EXPORT QStringList wfstUpdateLayerIds(const QgsProject &project)
Returns the Layer ids list defined in a QGIS project as published as WFS-T with update capabilities...
SERVER_EXPORT int wmsMaxWidth(const QgsProject &project)
Returns the maximum width for WMS images defined in a QGIS project.
SERVER_EXPORT bool owsServiceCapabilities(const QgsProject &project)
Returns if owsService capabilities are enabled.
SERVER_EXPORT int wmsTileBuffer(const QgsProject &project)
Returns the tile buffer in pixels for WMS images defined in a QGIS project.
SERVER_EXPORT QString wmsServiceUrl(const QgsProject &project)
Returns the WMS service url defined in a QGIS project.
SERVER_EXPORT QString owsServiceContactPosition(const QgsProject &project)
Returns the owsService contact position defined in project.
SERVER_EXPORT QString owsServiceContactPerson(const QgsProject &project)
Returns the owsService contact person defined in project.
SERVER_EXPORT QStringList owsServiceKeywords(const QgsProject &project)
Returns the owsService keywords defined in project.
SERVER_EXPORT double wmsDefaultMapUnitsPerMm(const QgsProject &project)
Returns the default number of map units per millimeters in case of the scale is not given...
SERVER_EXPORT QString owsServiceAbstract(const QgsProject &project)
Returns the owsService abstract defined in project.
SERVER_EXPORT QString wmsFeatureInfoDocumentElement(const QgsProject &project)
Returns the document element name for XML GetFeatureInfo request.
SERVER_EXPORT QHash< QString, QString > wmsFeatureInfoLayerAliasMap(const QgsProject &project)
Returns the mapping between layer name and wms layer name for GetFeatureInfo request.
SERVER_EXPORT bool wmsInfoFormatSia2045(const QgsProject &project)
Returns if the info format is SIA20145.
SERVER_EXPORT QString wmsInspireMetadataDate(const QgsProject &project)
Returns the Inspire metadata date.
SERVER_EXPORT QString wmtsServiceUrl(const QgsProject &project)
Returns the WMTS service url defined in a QGIS project.
SERVER_EXPORT bool wmsFeatureInfoAddWktGeometry(const QgsProject &project)
Returns if the geometry is displayed as Well Known Text in GetFeatureInfo request.
SERVER_EXPORT int wmsMaxAtlasFeatures(const QgsProject &project)
Returns the maximum number of atlas features which can be printed in a request.
SERVER_EXPORT QString wmsFeatureInfoDocumentElementNs(const QgsProject &project)
Returns the document element namespace for XML GetFeatureInfo request.
#define SIP_SKIP
Definition: qgis_sip.h:126
SERVER_EXPORT QStringList wfstDeleteLayerIds(const QgsProject &project)
Returns the Layer ids list defined in a QGIS project as published as WFS-T with delete capabilities...
SERVER_EXPORT QStringList wmsRestrictedComposers(const QgsProject &project)
Returns the restricted composer list.
SERVER_EXPORT double floorWithPrecision(double number, int places)
Returns a double less than number to the specified number of places.
SERVER_EXPORT QStringList wcsLayerIds(const QgsProject &project)
Returns the Layer ids list defined in a QGIS project as published in WCS.
SERVER_EXPORT bool wmsFeatureInfoSegmentizeWktGeometry(const QgsProject &project)
Returns if the geometry has to be segmentize in GetFeatureInfo request.
SERVER_EXPORT bool wmsInspireActivate(const QgsProject &project)
Returns if Inspire is activated.
SERVER_EXPORT QString wmsInspireTemporalReference(const QgsProject &project)
Returns the Inspire temporal reference.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts, annotations, canvases, etc.
Definition: qgsproject.h:94
SERVER_EXPORT QString wmsInspireLanguage(const QgsProject &project)
Returns the Inspire language.
SERVER_EXPORT QString owsServiceFees(const QgsProject &project)
Returns the owsService fees defined in project.
SERVER_EXPORT double ceilWithPrecision(double number, int places)
Returns a double greater than number to the specified number of places.
SERVER_EXPORT QString owsServiceAccessConstraints(const QgsProject &project)
Returns the owsService access constraints defined in project.
SERVER_EXPORT int wfsLayerPrecision(const QgsProject &project, const QString &layerId)
Returns the Layer precision defined in a QGIS project for the WFS GetFeature.
SERVER_EXPORT QString owsServiceOnlineResource(const QgsProject &project)
Returns the owsService online resource defined in project.
SERVER_EXPORT QString owsServiceContactOrganization(const QgsProject &project)
Returns the owsService contact organization defined in project.
SERVER_EXPORT QString wcsServiceUrl(const QgsProject &project)
Returns the WCS service url defined in a QGIS project.
SERVER_EXPORT int wmsFeatureInfoPrecision(const QgsProject &project)
Returns the geometry precision for GetFeatureInfo request.
SERVER_EXPORT QgsRectangle wmsExtent(const QgsProject &project)
Returns the WMS Extent restriction.
SERVER_EXPORT QStringList wfsLayerIds(const QgsProject &project)
Returns the Layer ids list defined in a QGIS project as published in WFS.
SERVER_EXPORT QString wmsInspireMetadataUrlType(const QgsProject &project)
Returns the Inspire metadata URL type.
SERVER_EXPORT QStringList wfstInsertLayerIds(const QgsProject &project)
Returns the Layer ids list defined in a QGIS project as published as WFS-T with insert capabilities...
SERVER_EXPORT QString owsServiceContactMail(const QgsProject &project)
Returns the owsService contact mail defined in project.
SERVER_EXPORT QString wmsFeatureInfoSchema(const QgsProject &project)
Returns the schema URL for XML GetFeatureInfo request.
SERVER_EXPORT QStringList wmsRestrictedLayers(const QgsProject &project)
Returns the restricted layer name list.
SERVER_EXPORT QString wmsRootName(const QgsProject &project)
Returns the WMS root layer name defined in a QGIS project.
SERVER_EXPORT QString wfsServiceUrl(const QgsProject &project)
Returns the WFS service url defined in a QGIS project.
SERVER_EXPORT QString owsServiceTitle(const QgsProject &project)
Returns the owsService title defined in project.
SERVER_EXPORT int wmsImageQuality(const QgsProject &project)
Returns the quality for WMS images defined in a QGIS project.
SERVER_EXPORT QString owsServiceContactPhone(const QgsProject &project)
Returns the owsService contact phone defined in project.
SERVER_EXPORT int wmsMaxHeight(const QgsProject &project)
Returns the maximum height for WMS images defined in a QGIS project.
The QgsServerProjectUtils namespace provides a way to retrieve specific entries from a QgsProject...
SERVER_EXPORT bool wmsUseLayerIds(const QgsProject &project)
Returns if layer ids are used as name in WMS.