QgsServerProjectUtils Namespace Reference

The QgsServerProjectUtils namespace provides a way to retrieve specific entries from a QgsProject. More...

Functions
SERVER_EXPORT QString	owsServiceAbstract (const QgsProject &project)
	Returns the owsService abstract defined in project. More...
SERVER_EXPORT QString	owsServiceAccessConstraints (const QgsProject &project)
	Returns the owsService access constraints defined in project. More...
SERVER_EXPORT bool	owsServiceCapabilities (const QgsProject &project)
	Returns if owsService capabilities are enabled. More...
SERVER_EXPORT QString	owsServiceContactMail (const QgsProject &project)
	Returns the owsService contact mail defined in project. More...
SERVER_EXPORT QString	owsServiceContactOrganization (const QgsProject &project)
	Returns the owsService contact organization defined in project. More...
SERVER_EXPORT QString	owsServiceContactPerson (const QgsProject &project)
	Returns the owsService contact person defined in project. More...
SERVER_EXPORT QString	owsServiceContactPhone (const QgsProject &project)
	Returns the owsService contact phone defined in project. More...
SERVER_EXPORT QString	owsServiceContactPosition (const QgsProject &project)
	Returns the owsService contact position defined in project. More...
SERVER_EXPORT QString	owsServiceFees (const QgsProject &project)
	Returns the owsService fees defined in project. More...
SERVER_EXPORT QStringList	owsServiceKeywords (const QgsProject &project)
	Returns the owsService keywords defined in project. More...
SERVER_EXPORT QString	owsServiceOnlineResource (const QgsProject &project)
	Returns the owsService online resource defined in project. More...
SERVER_EXPORT QString	owsServiceTitle (const QgsProject &project)
	Returns the owsService title defined in project. More...
SERVER_EXPORT QStringList	wcsLayerIds (const QgsProject &project)
	Returns the Layer ids list defined in a QGIS project as published in WCS. More...
SERVER_EXPORT QString	wcsServiceUrl (const QgsProject &project)
	Returns the WCS service url defined in a QGIS project. More...
SERVER_EXPORT QStringList	wfsLayerIds (const QgsProject &project)
	Returns the Layer ids list defined in a QGIS project as published in WFS. More...
SERVER_EXPORT int	wfsLayerPrecision (const QgsProject &project, const QString &layerId)
	Returns the Layer precision defined in a QGIS project for the WFS GetFeature. More...
SERVER_EXPORT QString	wfsServiceUrl (const QgsProject &project)
	Returns the WFS service url defined in a QGIS project. More...
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. More...
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. More...
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. More...
SERVER_EXPORT double	wmsDefaultMapUnitsPerMm (const QgsProject &project)
	Returns the default number of map units per millimeters in case of the scale is not given. More...
SERVER_EXPORT QgsRectangle	wmsExtent (const QgsProject &project)
	Returns the WMS Extent restriction. More...
SERVER_EXPORT bool	wmsFeatureInfoAddWktGeometry (const QgsProject &project)
	Returns if the geometry is displayed as Well Known Text in GetFeatureInfo request. More...
SERVER_EXPORT QString	wmsFeatureInfoDocumentElement (const QgsProject &project)
	Returns the document element name for XML GetFeatureInfo request. More...
SERVER_EXPORT QString	wmsFeatureInfoDocumentElementNs (const QgsProject &project)
	Returns the document element namespace for XML GetFeatureInfo request. More...
SERVER_EXPORT QHash< QString, QString >	wmsFeatureInfoLayerAliasMap (const QgsProject &project)
	Returns the mapping between layer name and wms layer name for GetFeatureInfo request. More...
SERVER_EXPORT int	wmsFeatureInfoPrecision (const QgsProject &project)
	Returns the geometry precision for GetFeatureInfo request. More...
SERVER_EXPORT QString	wmsFeatureInfoSchema (const QgsProject &project)
	Returns the schema URL for XML GetFeatureInfo request. More...
