QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
Static Public Member Functions | Public Attributes | List of all members
QgsWmsLayerInfos Class Reference

WMS Layer infos. More...

#include <qgswmslayerinfos.h>

Static Public Member Functions

static QMap< QString, QgsWmsLayerInfosbuildWmsLayerInfos (QgsServerInterface *serverIface, const QgsProject *project, const QList< QgsCoordinateReferenceSystem > &outputCrsList)
 Returns the WMS layers definition to build WMS capabilities. More...
 
static QgsRectangle transformExtent (const QgsRectangle &extent, const QgsCoordinateReferenceSystem &source, const QgsCoordinateReferenceSystem &destination, const QgsCoordinateTransformContext &context, const bool &ballparkTransformsAreAppropriate=false)
 Returns a transformed extent. More...
 
static QMap< QString, QgsRectangletransformExtentToCrsList (const QgsRectangle &extent, const QgsCoordinateReferenceSystem &source, const QList< QgsCoordinateReferenceSystem > &destinations, const QgsCoordinateTransformContext &context)
 Returns a map with CRS authid as key and the transformed extent as value. More...
 

Public Attributes

QString abstract
 WMS layer abstract. More...
 
QString attribution
 WMS layer attribution. More...
 
QString attributionUrl
 WMS layer attribution URL. More...
 
QMap< QString, QgsRectanglecrsExtents
 WMS layer CRS extents (can be empty) More...
 
QString dataUrl
 WMS layer dataUrl. More...
 
bool hasScaleBasedVisibility = false
 WMS layer has scale based visibility. More...
 
QString id
 QGIS layer id. More...
 
QStringList keywords
 WMS layer keywords. More...
 
QString legendUrl
 WMS layer legend URL. More...
 
QString legendUrlFormat
 WMS layer legend URL format. More...
 
double maxScale = -1.0
 WMS layer maximum scale (if negative, no maximum scale is defined) More...
 
QList< QgsMapLayerServerProperties::MetadataUrlmetadataUrls
 WMS layer metadata URLs. More...
 
double minScale = -1.0
 WMS layer minimum scale (if negative, no maximum scale is defined) More...
 
QString name
 WMS layer name. More...
 
bool queryable = false
 WMS layer is queryable. More...
 
QStringList styles
 WMS layer styles. More...
 
QString title
 WMS layer title. More...
 
Qgis::LayerType type
 QGIS layer type. More...
 
QgsRectangle wgs84BoundingRect
 WMS layer WGS84 bounding rectangle (can be empty) More...
 

Detailed Description

WMS Layer infos.

Since
QGIS 3.28

Definition at line 36 of file qgswmslayerinfos.h.

Member Function Documentation

◆ buildWmsLayerInfos()

QMap< QString, QgsWmsLayerInfos > QgsWmsLayerInfos::buildWmsLayerInfos ( QgsServerInterface serverIface,
const QgsProject project,
const QList< QgsCoordinateReferenceSystem > &  outputCrsList 
)
static

Returns the WMS layers definition to build WMS capabilities.

The output will only contain the published and available after access control layers and layers without extent projection exception.

Parameters
serverIfaceInterface for plugins
projectProject
outputCrsListthe WMS output CRS list.
Returns
the WMS layers definition
Since
QGIS 3.28.0

Definition at line 136 of file qgswmslayerinfos.cpp.

◆ transformExtent()

QgsRectangle QgsWmsLayerInfos::transformExtent ( const QgsRectangle extent,
const QgsCoordinateReferenceSystem source,
const QgsCoordinateReferenceSystem destination,
const QgsCoordinateTransformContext context,
const bool &  ballparkTransformsAreAppropriate = false 
)
static

Returns a transformed extent.

Parameters
extentthe extent to transform
sourcethe extent CRS
destinationthe destination CRS
contextthe transformation context
ballparkTransformsAreAppropriatewhether approximate "ballpark" results are appropriate for the destination CRS
Returns
the transformed extents
Since
QGIS 3.28.0

Definition at line 32 of file qgswmslayerinfos.cpp.

