| 
    QGIS API Documentation
    3.6.0-Noosa (5873452)
    
   | 
 
Median cut 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 | QgsWmsParametersFilter | 
| struct | QgsWmsParametersHighlightLayer | 
| struct | QgsWmsParametersLayer | 
| class | Service | 
| OGC web service specialized for WMS.  More... | |
Typedefs | |
| typedef QList< QPair< QRgb, int > > | QgsColorBox | 
| typedef QMultiMap< int, QgsColorBox > | QgsColorBoxMap | 
Enumerations | |
| enum | ImageOutputFormat {  UNKN, PNG, PNG8, PNG16, PNG1, JPEG }  | 
| Supported image output format.  More... | |
Functions | |
| 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... | |
| QDomDocument | getSchemaExtension (QgsServerInterface *serverIface, const QString &version, const QgsServerRequest &request) | 
| Returns the schemaExtension for WMS 1.3.0 capabilities.  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... | |
| QString | ImplementationVersion () | 
| Returns the highest version supported by this implementation.  More... | |
| void | medianCut (QVector< QRgb > &colorTable, int nColors, const QImage &inputImage) | 
| Median cut implementation used when reducing RGB colors to palletized colors.  More... | |
| QgsRectangle | parseBbox (const QString &bboxstr) | 
| Parse bbox parameter.  More... | |
| ImageOutputFormat | parseImageFormat (const QString &format) | 
| Parse image format parameter.  More... | |
| void | readLayersAndStyles (const QgsServerRequest::Parameters ¶meters, QStringList &layersList, QStringList &stylesList) | 
| Reads the layers and style lists from the parameters LAYERS and STYLES.  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 (QgsServerInterface *serverIface, const QString &version, const QgsServerRequest &request, 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... | |
Median cut implementation.
WMS implementation.
WMS implementation
| typedef QList< QPair<QRgb, int> > QgsWms::QgsColorBox | 
Definition at line 31 of file qgsmediancut.cpp.
| typedef QMultiMap< int, QgsColorBox > QgsWms::QgsColorBoxMap | 
Definition at line 32 of file qgsmediancut.cpp.
Supported image output format.
| Enumerator | |
|---|---|
| UNKN | |
| PNG | |
| PNG8 | |
| PNG16 | |
| PNG1 | |
| JPEG | |
Definition at line 39 of file qgswmsutils.h.
| 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 40 of file qgswmsdescribelayer.cpp.
| QDomDocument QgsWms::getCapabilities | ( | QgsServerInterface * | serverIface, | 
| const QgsProject * | project, | ||
| const QString & | version, | ||
| const QgsServerRequest & | request, | ||
| bool | projectSettings | ||
| ) | 
Creates the WMS GetCapabilities XML document.
| serverIface | Interface for plugins | 
| project | Project | 
| version | WMS version | 
| request | WMS request | 
| projectSettings | If true, adds extended project information (does not validate against WMS schema) | 
Definition at line 160 of file qgswmsgetcapabilities.cpp.
| 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 402 of file qgswmsgetcapabilities.cpp.
| QDomElement QgsWms::getComposerTemplatesElement | ( | QDomDocument & | doc, | 
| const QgsProject * | project | ||
| ) | 
Create ComposerTemplates element for get capabilities document.
Definition at line 649 of file qgswmsgetcapabilities.cpp.
| QDomDocument QgsWms::getContext | ( | QgsServerInterface * | serverIface, | 
| const QgsProject * | project, | ||
| const QString & | version, | ||
| const QgsServerRequest & | request | ||
| ) | 
Returns XML document for the 'GetContext' request.
Definition at line 89 of file qgswmsgetcontext.cpp.
| QDomElement QgsWms::getInspireCapabilitiesElement | ( | QDomDocument & | doc, | 
| const QgsProject * | project | ||
| ) | 
Create InspireCapabilities element for get capabilities document.
Definition at line 543 of file qgswmsgetcapabilities.cpp.
| 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 794 of file qgswmsgetcapabilities.cpp.
| QDomDocument QgsWms::getSchemaExtension | ( | QgsServerInterface * | serverIface, | 
| const QString & | version, | ||
| const QgsServerRequest & | request | ||
| ) | 
Returns the schemaExtension for WMS 1.3.0 capabilities.
Definition at line 39 of file qgswmsgetschemaextension.cpp.
| QDomElement QgsWms::getServiceElement | ( | QDomDocument & | doc, | 
| const QgsProject * | project, | ||
| const QString & | version, | ||
| const QgsServerRequest & | request | ||
| ) | 
Create Service element for get capabilities document.
Definition at line 248 of file qgswmsgetcapabilities.cpp.
| 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 85 of file qgswmsgetstyles.cpp.
| 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 51 of file qgswmsgetstyles.cpp.
| QDomElement QgsWms::getWFSLayersElement | ( | QDomDocument & | doc, | 
| const QgsProject * | project | ||
| ) | 
Create WFSLayers element for get capabilities document.
Definition at line 764 of file qgswmsgetcapabilities.cpp.
| QString QgsWms::ImplementationVersion | ( | ) | 
Returns the highest version supported by this implementation.
Definition at line 32 of file qgswmsutils.cpp.
| 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 256 of file qgsmediancut.cpp.
| QgsRectangle QgsWms::parseBbox | ( | const QString & | bboxstr | ) | 
Parse bbox parameter.
| bboxstr | the bbox string as comma separated values | 
If the parsing fail then an empty bbox is returned
Definition at line 184 of file qgswmsutils.cpp.
| ImageOutputFormat QgsWms::parseImageFormat | ( | const QString & | format | ) | 
| void QgsWms::readLayersAndStyles | ( | const QgsServerRequest::Parameters & | parameters, | 
| QStringList & | layersList, | ||
| QStringList & | stylesList | ||
| ) | 
Reads the layers and style lists from the parameters LAYERS and STYLES.
Definition at line 106 of file qgswmsutils.cpp.
| QUrl QgsWms::serviceUrl | ( | const QgsServerRequest & | request, | 
| const QgsProject * | project | ||
| ) | 
Returns WMS service URL.
Definition at line 37 of file qgswmsutils.cpp.
| void QgsWms::writeAsDxf | ( | QgsServerInterface * | serverIface, | 
| const QgsProject * | project, | ||
| const QString & | version, | ||
| const QgsServerRequest & | request, | ||
| QgsServerResponse & | response | ||
| ) | 
Output GetMap response in DXF format.
Definition at line 47 of file qgsdxfwriter.cpp.
| 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 31 of file qgswmsdescribelayer.cpp.
| void QgsWms::writeGetCapabilities | ( | QgsServerInterface * | serverIface, | 
| const QgsProject * | project, | ||
| const QString & | version, | ||
| const QgsServerRequest & | request, | ||
| QgsServerResponse & | response, | ||
| bool | projectSettings | ||
| ) | 
Output GetCapabilities response.
Definition at line 89 of file qgswmsgetcapabilities.cpp.
| void QgsWms::writeGetContext | ( | QgsServerInterface * | serverIface, | 
| const QgsProject * | project, | ||
| const QString & | version, | ||
| const QgsServerRequest & | request, | ||
| QgsServerResponse & | response | ||
| ) | 
Output GetContext response.
Definition at line 53 of file qgswmsgetcontext.cpp.
| void QgsWms::writeGetFeatureInfo | ( | QgsServerInterface * | serverIface, | 
| const QgsProject * | project, | ||
| const QString & | version, | ||
| const QgsServerRequest & | request, | ||
| QgsServerResponse & | response | ||
| ) | 
Output GetFeatureInfo response.
Definition at line 28 of file qgswmsgetfeatureinfo.cpp.
| void QgsWms::writeGetLegendGraphics | ( | QgsServerInterface * | serverIface, | 
| const QgsProject * | project, | ||
| const QString & | version, | ||
| const QgsServerRequest & | request, | ||
| QgsServerResponse & | response | ||
| ) | 
Output GetLegendGRaphics response.
Definition at line 30 of file qgswmsgetlegendgraphics.cpp.
| void QgsWms::writeGetMap | ( | QgsServerInterface * | serverIface, | 
| const QgsProject * | project, | ||
| const QString & | version, | ||
| const QgsServerRequest & | request, | ||
| QgsServerResponse & | response | ||
| ) | 
Output GetMap response in DXF format.
Definition at line 30 of file qgswmsgetmap.cpp.
| void QgsWms::writeGetPrint | ( | QgsServerInterface * | serverIface, | 
| const QgsProject * | project, | ||
| const QString & | version, | ||
| const QgsServerRequest & | request, | ||
| QgsServerResponse & | response | ||
| ) | 
Output GetPrint response.
Definition at line 27 of file qgswmsgetprint.cpp.
| void QgsWms::writeGetSchemaExtension | ( | QgsServerInterface * | serverIface, | 
| const QString & | version, | ||
| const QgsServerRequest & | request, | ||
| QgsServerResponse & | response | ||
| ) | 
Output GetSchemaExtension response.
Definition at line 31 of file qgswmsgetschemaextension.cpp.
| void QgsWms::writeGetStyle | ( | QgsServerInterface * | serverIface, | 
| const QgsProject * | project, | ||
| const QString & | version, | ||
| const QgsServerRequest & | request, | ||
| QgsServerResponse & | response | ||
| ) | 
Output GetStyle response.
Definition at line 77 of file qgswmsgetstyles.cpp.
| void QgsWms::writeGetStyles | ( | QgsServerInterface * | serverIface, | 
| const QgsProject * | project, | ||
| const QString & | version, | ||
| const QgsServerRequest & | request, | ||
| QgsServerResponse & | response | ||
| ) | 
Output GetStyles response.
Definition at line 43 of file qgswmsgetstyles.cpp.
| void QgsWms::writeImage | ( | QgsServerResponse & | response, | 
| QImage & | img, | ||
| const QString & | formatStr, | ||
| int | imageQuality | ||
| ) | 
Write image response.
Definition at line 117 of file qgswmsutils.cpp.
 1.8.13