SERVER_EXPORT bool	wmsFeatureInfoSegmentizeWktGeometry (const QgsProject &project)
	Returns if the geometry has to be segmentize in GetFeatureInfo request. More...
SERVER_EXPORT int	wmsImageQuality (const QgsProject &project)
	Returns the quality for WMS images defined in a QGIS project. More...
SERVER_EXPORT bool	wmsInfoFormatSia2045 (const QgsProject &project)
	Returns if the info format is SIA20145. More...
SERVER_EXPORT bool	wmsInspireActivate (const QgsProject &project)
	Returns if Inspire is activated. More...
SERVER_EXPORT QString	wmsInspireLanguage (const QgsProject &project)
	Returns the Inspire language. More...
SERVER_EXPORT QString	wmsInspireMetadataDate (const QgsProject &project)
	Returns the Inspire metadata date. More...
SERVER_EXPORT QString	wmsInspireMetadataUrl (const QgsProject &project)
	Returns the Inspire metadata URL. More...
SERVER_EXPORT QString	wmsInspireMetadataUrlType (const QgsProject &project)
	Returns the Inspire metadata URL type. More...
SERVER_EXPORT QString	wmsInspireTemporalReference (const QgsProject &project)
	Returns the Inspire temporal reference. More...
SERVER_EXPORT int	wmsMaxAtlasFeatures (const QgsProject &project)
	Returns the maximum number of atlas features which can be printed in a request. More...
SERVER_EXPORT int	wmsMaxHeight (const QgsProject &project)
	Returns the maximum height for WMS images defined in a QGIS project. More...
SERVER_EXPORT int	wmsMaxWidth (const QgsProject &project)
	Returns the maximum width for WMS images defined in a QGIS project. More...
SERVER_EXPORT QStringList	wmsOutputCrsList (const QgsProject &project)
	Returns the WMS output CRS list. More...
SERVER_EXPORT QStringList	wmsRestrictedComposers (const QgsProject &project)
	Returns the restricted composer list. More...
SERVER_EXPORT QStringList	wmsRestrictedLayers (const QgsProject &project)
	Returns the restricted layer name list. More...
SERVER_EXPORT QString	wmsRootName (const QgsProject &project)
	Returns the WMS root layer name defined in a QGIS project. More...
SERVER_EXPORT QString	wmsServiceUrl (const QgsProject &project)
	Returns the WMS service url defined in a QGIS project. More...
SERVER_EXPORT int	wmsTileBuffer (const QgsProject &project)
	Returns the tile buffer in pixels for WMS images defined in a QGIS project. More...
SERVER_EXPORT bool	wmsUseLayerIds (const QgsProject &project)
	Returns if layer ids are used as name in WMS. More...
SERVER_EXPORT QString	wmtsServiceUrl (const QgsProject &project)
	Returns the WMTS service url defined in a QGIS project. More...

Detailed Description

The QgsServerProjectUtils namespace provides a way to retrieve specific entries from a QgsProject.

Since

QGIS 3.0

Function Documentation

owsServiceAbstract()

QString QgsServerProjectUtils::owsServiceAbstract

(

const QgsProject &

project

)

Returns the owsService abstract defined in project.

Parameters

project

the QGIS project

Returns

the owsService abstract if defined in project.

Definition at line 31 of file qgsserverprojectutils.cpp.

owsServiceAccessConstraints()

QString QgsServerProjectUtils::owsServiceAccessConstraints

(

const QgsProject &

project

)

Returns the owsService access constraints defined in project.

Parameters

project

the QGIS project

Returns

the owsService access constraints if defined in project.

Definition at line 89 of file qgsserverprojectutils.cpp.

owsServiceCapabilities()

bool QgsServerProjectUtils::owsServiceCapabilities

(

const QgsProject &

project

)

Returns if owsService capabilities are enabled.