◆ transformExtentToCrsList()

QMap< QString, QgsRectangle > QgsWmsLayerInfos::transformExtentToCrsList ( const QgsRectangle extent,
const QgsCoordinateReferenceSystem source,
const QList< QgsCoordinateReferenceSystem > &  destinations,
const QgsCoordinateTransformContext context 
)
static

Returns a map with CRS authid as key and the transformed extent as value.

Parameters
extentthe extent to transform
sourcethe extent CRS
destinationsthe CRSes destinations
contextthe transformation context
Returns
the transformed extents
Since
QGIS 3.28.0

Definition at line 45 of file qgswmslayerinfos.cpp.

Member Data Documentation

◆ abstract

QString QgsWmsLayerInfos::abstract

WMS layer abstract.

Definition at line 49 of file qgswmslayerinfos.h.

◆ attribution

QString QgsWmsLayerInfos::attribution

WMS layer attribution.

Definition at line 85 of file qgswmslayerinfos.h.

◆ attributionUrl

QString QgsWmsLayerInfos::attributionUrl

WMS layer attribution URL.

Definition at line 88 of file qgswmslayerinfos.h.

◆ crsExtents

QMap<QString, QgsRectangle> QgsWmsLayerInfos::crsExtents

WMS layer CRS extents (can be empty)

Definition at line 58 of file qgswmslayerinfos.h.

◆ dataUrl

QString QgsWmsLayerInfos::dataUrl

WMS layer dataUrl.

Definition at line 82 of file qgswmslayerinfos.h.

◆ hasScaleBasedVisibility

bool QgsWmsLayerInfos::hasScaleBasedVisibility = false

WMS layer has scale based visibility.

Definition at line 73 of file qgswmslayerinfos.h.

◆ id

QString QgsWmsLayerInfos::id

QGIS layer id.

Definition at line 40 of file qgswmslayerinfos.h.

◆ keywords

QStringList QgsWmsLayerInfos::keywords

WMS layer keywords.

Definition at line 52 of file qgswmslayerinfos.h.

◆ legendUrl

QString QgsWmsLayerInfos::legendUrl

WMS layer legend URL.

Definition at line 64 of file qgswmslayerinfos.h.

◆ legendUrlFormat

QString QgsWmsLayerInfos::legendUrlFormat

WMS layer legend URL format.

Definition at line 67 of file qgswmslayerinfos.h.

◆ maxScale

double QgsWmsLayerInfos::maxScale = -1.0

WMS layer maximum scale (if negative, no maximum scale is defined)

Definition at line 76 of file qgswmslayerinfos.h.

◆ metadataUrls

QList<QgsMapLayerServerProperties::MetadataUrl> QgsWmsLayerInfos::metadataUrls

WMS layer metadata URLs.

Definition at line 91 of file qgswmslayerinfos.h.

◆ minScale

double QgsWmsLayerInfos::minScale = -1.0

WMS layer minimum scale (if negative, no maximum scale is defined)

Definition at line 79 of file qgswmslayerinfos.h.

◆ name

QString QgsWmsLayerInfos::name

WMS layer name.

Definition at line 43 of file qgswmslayerinfos.h.

◆ queryable

bool QgsWmsLayerInfos::queryable = false

WMS layer is queryable.

Definition at line 70 of file qgswmslayerinfos.h.

◆ styles

QStringList QgsWmsLayerInfos::styles

WMS layer styles.

Definition at line 61 of file qgswmslayerinfos.h.

◆ title

QString QgsWmsLayerInfos::title

WMS layer title.

Definition at line 46 of file qgswmslayerinfos.h.

◆ type

Qgis::LayerType QgsWmsLayerInfos::type

QGIS layer type.

Definition at line 94 of file qgswmslayerinfos.h.

◆ wgs84BoundingRect

QgsRectangle QgsWmsLayerInfos::wgs84BoundingRect

WMS layer WGS84 bounding rectangle (can be empty)

Definition at line 55 of file qgswmslayerinfos.h.


The documentation for this class was generated from the following files: