QGIS API Documentation  3.23.0-Master (dd0cd13a00)
qgswmsgetcapabilities.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgswmsgetcapabilities.h
3  -------------------------
4  begin : December 20 , 2016
5  copyright : (C) 2007 by Marco Hugentobler (original code)
6  (C) 2014 by Alessandro Pasotti (original code)
7  (C) 2016 by David Marteau
8  email : marco dot hugentobler at karto dot baug dot ethz dot ch
9  a dot pasotti at itopen dot it
10  david dot marteau at 3liz dot com
11  ***************************************************************************/
12 
13 /***************************************************************************
14  * *
15  * This program is free software; you can redistribute it and/or modify *
16  * it under the terms of the GNU General Public License as published by *
17  * the Free Software Foundation; either version 2 of the License, or *
18  * (at your option) any later version. *
19  * *
20  ***************************************************************************/
21 #ifndef QGSWMSGETCAPABILITIES_H
22 #define QGSWMSGETCAPABILITIES_H
23 
24 #include "qgslayertreenode.h"
25 #include "qgslayertreegroup.h"
26 #include "qgslayertreelayer.h"
27 #include "qgslayertree.h"
28 
29 #include "qgswmsrequest.h"
30 
31 namespace QgsWms
32 {
33 
37  QDomElement getLayersAndStylesCapabilitiesElement( QDomDocument &doc,
38  QgsServerInterface *serverIface,
39  const QgsProject *project,
40  const QgsWmsRequest &request,
41  bool projectSettings );
42 
46  QDomElement getWFSLayersElement( QDomDocument &doc, const QgsProject *project );
47 
51  QDomElement getComposerTemplatesElement( QDomDocument &doc, const QgsProject *project );
52 
56  QDomElement getInspireCapabilitiesElement( QDomDocument &doc, const QgsProject *project );
57 
61  QDomElement getCapabilityElement( QDomDocument &doc, const QgsProject *project,
62  const QgsWmsRequest &request, bool projectSettings,
63  QgsServerInterface *serverIface );
64 
68  QDomElement getServiceElement( QDomDocument &doc, const QgsProject *project,
69  const QgsWmsRequest &request, const QgsServerSettings *serverSettings );
70 
74  void writeGetCapabilities( QgsServerInterface *serverIface,
75  const QgsProject *project,
76  const QgsWmsRequest &request,
77  QgsServerResponse &response,
78  bool projectSettings = false );
79 
88  QDomDocument getCapabilities( QgsServerInterface *serverIface, const QgsProject *project,
89  const QgsWmsRequest &request,
90  bool projectSettings );
91 
92  bool hasQueryableChildren( const QgsLayerTreeNode *childNode, const QStringList &wmsRestrictedLayers );
93 } // namespace QgsWms
94 
95 #endif
This class is a base class for nodes in a layer tree.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition: qgsproject.h:101
QgsServerInterface Class defining interfaces exposed by QGIS Server and made available to plugins.
QgsServerResponse Class defining response interface passed to services QgsService::executeRequest() m...
Provides a way to retrieve settings by prioritizing according to environment variables,...
SERVER_EXPORT QStringList wmsRestrictedLayers(const QgsProject &project)
Returns the restricted layer name list.
Median cut implementation.
QDomElement getWFSLayersElement(QDomDocument &doc, const QgsProject *project)
Create WFSLayers element for get capabilities document.
void writeGetCapabilities(QgsServerInterface *serverIface, const QgsProject *project, const QgsWmsRequest &request, QgsServerResponse &response, bool projectSettings)
Output GetCapabilities response.
QDomElement getLayersAndStylesCapabilitiesElement(QDomDocument &doc, QgsServerInterface *serverIface, const QgsProject *project, const QgsWmsRequest &request, bool projectSettings)
Create element for get capabilities document.
QDomElement getInspireCapabilitiesElement(QDomDocument &doc, const QgsProject *project)
Create InspireCapabilities element for get capabilities document.
QDomElement getComposerTemplatesElement(QDomDocument &doc, const QgsProject *project)
Create ComposerTemplates element for get capabilities document.
QDomElement getServiceElement(QDomDocument &doc, const QgsProject *project, const QgsWmsRequest &request, const QgsServerSettings *serverSettings)
Create Service element for get capabilities document.
QDomElement getCapabilityElement(QDomDocument &doc, const QgsProject *project, const QgsWmsRequest &request, bool projectSettings, QgsServerInterface *serverIface)
Create Capability element for get capabilities document.
bool hasQueryableChildren(const QgsLayerTreeNode *childNode, const QStringList &wmsRestrictedLayers)
QDomDocument getCapabilities(QgsServerInterface *serverIface, const QgsProject *project, const QgsWmsRequest &request, bool projectSettings)
Creates the WMS GetCapabilities XML document.