Parameters

project

the QGIS project

Returns

if owsService capabilities are enabled.

Definition at line 21 of file qgsserverprojectutils.cpp.

owsServiceContactMail()

QString QgsServerProjectUtils::owsServiceContactMail

(

const QgsProject &

project

)

Returns the owsService contact mail defined in project.

Parameters

project

the QGIS project

Returns

the owsService contact mail if defined in project.

Definition at line 74 of file qgsserverprojectutils.cpp.

owsServiceContactOrganization()

QString QgsServerProjectUtils::owsServiceContactOrganization

(

const QgsProject &

project

)

Returns the owsService contact organization defined in project.

Parameters

project

the QGIS project

Returns

the owsService contact organization if defined in project.

Definition at line 59 of file qgsserverprojectutils.cpp.

owsServiceContactPerson()

QString QgsServerProjectUtils::owsServiceContactPerson

(

const QgsProject &

project

)

Returns the owsService contact person defined in project.

Parameters

project

the QGIS project

Returns

the owsService contact person if defined in project.

Definition at line 69 of file qgsserverprojectutils.cpp.

owsServiceContactPhone()

QString QgsServerProjectUtils::owsServiceContactPhone

(

const QgsProject &

project

)

Returns the owsService contact phone defined in project.

Parameters

project

the QGIS project

Returns

the owsService contact phone if defined in project.

Definition at line 79 of file qgsserverprojectutils.cpp.

owsServiceContactPosition()

QString QgsServerProjectUtils::owsServiceContactPosition

(

const QgsProject &

project

)

Returns the owsService contact position defined in project.

Parameters

project

the QGIS project

Returns

the owsService contact position if defined in project.

Definition at line 64 of file qgsserverprojectutils.cpp.

owsServiceFees()

QString QgsServerProjectUtils::owsServiceFees

(

const QgsProject &

project

)

Returns the owsService fees defined in project.

Parameters

project

the QGIS project

Returns

the owsService fees if defined in project.

Definition at line 84 of file qgsserverprojectutils.cpp.

owsServiceKeywords()

QStringList QgsServerProjectUtils::owsServiceKeywords

(

const QgsProject &

project

)

Returns the owsService keywords defined in project.

Parameters

project

the QGIS project

Returns

the owsService keywords if defined in project.

Definition at line 36 of file qgsserverprojectutils.cpp.

owsServiceOnlineResource()

QString QgsServerProjectUtils::owsServiceOnlineResource

(

const QgsProject &

project

)

Returns the owsService online resource defined in project.

Parameters

project

the QGIS project

Returns

the owsService online resource if defined in project.

Definition at line 54 of file qgsserverprojectutils.cpp.

owsServiceTitle()

QString QgsServerProjectUtils::owsServiceTitle

(

const QgsProject &

project

)

Returns the owsService title defined in project.

Parameters

project

the QGIS project

Returns

the owsService title if defined in project.

Definition at line 26 of file qgsserverprojectutils.cpp.

wcsLayerIds()

QStringList QgsServerProjectUtils::wcsLayerIds

(

const QgsProject &

project

)

Returns the Layer ids list defined in a QGIS project as published in WCS.

Parameters

project

the QGIS project

Returns

the Layer ids list.

Definition at line 346 of file qgsserverprojectutils.cpp.

wcsServiceUrl()

QString QgsServerProjectUtils::wcsServiceUrl

(

const QgsProject &

project

)

Returns the WCS service url defined in a QGIS project.

Parameters

project

the QGIS project

Returns

url if defined in project, an empty string otherwise.

Definition at line 341 of file qgsserverprojectutils.cpp.

wfsLayerIds()

QStringList QgsServerProjectUtils::wfsLayerIds

(

const QgsProject &

project

)

Returns the Layer ids list defined in a QGIS project as published in WFS.

Parameters

project

the QGIS project

Returns

the Layer ids list.

Definition at line 316 of file qgsserverprojectutils.cpp.

wfsLayerPrecision()

int QgsServerProjectUtils::wfsLayerPrecision	(	const QgsProject &	project,
		const QString &	layerId
	)

Returns the Layer precision defined in a QGIS project for the WFS GetFeature.

Parameters

project	the QGIS project
layerId	the layer id in the project

Returns

the layer precision for WFS GetFeature.

Definition at line 321 of file qgsserverprojectutils.cpp.

wfsServiceUrl()

QString QgsServerProjectUtils::wfsServiceUrl

(

const QgsProject &

project

)

Returns the WFS service url defined in a QGIS project.

Parameters

project

the QGIS project

Returns

url if defined in project, an empty string otherwise.

Definition at line 311 of file qgsserverprojectutils.cpp.

wfstDeleteLayerIds()

QStringList QgsServerProjectUtils::wfstDeleteLayerIds

(

const QgsProject &

project

)

Returns the Layer ids list defined in a QGIS project as published as WFS-T with delete capabilities.

Parameters

project

the QGIS project

Returns

the Layer ids list.

Definition at line 336 of file qgsserverprojectutils.cpp.

wfstInsertLayerIds()

QStringList QgsServerProjectUtils::wfstInsertLayerIds

(

const QgsProject &

project

)

Returns the Layer ids list defined in a QGIS project as published as WFS-T with insert capabilities.

Parameters

project

the QGIS project

Returns

the Layer ids list.

Definition at line 331 of file qgsserverprojectutils.cpp.

wfstUpdateLayerIds()

QStringList QgsServerProjectUtils::wfstUpdateLayerIds

(

const QgsProject &

project

)

Returns the Layer ids list defined in a QGIS project as published as WFS-T with update capabilities.

Parameters

project

the QGIS project

Returns

the Layer ids list.

Definition at line 326 of file qgsserverprojectutils.cpp.

wmsDefaultMapUnitsPerMm()

double QgsServerProjectUtils::wmsDefaultMapUnitsPerMm

(

const QgsProject &

project

)

Returns the default number of map units per millimeters in case of the scale is not given.

Parameters

project

the QGIS project

Returns

the default number of map units per millimeter

Since

QGIS 3.4

Definition at line 124 of file qgsserverprojectutils.cpp.

wmsExtent()

QgsRectangle QgsServerProjectUtils::wmsExtent

(

const QgsProject &

project

)

Returns the WMS Extent restriction.

Parameters

project

the QGIS project

Returns

the WMS Extent restriction.

Definition at line 295 of file qgsserverprojectutils.cpp.

wmsFeatureInfoAddWktGeometry()

bool QgsServerProjectUtils::wmsFeatureInfoAddWktGeometry

(

const QgsProject &

project

)

Returns if the geometry is displayed as Well Known Text in GetFeatureInfo request.

Parameters

project

the QGIS project

Returns

if the geometry is displayed as Well Known Text in GetFeatureInfo request.

Definition at line 137 of file qgsserverprojectutils.cpp.

wmsFeatureInfoDocumentElement()

QString QgsServerProjectUtils::wmsFeatureInfoDocumentElement

(

const QgsProject &

project

)

Returns the document element name for XML GetFeatureInfo request.

Parameters

project

the QGIS project

Returns

the document element name for XML GetFeatureInfo request.

Definition at line 158 of file qgsserverprojectutils.cpp.

wmsFeatureInfoDocumentElementNs()

QString QgsServerProjectUtils::wmsFeatureInfoDocumentElementNs

(

const QgsProject &

project

)

Returns the document element namespace for XML GetFeatureInfo request.

Parameters

project

the QGIS project

Returns

the document element namespace for XML GetFeatureInfo request.

Definition at line 163 of file qgsserverprojectutils.cpp.

wmsFeatureInfoLayerAliasMap()

