QGIS API Documentation  3.14.0-Pi (9f7028fd23)
Classes | Typedefs | Enumerations | Functions
QgsWms Namespace Reference

WMS implementation. More...

Classes

class  QgsBadRequestException
 Exception thrown in case of malformed request. More...
 
class  QgsMapRendererJobProxy
 Proxy for sequential or parallel map render job. More...
 
class  QgsRenderer
 Map renderer for WMS requests. More...
 
class  QgsSecurityException
 Exception thrown when data access violates access controls. More...
 
class  QgsServiceException
 Exception class for WMS service exceptions. More...
 
class  QgsWmsParameter
 WMS parameter received from the client. More...
 
class  QgsWmsParameters
 Provides an interface to retrieve and manipulate WMS parameters received from the client. More...
 
struct  QgsWmsParametersComposerMap
 
struct  QgsWmsParametersExternalLayer
 
struct  QgsWmsParametersFilter
 
struct  QgsWmsParametersHighlightLayer
 
struct  QgsWmsParametersLayer
 
class  QgsWmsRenderContext
 Rendering context for the WMS renderer. More...
 
class  QgsWmsRestorer
 
class  Service
 OGC web service specialized for WMS. More...
 

Typedefs

typedef QList< QPair< QRgb, int > > QgsColorBox
 
typedef QMultiMap< int, QgsColorBoxQgsColorBoxMap
 

Enumerations

enum  ImageOutputFormat {
  UNKN, PNG, PNG8, PNG16,
  PNG1, JPEG, WEBP
}
 Supported image output format. More...
 

Functions

void checkParameters (QgsWmsParameters &parameters)
 checkParameters checks request parameters and sets SRCHEIGHT and SRCWIDTH to default values in case BBOX is specified for contextual legend and (SRC)HEIGHT or (SRC)WIDTH are not. More...
 
QDomDocument describeLayer (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request)
 DescribeLayer is defined for WMS1.1.1/SLD1.0 and in WMS 1.3.0 SLD Extension. More...
 
QDomDocument getCapabilities (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, bool projectSettings)
 Creates the WMS GetCapabilities XML document. More...
 
QDomElement getCapabilityElement (QDomDocument &doc, const QgsProject *project, const QString &version, const QgsServerRequest &request, bool projectSettings)
 Create Capability element for get capabilities document. More...
 
QDomElement getComposerTemplatesElement (QDomDocument &doc, const QgsProject *project)
 Create ComposerTemplates element for get capabilities document. More...
 
QDomDocument getContext (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request)
 Returns XML document for the 'GetContext' request. More...
 
QDomElement getInspireCapabilitiesElement (QDomDocument &doc, const QgsProject *project)
 Create InspireCapabilities element for get capabilities document. More...
 
QDomElement getLayersAndStylesCapabilitiesElement (QDomDocument &doc, QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, bool projectSettings)
 Create element for get capabilities document. More...
 
QDomElement getServiceElement (QDomDocument &doc, const QgsProject *project, const QString &version, const QgsServerRequest &request)
 Create Service element for get capabilities document. More...
 
QDomDocument getStyle (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request)
 Returns an SLD file with the style of the requested layer. More...
 
QDomDocument getStyles (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request)
 Returns an SLD file with the styles of the requested layers. More...
 
QDomElement getWFSLayersElement (QDomDocument &doc, const QgsProject *project)
 Create WFSLayers element for get capabilities document. More...
 
bool hasQueryableChildren (const QgsLayerTreeNode *childNode, const QStringList &wmsRestrictedLayers)
 
QgsLayerTreelayerTree (const QgsWmsRenderContext &context)
 
QgsLayerTreeModellegendModel (const QgsWmsRenderContext &context, QgsLayerTree &tree)
 
QgsLayerTreeModelLegendNodelegendNode (const QString &rule, QgsLayerTreeModel &model)
 
void medianCut (QVector< QRgb > &colorTable, int nColors, const QImage &inputImage)
 Median cut implementation used when reducing RGB colors to palletized colors. More...
 
ImageOutputFormat parseImageFormat (const QString &format)
 Parse image format parameter. More...
 
QUrl serviceUrl (const QgsServerRequest &request, const QgsProject *project)
 Returns WMS service URL. More...
 
void writeAsDxf (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response)
 Output GetMap response in DXF format. More...
 
void writeDescribeLayer (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response)
 Output GetMap response in DXF format. More...
 
void writeGetCapabilities (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response, bool projectSettings=false)
 Output GetCapabilities response. More...
 
void writeGetContext (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response)
 Output GetContext response. More...
 
void writeGetFeatureInfo (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response)
 Output GetFeatureInfo response. More...
 
void writeGetLegendGraphics (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response)
 Output GetLegendGRaphics response. More...
 
void writeGetMap (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response)
 Output GetMap response in DXF format. More...
 
void writeGetPrint (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response)
 Output GetPrint response. More...
 
void writeGetSchemaExtension (QgsServerResponse &response)
 Output GetSchemaExtension response. More...
 
void writeGetStyle (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response)
 Output GetStyle response. More...
 
