QGIS API Documentation  3.10.0-A Coruña (6c816b4204)
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 
24 #include "qgis_server.h"
25 
26 class QgsProject;
27 class QgsRectangle;
28 
29 #ifdef SIP_RUN
30 % ModuleHeaderCode
31 #include "qgsserverprojectutils.h"
32 % End
33 #endif
34 
35 
43 {
44 
50  SERVER_EXPORT bool owsServiceCapabilities( const QgsProject &project );
51 
57  SERVER_EXPORT QString owsServiceTitle( const QgsProject &project );
58 
64  SERVER_EXPORT QString owsServiceAbstract( const QgsProject &project );
65 
71  SERVER_EXPORT QStringList owsServiceKeywords( const QgsProject &project );
72 
78  SERVER_EXPORT QString owsServiceOnlineResource( const QgsProject &project );
79 
85  SERVER_EXPORT QString owsServiceContactOrganization( const QgsProject &project );
86 
92  SERVER_EXPORT QString owsServiceContactPosition( const QgsProject &project );
93 
99  SERVER_EXPORT QString owsServiceContactPerson( const QgsProject &project );
100 
106  SERVER_EXPORT QString owsServiceContactMail( const QgsProject &project );
107 
113  SERVER_EXPORT QString owsServiceContactPhone( const QgsProject &project );
114 
120  SERVER_EXPORT QString owsServiceFees( const QgsProject &project );
121 
127  SERVER_EXPORT QString owsServiceAccessConstraints( const QgsProject &project );
128 
134  SERVER_EXPORT int wmsMaxWidth( const QgsProject &project );
135 
141  SERVER_EXPORT int wmsMaxHeight( const QgsProject &project );
142 
148  SERVER_EXPORT int wmsImageQuality( const QgsProject &project );
149 
156  SERVER_EXPORT int wmsTileBuffer( const QgsProject &project );
157 
163  SERVER_EXPORT int wmsMaxAtlasFeatures( const QgsProject &project );
164 
171  SERVER_EXPORT double wmsDefaultMapUnitsPerMm( const QgsProject &project );
172 
178  SERVER_EXPORT bool wmsUseLayerIds( const QgsProject &project );
179 
185  SERVER_EXPORT bool wmsInfoFormatSia2045( const QgsProject &project );
186 
192  SERVER_EXPORT bool wmsFeatureInfoAddWktGeometry( const QgsProject &project );
193 
199  SERVER_EXPORT bool wmsFeatureInfoSegmentizeWktGeometry( const QgsProject &project );
200 
206  SERVER_EXPORT int wmsFeatureInfoPrecision( const QgsProject &project );
207 
213  SERVER_EXPORT QString wmsFeatureInfoDocumentElement( const QgsProject &project );
214 
220  SERVER_EXPORT QString wmsFeatureInfoDocumentElementNs( const QgsProject &project );
221 
227  SERVER_EXPORT QString wmsFeatureInfoSchema( const QgsProject &project );
228 
234  SERVER_EXPORT QHash<QString, QString> wmsFeatureInfoLayerAliasMap( const QgsProject &project );
235 
241  SERVER_EXPORT bool wmsInspireActivate( const QgsProject &project );
242 
248  SERVER_EXPORT QString wmsInspireLanguage( const QgsProject &project );
249 
255  SERVER_EXPORT QString wmsInspireMetadataUrl( const QgsProject &project );
256 
262  SERVER_EXPORT QString wmsInspireMetadataUrlType( const QgsProject &project );
263 
269  SERVER_EXPORT QString wmsInspireTemporalReference( const QgsProject &project );
270 
276  SERVER_EXPORT QString wmsInspireMetadataDate( const QgsProject &project );
277 
283  SERVER_EXPORT QStringList wmsRestrictedComposers( const QgsProject &project );
284 
290  SERVER_EXPORT QString wmsServiceUrl( const QgsProject &project );
291 
297  SERVER_EXPORT QString wmsRootName( const QgsProject &project );
298 
304  SERVER_EXPORT QStringList wmsRestrictedLayers( const QgsProject &project );
305 
311  SERVER_EXPORT QStringList wmsOutputCrsList( const QgsProject &project );
312 
318  SERVER_EXPORT QgsRectangle wmsExtent( const QgsProject &project );
319 
325  SERVER_EXPORT QString wfsServiceUrl( const QgsProject &project );
326 
332  SERVER_EXPORT QStringList wfsLayerIds( const QgsProject &project );
333 
341  SERVER_EXPORT int wfsLayerPrecision( const QgsProject &project, const QString &layerId );
342 
348  SERVER_EXPORT QStringList wfstUpdateLayerIds( const QgsProject &project );
349 
355  SERVER_EXPORT QStringList wfstInsertLayerIds( const QgsProject &project );
356 
362  SERVER_EXPORT QStringList wfstDeleteLayerIds( const QgsProject &project );
363 
369  SERVER_EXPORT QString wcsServiceUrl( const QgsProject &project );
370 
376  SERVER_EXPORT QStringList wcsLayerIds( const QgsProject &project );
377 
384  SERVER_EXPORT QString wmtsServiceUrl( const QgsProject &project );
385 };
386 
387 #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.
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 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:89
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 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.