QHash< QString, QString > QgsServerProjectUtils::wmsFeatureInfoLayerAliasMap

(

const QgsProject &

project

)

Returns the mapping between layer name and wms layer name for GetFeatureInfo request.

Parameters

project

the QGIS project

Returns

the mapping between layer name and wms layer name for GetFeatureInfo request.

Definition at line 173 of file qgsserverprojectutils.cpp.

wmsFeatureInfoPrecision()

int QgsServerProjectUtils::wmsFeatureInfoPrecision

(

const QgsProject &

project

)

Returns the geometry precision for GetFeatureInfo request.

Parameters

project

the QGIS project

Returns

the geometry precision for GetFeatureInfo request.

Definition at line 153 of file qgsserverprojectutils.cpp.

wmsFeatureInfoSchema()

QString QgsServerProjectUtils::wmsFeatureInfoSchema

(

const QgsProject &

project

)

Returns the schema URL for XML GetFeatureInfo request.

Parameters

project

the QGIS project

Returns

the schema URL for XML GetFeatureInfo request.

Definition at line 168 of file qgsserverprojectutils.cpp.

wmsFeatureInfoSegmentizeWktGeometry()

bool QgsServerProjectUtils::wmsFeatureInfoSegmentizeWktGeometry

(

const QgsProject &

project

)

Returns if the geometry has to be segmentize in GetFeatureInfo request.

Parameters

project

the QGIS project

Returns

if the geometry has to be segmentize in GetFeatureInfo request.

Definition at line 145 of file qgsserverprojectutils.cpp.

wmsImageQuality()

int QgsServerProjectUtils::wmsImageQuality

(

const QgsProject &

project

)

Returns the quality for WMS images defined in a QGIS project.

Parameters

project

the QGIS project

Returns

quality if defined in project, -1 otherwise.

Definition at line 109 of file qgsserverprojectutils.cpp.

wmsInfoFormatSia2045()

bool QgsServerProjectUtils::wmsInfoFormatSia2045

(

const QgsProject &

project

)

Returns if the info format is SIA20145.

Parameters

project

the QGIS project

Returns

if the info format is SIA20145.

Definition at line 129 of file qgsserverprojectutils.cpp.

wmsInspireActivate()

bool QgsServerProjectUtils::wmsInspireActivate

(

const QgsProject &

project

)

Returns if Inspire is activated.

Parameters

project

the QGIS project

Returns

if Inspire is activated.

Definition at line 200 of file qgsserverprojectutils.cpp.

wmsInspireLanguage()

QString QgsServerProjectUtils::wmsInspireLanguage

(

const QgsProject &

project

)

Returns the Inspire language.

Parameters

project

the QGIS project

Returns

the Inspire language if defined in project.

Definition at line 205 of file qgsserverprojectutils.cpp.

wmsInspireMetadataDate()

QString QgsServerProjectUtils::wmsInspireMetadataDate

(

const QgsProject &

project

)

Returns the Inspire metadata date.

Parameters

project

the QGIS project

Returns

the Inspire metadata date if defined in project.

Definition at line 225 of file qgsserverprojectutils.cpp.

wmsInspireMetadataUrl()

QString QgsServerProjectUtils::wmsInspireMetadataUrl

(

const QgsProject &

project

)

Returns the Inspire metadata URL.

Parameters

project

the QGIS project

Returns

the Inspire metadata URL if defined in project.

Definition at line 210 of file qgsserverprojectutils.cpp.

wmsInspireMetadataUrlType()

QString QgsServerProjectUtils::wmsInspireMetadataUrlType

(

const QgsProject &

project

)

Returns the Inspire metadata URL type.

Parameters

project

the QGIS project

Returns

the Inspire metadata URL type if defined in project.

Definition at line 215 of file qgsserverprojectutils.cpp.

wmsInspireTemporalReference()

QString QgsServerProjectUtils::wmsInspireTemporalReference