void writeGetStyles (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response)
 Output GetStyles response. More...
 
void writeImage (QgsServerResponse &response, QImage &img, const QString &formatStr, int imageQuality=-1)
 Write image response. More...
 

Detailed Description

WMS implementation.

Median cut implementation

WMS implementation

Typedef Documentation

◆ QgsColorBox

typedef QList< QPair<QRgb, int> > QgsWms::QgsColorBox

Definition at line 48 of file qgsmediancut.cpp.

◆ QgsColorBoxMap

typedef QMultiMap< int, QgsColorBox > QgsWms::QgsColorBoxMap

Definition at line 49 of file qgsmediancut.cpp.

Enumeration Type Documentation

◆ ImageOutputFormat

Supported image output format.

Enumerator
UNKN 
PNG 
PNG8 
PNG16 
PNG1 
JPEG 
WEBP 

Definition at line 39 of file qgswmsutils.h.

Function Documentation

◆ checkParameters()

void QgsWms::checkParameters ( QgsWmsParameters parameters)

checkParameters checks request parameters and sets SRCHEIGHT and SRCWIDTH to default values in case BBOX is specified for contextual legend and (SRC)HEIGHT or (SRC)WIDTH are not.

Definition at line 187 of file qgswmsgetlegendgraphics.cpp.

◆ describeLayer()

QDomDocument QgsWms::describeLayer ( QgsServerInterface serverIface,
const QgsProject project,
const QString &  version,
const QgsServerRequest request 
)

DescribeLayer is defined for WMS1.1.1/SLD1.0 and in WMS 1.3.0 SLD Extension.

Definition at line 57 of file qgswmsdescribelayer.cpp.

◆ getCapabilities()

QDomDocument QgsWms::getCapabilities ( QgsServerInterface serverIface,
const QgsProject project,
const QString &  version,
const QgsServerRequest request,
bool  projectSettings 
)

Creates the WMS GetCapabilities XML document.

Parameters
serverIfaceInterface for plugins
projectProject
versionWMS version
requestWMS request
projectSettingsIf true, adds extended project information (does not validate against WMS schema)
Returns
GetCapabilities XML document

Definition at line 185 of file qgswmsgetcapabilities.cpp.

◆ getCapabilityElement()

QDomElement QgsWms::getCapabilityElement ( QDomDocument &  doc,
const QgsProject project,
const QString &  version,
const QgsServerRequest request,
bool  projectSettings 
)

Create Capability element for get capabilities document.

Definition at line 449 of file qgswmsgetcapabilities.cpp.

◆ getComposerTemplatesElement()

QDomElement QgsWms::getComposerTemplatesElement ( QDomDocument &  doc,
const QgsProject project 
)

Create ComposerTemplates element for get capabilities document.

Definition at line 697 of file qgswmsgetcapabilities.cpp.

◆ getContext()

QDomDocument QgsWms::getContext ( QgsServerInterface serverIface,
const QgsProject project,
const QString &  version,
const QgsServerRequest request 
)

Returns XML document for the 'GetContext' request.

Definition at line 106 of file qgswmsgetcontext.cpp.

◆ getInspireCapabilitiesElement()

QDomElement QgsWms::getInspireCapabilitiesElement ( QDomDocument &  doc,
const QgsProject project 
)

Create InspireCapabilities element for get capabilities document.

Definition at line 591 of file qgswmsgetcapabilities.cpp.

◆ getLayersAndStylesCapabilitiesElement()

QDomElement QgsWms::getLayersAndStylesCapabilitiesElement ( QDomDocument &  doc,
QgsServerInterface serverIface,
const QgsProject project,
const QString &  version,
const QgsServerRequest request,
bool  projectSettings 
)

Create element for get capabilities document.

Definition at line 842 of file qgswmsgetcapabilities.cpp.

◆ getServiceElement()

QDomElement QgsWms::getServiceElement ( QDomDocument &  doc,
const QgsProject project,
const QString &  version,
const QgsServerRequest request 
)

Create Service element for get capabilities document.

Definition at line 274 of file qgswmsgetcapabilities.cpp.

◆ getStyle()

QDomDocument QgsWms::getStyle ( QgsServerInterface serverIface,
const QgsProject project,
const QString &  version,
const QgsServerRequest request 
)

Returns an SLD file with the style of the requested layer.

Definition at line 103 of file qgswmsgetstyles.cpp.

◆ getStyles()

QDomDocument QgsWms::getStyles ( QgsServerInterface serverIface,
const QgsProject project,
const QString &  version,
const QgsServerRequest request 
)

Returns an SLD file with the styles of the requested layers.

Exception is raised in case of troubles :-)

Definition at line 69 of file qgswmsgetstyles.cpp.

◆ getWFSLayersElement()

QDomElement QgsWms::getWFSLayersElement ( QDomDocument &  doc,
const QgsProject project 
)

Create WFSLayers element for get capabilities document.

Definition at line 812 of file qgswmsgetcapabilities.cpp.

◆ hasQueryableChildren()

bool QgsWms::hasQueryableChildren ( const QgsLayerTreeNode childNode,
const QStringList &  wmsRestrictedLayers 
)

Definition at line 2037 of file qgswmsgetcapabilities.cpp.

◆ layerTree()

QgsLayerTree * QgsWms::layerTree ( const QgsWmsRenderContext context)

Definition at line 320 of file qgswmsgetlegendgraphics.cpp.

◆ legendModel()

QgsLayerTreeModel * QgsWms::legendModel ( const QgsWmsRenderContext context,
QgsLayerTree tree 
)

Definition at line 243 of file qgswmsgetlegendgraphics.cpp.

◆ legendNode()

QgsLayerTreeModelLegendNode * QgsWms::legendNode ( const QString &  rule,
QgsLayerTreeModel model 
)

Definition at line 358 of file qgswmsgetlegendgraphics.cpp.

◆ medianCut()

void QgsWms::medianCut ( QVector< QRgb > &  colorTable,
int  nColors,
const QImage &  inputImage 
)

Median cut implementation used when reducing RGB colors to palletized colors.

Definition at line 273 of file qgsmediancut.cpp.

◆ parseImageFormat()

ImageOutputFormat QgsWms::parseImageFormat ( const QString &  format)

Parse image format parameter.

Returns
OutputFormat

Definition at line 87 of file qgswmsutils.cpp.

◆ serviceUrl()

QUrl QgsWms::serviceUrl ( const QgsServerRequest request,
const QgsProject project 
)

Returns WMS service URL.

Definition at line 49 of file qgswmsutils.cpp.

◆ writeAsDxf()

void QgsWms::writeAsDxf ( QgsServerInterface serverIface,
const QgsProject project,
const QString &  ,
const QgsServerRequest request,
QgsServerResponse response 
)

Output GetMap response in DXF format.

Definition at line 39 of file qgsdxfwriter.cpp.

◆ writeDescribeLayer()

void QgsWms::writeDescribeLayer ( QgsServerInterface serverIface,
const QgsProject project,
const QString &  version,
const QgsServerRequest request,
QgsServerResponse response 
)

Output GetMap response in DXF format.

Definition at line 48 of file qgswmsdescribelayer.cpp.

◆ writeGetCapabilities()

void QgsWms::writeGetCapabilities ( QgsServerInterface serverIface,
const QgsProject project,
const QString &  version,
const QgsServerRequest request,
QgsServerResponse response,
bool  projectSettings 
)

Output GetCapabilities response.

Definition at line 110 of file qgswmsgetcapabilities.cpp.

◆ writeGetContext()

void QgsWms::writeGetContext ( QgsServerInterface serverIface,
const QgsProject project,
const QString &  version,
const QgsServerRequest request,
QgsServerResponse response 
)

Output GetContext response.

Definition at line 70 of file qgswmsgetcontext.cpp.

◆ writeGetFeatureInfo()

void QgsWms::writeGetFeatureInfo ( QgsServerInterface serverIface,
const QgsProject project,
const QString &  version,
const QgsServerRequest request,
QgsServerResponse response 
)

Output GetFeatureInfo response.

Definition at line 44 of file qgswmsgetfeatureinfo.cpp.

◆ writeGetLegendGraphics()

void QgsWms::writeGetLegendGraphics ( QgsServerInterface serverIface,
const QgsProject project,
const QString &  ,
const QgsServerRequest request,
QgsServerResponse response 
)

Output GetLegendGRaphics response.

Definition at line 56 of file qgswmsgetlegendgraphics.cpp.

◆ writeGetMap()

void QgsWms::writeGetMap ( QgsServerInterface serverIface,
const QgsProject project,
const QString &  ,
const QgsServerRequest request,
QgsServerResponse response 
)

Output GetMap response in DXF format.

Definition at line 48 of file qgswmsgetmap.cpp.

◆ writeGetPrint()

void QgsWms::writeGetPrint ( QgsServerInterface serverIface,
const QgsProject project,
const QString &  ,
const QgsServerRequest request,
QgsServerResponse response 
)

Output GetPrint response.

Definition at line 45 of file qgswmsgetprint.cpp.

◆ writeGetSchemaExtension()

void QgsWms::writeGetSchemaExtension ( QgsServerResponse response)

Output GetSchemaExtension response.

Definition at line 49 of file qgswmsgetschemaextension.cpp.

◆ writeGetStyle()

void QgsWms::writeGetStyle ( QgsServerInterface serverIface,
const QgsProject project,
const QString &  version,
const QgsServerRequest request,
QgsServerResponse response 
)

Output GetStyle response.

Definition at line 95 of file qgswmsgetstyles.cpp.

◆ writeGetStyles()

void QgsWms::writeGetStyles ( QgsServerInterface serverIface,
const QgsProject project,
const QString &  version,
const QgsServerRequest request,
QgsServerResponse response 
)

Output GetStyles response.

Definition at line 61 of file qgswmsgetstyles.cpp.

◆ writeImage()

void QgsWms::writeImage ( QgsServerResponse response,
QImage &  img,
const QString &  formatStr,
int  imageQuality 
)

Write image response.

Definition at line 124 of file qgswmsutils.cpp.