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

Functions
SERVER_EXPORT double	ceilWithPrecision (double number, int places)
	Returns a double greater than number to the specified number of places. More...

SERVER_EXPORT double	floorWithPrecision (double number, int places)
	Returns a double less than number to the specified number of places. More...

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	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 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

double QgsServerProjectUtils::ceilWithPrecision	(	double	number,
		int	places
	)

Returns a double greater than number to the specified number of places.

Since: QGIS 3.10.1

Definition at line 21 of file qgsserverprojectutils.cpp.

double QgsServerProjectUtils::floorWithPrecision	(	double	number,
		int	places
	)

Returns a double less than number to the specified number of places.

Since: QGIS 3.10.1

Definition at line 27 of file qgsserverprojectutils.cpp.

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 43 of file qgsserverprojectutils.cpp.

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 101 of file qgsserverprojectutils.cpp.

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 33 of file qgsserverprojectutils.cpp.

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 86 of file qgsserverprojectutils.cpp.

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 71 of file qgsserverprojectutils.cpp.

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 81 of file qgsserverprojectutils.cpp.

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 91 of file qgsserverprojectutils.cpp.

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 76 of file qgsserverprojectutils.cpp.

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 96 of file qgsserverprojectutils.cpp.

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 48 of file qgsserverprojectutils.cpp.

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 66 of file qgsserverprojectutils.cpp.

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 38 of file qgsserverprojectutils.cpp.

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 348 of file qgsserverprojectutils.cpp.

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 343 of file qgsserverprojectutils.cpp.

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 318 of file qgsserverprojectutils.cpp.

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 323 of file qgsserverprojectutils.cpp.

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 313 of file qgsserverprojectutils.cpp.

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 338 of file qgsserverprojectutils.cpp.

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 333 of file qgsserverprojectutils.cpp.

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 328 of file qgsserverprojectutils.cpp.

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 126 of file qgsserverprojectutils.cpp.

QgsRectangle QgsServerProjectUtils::wmsExtent ( const QgsProject & project )

Returns the WMS Extent restriction.

Parameters

project the QGIS project

Returns: the WMS Extent restriction.

Definition at line 297 of file qgsserverprojectutils.cpp.

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 139 of file qgsserverprojectutils.cpp.

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 160 of file qgsserverprojectutils.cpp.

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 165 of file qgsserverprojectutils.cpp.

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 175 of file qgsserverprojectutils.cpp.

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 155 of file qgsserverprojectutils.cpp.

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 170 of file qgsserverprojectutils.cpp.

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 147 of file qgsserverprojectutils.cpp.

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 121 of file qgsserverprojectutils.cpp.

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 131 of file qgsserverprojectutils.cpp.

bool QgsServerProjectUtils::wmsInspireActivate ( const QgsProject & project )

Returns if Inspire is activated.

Parameters

project the QGIS project

Returns: if Inspire is activated.

Definition at line 202 of file qgsserverprojectutils.cpp.

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 207 of file qgsserverprojectutils.cpp.

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 227 of file qgsserverprojectutils.cpp.

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 212 of file qgsserverprojectutils.cpp.

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 217 of file qgsserverprojectutils.cpp.

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 222 of file qgsserverprojectutils.cpp.

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 111 of file qgsserverprojectutils.cpp.

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 106 of file qgsserverprojectutils.cpp.

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 237 of file qgsserverprojectutils.cpp.

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 232 of file qgsserverprojectutils.cpp.

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 292 of file qgsserverprojectutils.cpp.

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 287 of file qgsserverprojectutils.cpp.

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 282 of file qgsserverprojectutils.cpp.

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 116 of file qgsserverprojectutils.cpp.

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 353 of file qgsserverprojectutils.cpp.

Functions

Detailed Description

Function Documentation