(

const QgsProject &

project

)

Returns the Inspire temporal reference.

Parameters

project

the QGIS project

Returns

the Inspire temporal reference if defined in project.

Definition at line 220 of file qgsserverprojectutils.cpp.

wmsMaxAtlasFeatures()

int QgsServerProjectUtils::wmsMaxAtlasFeatures

(

const QgsProject &

project

)

Returns the maximum number of atlas features which can be printed in a request.

Parameters

project

the QGIS project

Returns

the number of atlas features

Definition at line 119 of file qgsserverprojectutils.cpp.

wmsMaxHeight()

int QgsServerProjectUtils::wmsMaxHeight

(

const QgsProject &

project

)

Returns the maximum height for WMS images defined in a QGIS project.

Parameters

project

the QGIS project

Returns

height if defined in project, -1 otherwise.

Definition at line 99 of file qgsserverprojectutils.cpp.

wmsMaxWidth()

int QgsServerProjectUtils::wmsMaxWidth

(

const QgsProject &

project

)

Returns the maximum width for WMS images defined in a QGIS project.

Parameters

project

the QGIS project

Returns

width if defined in project, -1 otherwise.

Definition at line 94 of file qgsserverprojectutils.cpp.

wmsOutputCrsList()

QStringList QgsServerProjectUtils::wmsOutputCrsList

(

const QgsProject &

project

)

Returns the WMS output CRS list.

Parameters

project

the QGIS project

Returns

the WMS output CRS list.

Definition at line 235 of file qgsserverprojectutils.cpp.

wmsRestrictedComposers()

QStringList QgsServerProjectUtils::wmsRestrictedComposers

(

const QgsProject &

project

)

Returns the restricted composer list.

Parameters

project

the QGIS project

Returns

the restricted composer list if defined in project.

Definition at line 230 of file qgsserverprojectutils.cpp.

wmsRestrictedLayers()

QStringList QgsServerProjectUtils::wmsRestrictedLayers

(

const QgsProject &

project

)

Returns the restricted layer name list.

Parameters

project

the QGIS project

Returns

the restricted layer name list if defined in project.

Definition at line 290 of file qgsserverprojectutils.cpp.

wmsRootName()

QString QgsServerProjectUtils::wmsRootName

(

const QgsProject &

project

)

Returns the WMS root layer name defined in a QGIS project.

Parameters

project

the QGIS project

Returns

root layer name if defined in project, an empty string otherwise.

Definition at line 285 of file qgsserverprojectutils.cpp.

wmsServiceUrl()

QString QgsServerProjectUtils::wmsServiceUrl

(

const QgsProject &

project

)

Returns the WMS service url defined in a QGIS project.

Parameters

project

the QGIS project

Returns

url if defined in project, an empty string otherwise.

Definition at line 280 of file qgsserverprojectutils.cpp.

wmsTileBuffer()

int QgsServerProjectUtils::wmsTileBuffer

(

const QgsProject &

project

)

Returns the tile buffer in pixels for WMS images defined in a QGIS project.

Parameters

project

the QGIS project

Returns

tile buffer if defined in project, 0 otherwise.

Since

QGIS 3.10

Definition at line 114 of file qgsserverprojectutils.cpp.

wmsUseLayerIds()

bool QgsServerProjectUtils::wmsUseLayerIds

(

const QgsProject &

project

)

Returns if layer ids are used as name in WMS.

Parameters

project

the QGIS project

Returns

if layer ids are used as name.

Definition at line 104 of file qgsserverprojectutils.cpp.

wmtsServiceUrl()

QString QgsServerProjectUtils::wmtsServiceUrl

(

const QgsProject &

project

)

Returns the WMTS service url defined in a QGIS project.

Parameters

project

the QGIS project

Returns

url if defined in project, an empty string otherwise.

Since

QGIS 3.4

Definition at line 351 of file qgsserverprojectutils.cpp.