QGIS API Documentation  3.23.0-Master (dd0cd13a00)
Public Types | Public Member Functions | Static Public Member Functions | List of all members
QgsWms::QgsWmsParameters Class Reference

Provides an interface to retrieve and manipulate WMS parameters received from the client. More...

#include <qgswmsparameters.h>

Inheritance diagram for QgsWms::QgsWmsParameters:
Inheritance graph
[legend]

Public Types

enum  DxfFormatOption {
  SCALE , MODE , LAYERATTRIBUTES , USE_TITLE_AS_LAYERNAME ,
  CODEC , NO_MTEXT , FORCE_2D
}
 Options for DXF format. More...
 
enum  Format {
  NONE , JPG , PNG , SVG ,
  PDF , TEXT , XML , HTML ,
  GML , JSON
}
 Output format for the response. More...
 

Public Member Functions

 QgsWmsParameters ()
 Constructor for WMS parameters with default values only. More...
 
 QgsWmsParameters (const QgsServerParameters &parameters)
 Constructor for WMS parameters with specific values. More...
 
virtual ~QgsWmsParameters () override=default
 
QStringList allLayersNickname () const
 Returns nickname of layers found in LAYER and LAYERS parameters. More...
 
QStringList allStyles () const
 Returns styles found in STYLE and STYLES parameters. More...
 
QStringList atlasPk () const
 Returns the ATLAS_PK parameter. More...
 
QString backgroundColor () const
 Returns BGCOLOR parameter or an empty string if not defined. More...
 
QColor backgroundColorAsColor () const
 Returns BGCOLOR parameter as a QColor or its default value if not defined. More...
 
QString bbox () const
 Returns BBOX if defined or an empty string. More...
 
QgsRectangle bboxAsRectangle () const
 Returns BBOX as a rectangle if defined and valid. More...
 
QString boxSpace () const
 Returns BOXSPACE parameter or an empty string if not defined. More...
 
double boxSpaceAsDouble () const
 Returns BOXSPACE as a double or its default value if not defined. More...
 
QgsWmsParametersComposerMap composerMapParameters (int mapId) const
 Returns the requested parameters for a composer map parameter. More...
 
QString composerTemplate () const
 Returns TEMPLATE parameter or an empty string if not defined. More...
 
QString crs () const
 Returns CRS or an empty string if none is defined. More...
 
QMap< QString, QString > dimensionValues () const
 Returns the dimensions parameter. More...
 
QString dpi () const
 Returns DPI parameter or an empty string if not defined. More...
 
double dpiAsDouble () const
 Returns DPI parameter as an int or its default value if not defined. More...
 
void dump () const
 Dumps parameters. More...
 
QString dxfCodec () const
 Returns the DXF CODEC parameter. More...
 
QMap< DxfFormatOption, QString > dxfFormatOptions () const
 Returns a map of DXF options defined within FORMAT_OPTIONS parameter. More...
 
QStringList dxfLayerAttributes () const
 Returns the DXF LAYERATTRIBUTES parameter. More...
 
QgsDxfExport::SymbologyExport dxfMode () const
 Returns the DXF MODE parameter. More...
 
double dxfScale () const
 Returns the DXF SCALE parameter. More...
 
bool dxfUseLayerTitleAsName () const
 Returns the DXF USE_TITLE_AS_LAYERNAME parameter. More...
 
QList< QgsWmsParametersExternalLayerexternalLayersParameters () const
 Returns parameters for each external layer. More...
 
QString externalWMSUri (const QString &id) const
 Returns the external WMS uri. More...
 
QString featureCount () const
 Returns FEATURE_COUNT parameter or an empty string if none is defined. More...
 
int featureCountAsInt () const
 Returns FEATURE_COUNT as an integer. More...
 
QString filterGeom () const
 Returns the filter geometry found in FILTER_GEOM parameter. More...
 
QStringList filters () const
 Returns the list of filters found in FILTER parameter. More...
 
Format format () const
 Returns format. More...
 
QString formatAsString () const
 Returns FORMAT parameter as a string. More...
 
QString height () const
 Returns HEIGHT parameter or an empty string if not defined. More...
 
int heightAsInt () const
 Returns HEIGHT parameter as an int or its default value if not defined. More...
 
QStringList highlightGeom () const
 Returns HIGHLIGHT_GEOM as a list of string in WKT. More...
 
QList< QgsGeometryhighlightGeomAsGeom () const
 Returns HIGHLIGHT_GEOM as a list of geometries. More...
 
QStringList highlightLabelBufferColor () const
 Returns HIGHLIGHT_LABELBUFFERCOLOR as a list of string. More...
 
QList< QColor > highlightLabelBufferColorAsColor () const
 Returns HIGHLIGHT_LABELBUFFERCOLOR as a list of colors. More...
 
QStringList highlightLabelBufferSize () const
 Returns HIGHLIGHT_LABELBUFFERSIZE. More...
 
QList< double > highlightLabelBufferSizeAsFloat () const
 Returns HIGHLIGHT_LABELBUFFERSIZE as a list of float. More...
 
QStringList highlightLabelColor () const
 Returns HIGHLIGHT_LABELCOLOR as a list of string. More...
 
QList< QColor > highlightLabelColorAsColor () const
 Returns HIGHLIGHT_LABELCOLOR as a list of color. More...
 
QStringList highlightLabelFont () const
 Returns HIGHLIGHT_LABELFONT. More...
 
QStringList highlightLabelSize () const
 Returns HIGHLIGHT_LABELSIZE as a list of string. More...
 
QList< int > highlightLabelSizeAsInt () const
 Returns HIGHLIGHT_LABELSIZE as a list of int An exception is raised if an invalid size is found. More...
 
QStringList highlightLabelString () const
 Returns HIGHLIGHT_LABELSTRING as a list of string. More...
 
QStringList highlightLabelWeight () const
 Returns HIGHLIGHT_LABELWEIGHT as a list of string. More...
 
QList< int > highlightLabelWeightAsInt () const
 Returns HIGHLIGHT_LABELWEIGHT as a list of int. More...
 
QList< QgsWmsParametersHighlightLayerhighlightLayersParameters () const
 Returns parameters for each highlight layer. More...
 
QStringList highlightSymbol () const
 Returns HIGHLIGHT_SYMBOL as a list of string. More...
 
QString i () const
 Returns I parameter or an empty string if not defined. More...
 
int iAsInt () const
 Returns I parameter as an int or its default value if not defined. More...
 
QString iconLabelSpace () const
 Returns ICONLABELSPACE parameter or an empty string if not defined. More...
 
double iconLabelSpaceAsDouble () const
 Returns ICONLABELSPACE as a double or its default value if not defined. More...
 
QString imageQuality () const
 Returns IMAGE_QUALITY parameter or an empty string if not defined. More...
 
int imageQualityAsInt () const
 Returns IMAGE_QUALITY parameter as an integer. More...
 
Format infoFormat () const
 Returns infoFormat. More...
 
QString infoFormatAsString () const
 Returns INFO_FORMAT parameter as a string. More...
 
bool infoFormatIsImage () const
 Checks if INFO_FORMAT parameter is one of the image formats (PNG, JPG). More...
 
int infoFormatVersion () const
 Returns the infoFormat version for GML. More...
 
bool isForce2D () const
 
QFont itemFont () const
 Returns the item font (built thanks to the ITEMFONTFAMILY, ITEMFONTSIZE, ITEMFONTBOLD, ... More...
 
QString itemFontBold () const
 Returns ITEMFONTBOLD parameter or an empty string if not defined. More...
 
bool itemFontBoldAsBool () const
 Returns ITEMFONTBOLD as a boolean or its default value if not defined. More...
 
QString itemFontColor () const
 Returns ITEMFONTCOLOR parameter or an empty string if not defined. More...
 
QColor itemFontColorAsColor () const
 Returns ITEMFONTCOLOR as a color. More...
 
QString itemFontFamily () const
 Returns ITEMFONTFAMILY parameter or an empty string if not defined. More...
 
QString itemFontItalic () const
 Returns ITEMFONTITALIC parameter or an empty string if not defined. More...
 
bool itemFontItalicAsBool () const
 Returns ITEMFONTITALIC as a boolean or its default value if not defined. More...
 
QString itemFontSize () const
 Returns ITEMFONTSIZE parameter or an empty string if not defined. More...
 
double itemFontSizeAsDouble () const
 Returns ITEMFONTSIZE as a double. More...
 
QString j () const
 Returns J parameter or an empty string if not defined. More...
 
int jAsInt () const
 Returns J parameter as an int or its default value if not defined. More...
 
QFont layerFont () const
 Returns the layer font (built thanks to the LAYERFONTFAMILY, LAYERFONTSIZE, LAYERFONTBOLD, ... More...
 
QString layerFontBold () const
 Returns LAYERFONTBOLD parameter or an empty string if not defined. More...
 
bool layerFontBoldAsBool () const
 Returns LAYERFONTBOLD as a boolean or its default value if not defined. More...
 
QString layerFontColor () const
 Returns LAYERFONTCOLOR parameter or an empty string if not defined. More...
 
QColor layerFontColorAsColor () const
 Returns LAYERFONTCOLOR as a color or its defined value if not defined. More...
 
QString layerFontFamily () const
 Returns LAYERFONTFAMILY parameter or an empty string if not defined. More...
 
QString layerFontItalic () const
 Returns LAYERFONTITALIC parameter or an empty string if not defined. More...
 
bool layerFontItalicAsBool () const
 Returns LAYERFONTITALIC as a boolean or its default value if not defined. More...
 
QString layerFontSize () const
 Returns LAYERFONTSIZE parameter or an empty string if not defined. More...
 
double layerFontSizeAsDouble () const
 Returns LAYERFONTSIZE as a double. More...
 
QString layerSpace () const
 Returns LAYERSPACE parameter or an empty string if not defined. More...
 
double layerSpaceAsDouble () const
 Returns LAYERSPACE as a double or its default value if not defined. More...
 
QList< QgsWmsParametersLayerlayersParameters () const
 Returns parameters for each layer found in LAYER/LAYERS. More...
 
QString layerTitle () const
 Returns LAYERTITLE parameter or an empty string if not defined. More...
 
bool layerTitleAsBool () const
 Returns LAYERTITLE as a bool or its default value if not defined. More...
 
QString layerTitleSpace () const
 Returns LAYERTITLESPACE parameter or an empty string if not defined. More...
 
double layerTitleSpaceAsDouble () const
 Returns LAYERTITLESPACE as a double. More...
 
QString layoutParameter (const QString &id, bool &ok) const
 Returns a layout parameter thanks to its id. More...
 
QgsLegendSettings legendSettings () const
 Returns legend settings. More...
 
QString lineTolerance () const
 Returns FI_LINE_TOLERANCE parameter or an empty string if not defined. More...
 
int lineToleranceAsInt () const
 Returns FI_LINE_TOLERANCE parameter as an integer. More...
 
bool noMText () const
 
QStringList opacities () const
 Returns the list of opacities found in OPACITIES parameter. More...
 
QList< int > opacitiesAsInt () const
 Returns the list of opacities found in OPACITIES parameter as integers. More...
 
QgsWmsParameter operator[] (QgsWmsParameter::Name name) const
 Returns the parameter corresponding to name. More...
 
QString pointTolerance () const
 Returns FI_POINT_TOLERANCE parameter or an empty string if not defined. More...
 
int pointToleranceAsInt () const
 Returns FI_POINT_TOLERANCE parameter as an integer. More...
 
QString polygonTolerance () const
 Returns FI_POLYGON_TOLERANCE parameter or an empty string if not defined. More...
 
int polygonToleranceAsInt () const
 Returns FI_POLYGON_TOLERANCE parameter as an integer. More...
 
QStringList queryLayersNickname () const
 Returns nickname of layers found in QUERY_LAYERS parameter. More...
 
QString request () const override
 Returns REQUEST parameter as a string or an empty string if not defined. More...
 
QString rule () const
 Returns RULE parameter or an empty string if none is defined. More...
 
QString ruleLabel () const
 Returns RULELABEL parameter or an empty string if none is defined. More...
 
bool ruleLabelAsBool () const
 Returns RULELABEL as a bool. More...
 
QString scale () const
 Returns SCALE parameter or an empty string if none is defined. More...
 
double scaleAsDouble () const
 Returns SCALE as a double. More...
 
QStringList selections () const
 Returns the list of feature selection found in SELECTION parameter. More...
 
void set (QgsWmsParameter::Name name, const QVariant &value)
 Sets a parameter value thanks to its name. More...
 
QString showFeatureCount () const
 Returns SHOWFEATURECOUNT parameter or an empty string if none is defined. More...
 
bool showFeatureCountAsBool () const
 Returns SHOWFEATURECOUNT as a bool. More...
 
QString sldBody () const
 Returns SLD_body if defined or an empty string. More...
 
QString srcHeight () const
 Returns SRCHEIGHT parameter or an empty string if not defined. More...
 
int srcHeightAsInt () const
 Returns SRCHEIGHT parameter as an int or its default value if not defined. More...
 
QString srcWidth () const
 Returns SRCWIDTH parameter or an empty string if not defined. More...
 
int srcWidthAsInt () const
 Returns SRCWIDTH parameter as an int or its default value if not defined. More...
 
QString symbolHeight () const
 Returns SYMBOLHEIGHT parameter or an empty string if not defined. More...
 
double symbolHeightAsDouble () const
 Returns SYMBOLHEIGHT as a double or its default value if not defined. More...
 
QString symbolSpace () const
 Returns SYMBOLSPACE parameter or an empty string if not defined. More...
 
double symbolSpaceAsDouble () const
 Returns SYMBOLSPACE as a double or its default value if not defined. More...
 
QString symbolWidth () const
 Returns SYMBOLWIDTH parameter or an empty string if not defined. More...
 
double symbolWidthAsDouble () const
 Returns SYMBOLWIDTH as a double or its default value if not defined. More...
 
QString tiled () const
 Returns TILED parameter or an empty string if not defined. More...
 
bool tiledAsBool () const
 Returns TILED parameter as a boolean. More...
 
QString transparent () const
 Returns TRANSPARENT parameter or an empty string if not defined. More...
 
bool transparentAsBool () const
 Returns TRANSPARENT parameter as a bool or its default value if not defined. More...
 
QString version () const override
 Returns VERSION parameter as a string or an empty string if not defined. More...
 
QgsProjectVersion versionAsNumber () const
 Returns VERSION parameter if defined or its default value. More...
 
bool versionIsValid (const QString version) const
 Returns true if version is valid, false otherwise. More...
 
QString width () const
 Returns WIDTH parameter or an empty string if not defined. More...
 
int widthAsInt () const
 Returns WIDTH parameter as an int or its default value if not defined. More...
 
bool withGeometry () const
 Returns if the client wants the feature info response with geometry information. More...
 
bool withMapTip () const
 withMapTip More...
 
QString wmsPrecision () const
 Returns WMS_PRECISION parameter or an empty string if not defined. More...
 
int wmsPrecisionAsInt () const
 Returns WMS_PRECISION parameter as an int or its default value if not defined. More...
 
QString wmtver () const
 Returns WMTVER parameter or an empty string if not defined. More...
 
QString x () const
 Returns X parameter or an empty string if not defined. More...
 
int xAsInt () const
 Returns X parameter as an int or its default value if not defined. More...
 
QString y () const
 Returns Y parameter or an empty string if not defined. More...
 
int yAsInt () const
 Returns Y parameter as an int or its default value if not defined. More...
 
- Public Member Functions inherited from QgsServerParameters
 QgsServerParameters ()
 Constructor. More...
 
 QgsServerParameters (const QUrlQuery &query)
 Constructor. More...
 
virtual ~QgsServerParameters ()=default
 
void add (const QString &key, const QString &value)
 Adds a parameter. More...
 
void clear ()
 Removes all parameters. More...
 
QString fileName () const
 Returns FILE_NAME parameter as a string or an empty string if not defined. More...
 
void load (const QUrlQuery &query)
 Loads new parameters. More...
 
QString map () const
 Returns MAP parameter as a string or an empty string if not defined. More...
 
void remove (const QString &key)
 Removes a parameter. More...
 
void remove (QgsServerParameter::Name name)
 Removes a parameter. More...
 
QString service () const
 Returns SERVICE parameter as a string or an empty string if not defined. More...
 
QMap< QString, QString > toMap () const
 Returns all parameters in a map. More...
 
QUrlQuery urlQuery () const
 Returns a url query with underlying parameters. More...
 
QString value (const QString &key) const
 Returns the value of a parameter. More...
 

Static Public Member Functions

static QString formatAsString (Format format)
 Returns format parameter as a string. More...
 

Additional Inherited Members

- Protected Attributes inherited from QgsServerParameters
QMap< QString, QString > mUnmanagedParameters
 

Detailed Description

Provides an interface to retrieve and manipulate WMS parameters received from the client.

Since
QGIS 3.0

Definition at line 323 of file qgswmsparameters.h.

Member Enumeration Documentation

◆ DxfFormatOption

Options for DXF format.

Enumerator
SCALE 
MODE 
LAYERATTRIBUTES 
USE_TITLE_AS_LAYERNAME 
CODEC 
NO_MTEXT 
FORCE_2D 

Definition at line 346 of file qgswmsparameters.h.

◆ Format

Output format for the response.

Enumerator
NONE 
JPG 
PNG 
SVG 
PDF 
TEXT 
XML 
HTML 
GML 
JSON 

Definition at line 330 of file qgswmsparameters.h.

Constructor & Destructor Documentation

◆ QgsWmsParameters() [1/2]

QgsWms::QgsWmsParameters::QgsWmsParameters ( const QgsServerParameters parameters)

Constructor for WMS parameters with specific values.

Parameters
parametersMap of parameters where keys are parameters' names.

Definition at line 540 of file qgswmsparameters.cpp.

◆ QgsWmsParameters() [2/2]

QgsWms::QgsWmsParameters::QgsWmsParameters ( )

Constructor for WMS parameters with default values only.

Definition at line 214 of file qgswmsparameters.cpp.

◆ ~QgsWmsParameters()

virtual QgsWms::QgsWmsParameters::~QgsWmsParameters ( )
overridevirtualdefault

Member Function Documentation

◆ allLayersNickname()

QStringList QgsWms::QgsWmsParameters::allLayersNickname ( ) const

Returns nickname of layers found in LAYER and LAYERS parameters.

Returns
nickname of layers

Definition at line 1450 of file qgswmsparameters.cpp.

◆ allStyles()

QStringList QgsWms::QgsWmsParameters::allStyles ( ) const

Returns styles found in STYLE and STYLES parameters.

Returns
name of styles

Definition at line 1462 of file qgswmsparameters.cpp.

◆ atlasPk()

QStringList QgsWms::QgsWmsParameters::atlasPk ( ) const

Returns the ATLAS_PK parameter.

Returns
The ATLAS_PK parameter
Since
QGIS 3.6

Definition at line 1305 of file qgswmsparameters.cpp.

◆ backgroundColor()

QString QgsWms::QgsWmsParameters::backgroundColor ( ) const

Returns BGCOLOR parameter or an empty string if not defined.

Returns
BGCOLOR parameter

Definition at line 1690 of file qgswmsparameters.cpp.

◆ backgroundColorAsColor()

QColor QgsWms::QgsWmsParameters::backgroundColorAsColor ( ) const

Returns BGCOLOR parameter as a QColor or its default value if not defined.

An exception is raised if BGCOLOR is defined and cannot be converted.

Returns
background color parameter
Exceptions
QgsBadRequestException

Definition at line 1695 of file qgswmsparameters.cpp.

◆ bbox()

QString QgsWms::QgsWmsParameters::bbox ( ) const

Returns BBOX if defined or an empty string.

Returns
bbox parameter

Definition at line 700 of file qgswmsparameters.cpp.

◆ bboxAsRectangle()

QgsRectangle QgsWms::QgsWmsParameters::bboxAsRectangle ( ) const

Returns BBOX as a rectangle if defined and valid.

An exception is raised if the BBOX string cannot be converted into a rectangle.

Returns
bbox as rectangle
Exceptions
QgsBadRequestException

Definition at line 705 of file qgswmsparameters.cpp.

◆ boxSpace()

QString QgsWms::QgsWmsParameters::boxSpace ( ) const

Returns BOXSPACE parameter or an empty string if not defined.

Returns
BOXSPACE parameter or an empty string if not defined.

Definition at line 1028 of file qgswmsparameters.cpp.

◆ boxSpaceAsDouble()

double QgsWms::QgsWmsParameters::boxSpaceAsDouble ( ) const

Returns BOXSPACE as a double or its default value if not defined.

An exception is raised if an invalid parameter is found.

Returns
boxSpace
Exceptions
QgsBadRequestException

Definition at line 1033 of file qgswmsparameters.cpp.

◆ composerMapParameters()

QgsWmsParametersComposerMap QgsWms::QgsWmsParameters::composerMapParameters ( int  mapId) const

Returns the requested parameters for a composer map parameter.

An exception is raised if parameters are defined and cannot be converted like EXTENT, SCALE, ROTATION, GRID_INTERVAL_X and GRID_INTERVAL_Y.

Parameters
mapIdthe composer map id.
Returns
parameters for the composer map.
Exceptions
QgsBadRequestException

Definition at line 1705 of file qgswmsparameters.cpp.

◆ composerTemplate()

QString QgsWms::QgsWmsParameters::composerTemplate ( ) const

Returns TEMPLATE parameter or an empty string if not defined.

Returns
TEMPLATE parameter

Definition at line 1700 of file qgswmsparameters.cpp.

◆ crs()

QString QgsWms::QgsWmsParameters::crs ( ) const

Returns CRS or an empty string if none is defined.

Returns
crs parameter as string

Definition at line 677 of file qgswmsparameters.cpp.

◆ dimensionValues()

QMap< QString, QString > QgsWms::QgsWmsParameters::dimensionValues ( ) const

Returns the dimensions parameter.

Since
QGIS 3.10

Definition at line 2102 of file qgswmsparameters.cpp.

◆ dpi()

QString QgsWms::QgsWmsParameters::dpi ( ) const

Returns DPI parameter or an empty string if not defined.

Returns
DPI parameter

Definition at line 750 of file qgswmsparameters.cpp.

◆ dpiAsDouble()

double QgsWms::QgsWmsParameters::dpiAsDouble ( ) const

Returns DPI parameter as an int or its default value if not defined.

An exception is raised if DPI is defined and cannot be converted.

Returns
dpi parameter
Exceptions
QgsBadRequestException

Definition at line 755 of file qgswmsparameters.cpp.

◆ dump()

void QgsWms::QgsWmsParameters::dump ( ) const

Dumps parameters.

Definition at line 626 of file qgswmsparameters.cpp.

◆ dxfCodec()

QString QgsWms::QgsWmsParameters::dxfCodec ( ) const

Returns the DXF CODEC parameter.

Since
QGIS 3.8

Definition at line 2067 of file qgswmsparameters.cpp.

◆ dxfFormatOptions()

QMap< QgsWmsParameters::DxfFormatOption, QString > QgsWms::QgsWmsParameters::dxfFormatOptions ( ) const

Returns a map of DXF options defined within FORMAT_OPTIONS parameter.

Since
QGIS 3.8

Definition at line 2079 of file qgswmsparameters.cpp.

◆ dxfLayerAttributes()

QStringList QgsWms::QgsWmsParameters::dxfLayerAttributes ( ) const

Returns the DXF LAYERATTRIBUTES parameter.

Since
QGIS 3.8

Definition at line 2004 of file qgswmsparameters.cpp.

◆ dxfMode()

QgsDxfExport::SymbologyExport QgsWms::QgsWmsParameters::dxfMode ( ) const

Returns the DXF MODE parameter.

Since
QGIS 3.8

Definition at line 2043 of file qgswmsparameters.cpp.

◆ dxfScale()

double QgsWms::QgsWmsParameters::dxfScale ( ) const

Returns the DXF SCALE parameter.

Since
QGIS 3.8

Definition at line 2030 of file qgswmsparameters.cpp.

◆ dxfUseLayerTitleAsName()

bool QgsWms::QgsWmsParameters::dxfUseLayerTitleAsName ( ) const

Returns the DXF USE_TITLE_AS_LAYERNAME parameter.

Since
QGIS 3.8

Definition at line 2017 of file qgswmsparameters.cpp.

◆ externalLayersParameters()

QList< QgsWmsParametersExternalLayer > QgsWms::QgsWmsParameters::externalLayersParameters ( ) const

Returns parameters for each external layer.

Since
QGIS 3.8

Definition at line 1673 of file qgswmsparameters.cpp.

◆ externalWMSUri()

QString QgsWms::QgsWmsParameters::externalWMSUri ( const QString &  id) const

Returns the external WMS uri.

Parameters
idthe id of the external wms
Returns
uri string or an empty string if the external wms id does not exist

Definition at line 1921 of file qgswmsparameters.cpp.

◆ featureCount()

QString QgsWms::QgsWmsParameters::featureCount ( ) const

Returns FEATURE_COUNT parameter or an empty string if none is defined.

Returns
FEATURE_COUNT parameter or an empty string if none is defined

Definition at line 1018 of file qgswmsparameters.cpp.

◆ featureCountAsInt()

int QgsWms::QgsWmsParameters::featureCountAsInt ( ) const

Returns FEATURE_COUNT as an integer.

An exception is raised if an invalid parameter is found.

Returns
FeatureCount
Exceptions
QgsBadRequestException

Definition at line 1023 of file qgswmsparameters.cpp.

◆ filterGeom()

QString QgsWms::QgsWmsParameters::filterGeom ( ) const

Returns the filter geometry found in FILTER_GEOM parameter.

Returns
the filter geometry as Well Known Text.

Definition at line 1430 of file qgswmsparameters.cpp.

◆ filters()

QStringList QgsWms::QgsWmsParameters::filters ( ) const

Returns the list of filters found in FILTER parameter.

Returns
the list of filter

Definition at line 1385 of file qgswmsparameters.cpp.

◆ format()

QgsWmsParameters::Format QgsWms::QgsWmsParameters::format ( ) const

Returns format.

If the FORMAT parameter is not used, then the default value is PNG.

Returns
format

Definition at line 831 of file qgswmsparameters.cpp.

◆ formatAsString() [1/2]

QString QgsWms::QgsWmsParameters::formatAsString ( ) const

Returns FORMAT parameter as a string.

Returns
FORMAT parameter as string

Definition at line 820 of file qgswmsparameters.cpp.

◆ formatAsString() [2/2]

QString QgsWms::QgsWmsParameters::formatAsString ( const QgsWmsParameters::Format  format)
static

Returns format parameter as a string.

Since
QGIS 3.8

Definition at line 825 of file qgswmsparameters.cpp.

◆ height()

QString QgsWms::QgsWmsParameters::height ( ) const

Returns HEIGHT parameter or an empty string if not defined.

Returns
height parameter

Definition at line 710 of file qgswmsparameters.cpp.

◆ heightAsInt()

int QgsWms::QgsWmsParameters::heightAsInt ( ) const

Returns HEIGHT parameter as an int or its default value if not defined.

An exception is raised if HEIGHT is defined and cannot be converted.

Returns
height parameter
Exceptions
QgsBadRequestException

Definition at line 720 of file qgswmsparameters.cpp.

◆ highlightGeom()

QStringList QgsWms::QgsWmsParameters::highlightGeom ( ) const

Returns HIGHLIGHT_GEOM as a list of string in WKT.

Returns
highlight geometries

Definition at line 662 of file qgswmsparameters.cpp.

◆ highlightGeomAsGeom()

QList< QgsGeometry > QgsWms::QgsWmsParameters::highlightGeomAsGeom ( ) const

Returns HIGHLIGHT_GEOM as a list of geometries.

An exception is raised if an invalid geometry is found.

Returns
highlight geometries
Exceptions
QgsBadRequestException

Definition at line 667 of file qgswmsparameters.cpp.

◆ highlightLabelBufferColor()

QStringList QgsWms::QgsWmsParameters::highlightLabelBufferColor ( ) const

Returns HIGHLIGHT_LABELBUFFERCOLOR as a list of string.

Returns
highlight label buffer color

Definition at line 1350 of file qgswmsparameters.cpp.

◆ highlightLabelBufferColorAsColor()

QList< QColor > QgsWms::QgsWmsParameters::highlightLabelBufferColorAsColor ( ) const

Returns HIGHLIGHT_LABELBUFFERCOLOR as a list of colors.

An axception is raised if an invalid color is found.

Returns
highlight label buffer color
Exceptions
QgsBadRequestException

Definition at line 1355 of file qgswmsparameters.cpp.

◆ highlightLabelBufferSize()

QStringList QgsWms::QgsWmsParameters::highlightLabelBufferSize ( ) const

Returns HIGHLIGHT_LABELBUFFERSIZE.

Returns
highlight label buffer size

Definition at line 1360 of file qgswmsparameters.cpp.

◆ highlightLabelBufferSizeAsFloat()

QList< double > QgsWms::QgsWmsParameters::highlightLabelBufferSizeAsFloat ( ) const

Returns HIGHLIGHT_LABELBUFFERSIZE as a list of float.

An exception is raised if an invalid size is found.

Returns
highlight label buffer size
Exceptions
QgsBadRequestException

Definition at line 1365 of file qgswmsparameters.cpp.

◆ highlightLabelColor()

QStringList QgsWms::QgsWmsParameters::highlightLabelColor ( ) const

Returns HIGHLIGHT_LABELCOLOR as a list of string.

Returns
highlight label color

Definition at line 1325 of file qgswmsparameters.cpp.

◆ highlightLabelColorAsColor()

QList< QColor > QgsWms::QgsWmsParameters::highlightLabelColorAsColor ( ) const

Returns HIGHLIGHT_LABELCOLOR as a list of color.

An exception is raised if an invalid color is found.

Returns
highlight label color
Exceptions
QgsBadRequestException

Definition at line 1330 of file qgswmsparameters.cpp.

◆ highlightLabelFont()

QStringList QgsWms::QgsWmsParameters::highlightLabelFont ( ) const

Returns HIGHLIGHT_LABELFONT.

Returns
highlight label font

Definition at line 1345 of file qgswmsparameters.cpp.

◆ highlightLabelSize()

QStringList QgsWms::QgsWmsParameters::highlightLabelSize ( ) const

Returns HIGHLIGHT_LABELSIZE as a list of string.

Returns
highlight label size

Definition at line 1315 of file qgswmsparameters.cpp.

◆ highlightLabelSizeAsInt()

QList< int > QgsWms::QgsWmsParameters::highlightLabelSizeAsInt ( ) const

Returns HIGHLIGHT_LABELSIZE as a list of int An exception is raised if an invalid size is found.

Returns
highlight label size
Exceptions
QgsBadRequestException

Definition at line 1320 of file qgswmsparameters.cpp.

◆ highlightLabelString()

QStringList QgsWms::QgsWmsParameters::highlightLabelString ( ) const

Returns HIGHLIGHT_LABELSTRING as a list of string.

Returns
highlight label string

Definition at line 1310 of file qgswmsparameters.cpp.

◆ highlightLabelWeight()

QStringList QgsWms::QgsWmsParameters::highlightLabelWeight ( ) const

Returns HIGHLIGHT_LABELWEIGHT as a list of string.

Returns
highlight label weight

Definition at line 1335 of file qgswmsparameters.cpp.

◆ highlightLabelWeightAsInt()

QList< int > QgsWms::QgsWmsParameters::highlightLabelWeightAsInt ( ) const

Returns HIGHLIGHT_LABELWEIGHT as a list of int.

An exception is raised if an invalid weight is found.

Returns
highlight label weight
Exceptions
QgsBadRequestException

Definition at line 1340 of file qgswmsparameters.cpp.

◆ highlightLayersParameters()

QList< QgsWmsParametersHighlightLayer > QgsWms::QgsWmsParameters::highlightLayersParameters ( ) const

Returns parameters for each highlight layer.

Returns
parameters for each highlight layer

Definition at line 1625 of file qgswmsparameters.cpp.

◆ highlightSymbol()

QStringList QgsWms::QgsWmsParameters::highlightSymbol ( ) const

Returns HIGHLIGHT_SYMBOL as a list of string.

Returns
highlight sld symbols

Definition at line 672 of file qgswmsparameters.cpp.

◆ i()

QString QgsWms::QgsWmsParameters::i ( ) const

Returns I parameter or an empty string if not defined.

Returns
i parameter

Definition at line 913 of file qgswmsparameters.cpp.

◆ iAsInt()

int QgsWms::QgsWmsParameters::iAsInt ( ) const

Returns I parameter as an int or its default value if not defined.

An exception is raised if I is defined and cannot be converted.

Returns
i parameter
Exceptions
QgsBadRequestException

Definition at line 923 of file qgswmsparameters.cpp.

◆ iconLabelSpace()

QString QgsWms::QgsWmsParameters::iconLabelSpace ( ) const

Returns ICONLABELSPACE parameter or an empty string if not defined.

Returns
ICONLABELSPACE parameter or an empty string if not defined.

Definition at line 1088 of file qgswmsparameters.cpp.

◆ iconLabelSpaceAsDouble()

double QgsWms::QgsWmsParameters::iconLabelSpaceAsDouble ( ) const

Returns ICONLABELSPACE as a double or its default value if not defined.

An exception is raised if an invalid parameter is found.

Returns
iconLabelSpace
Exceptions
QgsBadRequestException

Definition at line 1093 of file qgswmsparameters.cpp.

◆ imageQuality()

QString QgsWms::QgsWmsParameters::imageQuality ( ) const

Returns IMAGE_QUALITY parameter or an empty string if not defined.

Since
QGIS 3.4

Definition at line 988 of file qgswmsparameters.cpp.

◆ imageQualityAsInt()

int QgsWms::QgsWmsParameters::imageQualityAsInt ( ) const

Returns IMAGE_QUALITY parameter as an integer.

Exceptions
QgsBadRequestException
Since
QGIS 3.4

Definition at line 993 of file qgswmsparameters.cpp.

◆ infoFormat()

QgsWmsParameters::Format QgsWms::QgsWmsParameters::infoFormat ( ) const

Returns infoFormat.

If the INFO_FORMAT parameter is not used, then the default value is text/plain.

Returns
infoFormat

Definition at line 876 of file qgswmsparameters.cpp.

◆ infoFormatAsString()

QString QgsWms::QgsWmsParameters::infoFormatAsString ( ) const

Returns INFO_FORMAT parameter as a string.

Returns
INFO_FORMAT parameter as string

Definition at line 866 of file qgswmsparameters.cpp.

◆ infoFormatIsImage()

bool QgsWms::QgsWmsParameters::infoFormatIsImage ( ) const

Checks if INFO_FORMAT parameter is one of the image formats (PNG, JPG).

Returns
true if the INFO_FORMAT is an image format

Definition at line 871 of file qgswmsparameters.cpp.

◆ infoFormatVersion()

int QgsWms::QgsWmsParameters::infoFormatVersion ( ) const

Returns the infoFormat version for GML.

If the INFO_FORMAT is not GML, then the default value is -1.

Returns
infoFormat version

Definition at line 901 of file qgswmsparameters.cpp.

◆ isForce2D()

bool QgsWms::QgsWmsParameters::isForce2D ( ) const
Returns
true if the FORCE_2D parameter is set and the DXF should be produced in 2D.
Since
QGIS 3.12

Definition at line 1524 of file qgswmsparameters.cpp.

◆ itemFont()

QFont QgsWms::QgsWmsParameters::itemFont ( ) const

Returns the item font (built thanks to the ITEMFONTFAMILY, ITEMFONTSIZE, ITEMFONTBOLD, ...

parameters).

Returns
itemFont

Definition at line 1234 of file qgswmsparameters.cpp.

◆ itemFontBold()

QString QgsWms::QgsWmsParameters::itemFontBold ( ) const

Returns ITEMFONTBOLD parameter or an empty string if not defined.

Returns
ITEMFONTBOLD parameter or an empty string if not defined.

Definition at line 1118 of file qgswmsparameters.cpp.

◆ itemFontBoldAsBool()

bool QgsWms::QgsWmsParameters::itemFontBoldAsBool ( ) const

Returns ITEMFONTBOLD as a boolean or its default value if not defined.

An exception is raised if an invalid parameter is found.

Returns
itemFontBold
Exceptions
QgsBadRequestException

Definition at line 1153 of file qgswmsparameters.cpp.

◆ itemFontColor()

QString QgsWms::QgsWmsParameters::itemFontColor ( ) const

Returns ITEMFONTCOLOR parameter or an empty string if not defined.

Returns
ITEMFONTCOLOR parameter or an empty string if not defined.

Definition at line 1208 of file qgswmsparameters.cpp.

◆ itemFontColorAsColor()

QColor QgsWms::QgsWmsParameters::itemFontColorAsColor ( ) const

Returns ITEMFONTCOLOR as a color.

An exception is raised if an invalid parameter is found.

Returns
itemFontColor
Exceptions
QgsBadRequestException

Definition at line 1213 of file qgswmsparameters.cpp.

◆ itemFontFamily()

QString QgsWms::QgsWmsParameters::itemFontFamily ( ) const

Returns ITEMFONTFAMILY parameter or an empty string if not defined.

Returns
ITEMFONTFAMILY parameter or an empty string if not defined.

Definition at line 1103 of file qgswmsparameters.cpp.

◆ itemFontItalic()

QString QgsWms::QgsWmsParameters::itemFontItalic ( ) const

Returns ITEMFONTITALIC parameter or an empty string if not defined.

Returns
ITEMFONTITALIC parameter or an empty string if not defined.

Definition at line 1168 of file qgswmsparameters.cpp.

◆ itemFontItalicAsBool()

bool QgsWms::QgsWmsParameters::itemFontItalicAsBool ( ) const

Returns ITEMFONTITALIC as a boolean or its default value if not defined.

An exception is raised if an invalid parameter is found.

Returns
itemFontItalic
Exceptions
QgsBadRequestException

Definition at line 1173 of file qgswmsparameters.cpp.

◆ itemFontSize()

QString QgsWms::QgsWmsParameters::itemFontSize ( ) const

Returns ITEMFONTSIZE parameter or an empty string if not defined.

Returns
ITEMFONTSIZE parameter or an empty string if not defined.

Definition at line 1198 of file qgswmsparameters.cpp.

◆ itemFontSizeAsDouble()

double QgsWms::QgsWmsParameters::itemFontSizeAsDouble ( ) const

Returns ITEMFONTSIZE as a double.

An exception is raised if an invalid parameter is found.

Returns
itemFontSize
Exceptions
QgsBadRequestException

Definition at line 1203 of file qgswmsparameters.cpp.

◆ j()

QString QgsWms::QgsWmsParameters::j ( ) const

Returns J parameter or an empty string if not defined.

Returns
j parameter

Definition at line 918 of file qgswmsparameters.cpp.

◆ jAsInt()

int QgsWms::QgsWmsParameters::jAsInt ( ) const

Returns J parameter as an int or its default value if not defined.

An exception is raised if J is defined and cannot be converted.

Returns
j parameter
Exceptions
QgsBadRequestException

Definition at line 928 of file qgswmsparameters.cpp.

◆ layerFont()

QFont QgsWms::QgsWmsParameters::layerFont ( ) const

Returns the layer font (built thanks to the LAYERFONTFAMILY, LAYERFONTSIZE, LAYERFONTBOLD, ...

parameters).

Returns
layerFont

Definition at line 1218 of file qgswmsparameters.cpp.

◆ layerFontBold()

QString QgsWms::QgsWmsParameters::layerFontBold ( ) const

Returns LAYERFONTBOLD parameter or an empty string if not defined.

Returns
LAYERFONTBOLD parameter or an empty string if not defined.

Definition at line 1108 of file qgswmsparameters.cpp.

◆ layerFontBoldAsBool()

bool QgsWms::QgsWmsParameters::layerFontBoldAsBool ( ) const

Returns LAYERFONTBOLD as a boolean or its default value if not defined.

An exception is raised if an invalid parameter is found.

Returns
layerFontBold
Exceptions
QgsBadRequestException

Definition at line 1113 of file qgswmsparameters.cpp.

◆ layerFontColor()

QString QgsWms::QgsWmsParameters::layerFontColor ( ) const

Returns LAYERFONTCOLOR parameter or an empty string if not defined.

Returns
LAYERFONTCOLOR parameter or an empty string if not defined.

Definition at line 1188 of file qgswmsparameters.cpp.

◆ layerFontColorAsColor()

QColor QgsWms::QgsWmsParameters::layerFontColorAsColor ( ) const

Returns LAYERFONTCOLOR as a color or its defined value if not defined.

An exception is raised if an invalid parameter is found.

Returns
layerFontColor
Exceptions
QgsBadRequestException

Definition at line 1193 of file qgswmsparameters.cpp.

◆ layerFontFamily()

QString QgsWms::QgsWmsParameters::layerFontFamily ( ) const

Returns LAYERFONTFAMILY parameter or an empty string if not defined.

Returns
LAYERFONTFAMILY parameter or an empty string if not defined.

Definition at line 1098 of file qgswmsparameters.cpp.

◆ layerFontItalic()

QString QgsWms::QgsWmsParameters::layerFontItalic ( ) const

Returns LAYERFONTITALIC parameter or an empty string if not defined.

Returns
LAYERFONTITALIC parameter or an empty string if not defined.

Definition at line 1158 of file qgswmsparameters.cpp.

◆ layerFontItalicAsBool()

bool QgsWms::QgsWmsParameters::layerFontItalicAsBool ( ) const

Returns LAYERFONTITALIC as a boolean or its default value if not defined.

An exception is raised if an invalid parameter is found.

Returns
layerFontItalic
Exceptions
QgsBadRequestException

Definition at line 1163 of file qgswmsparameters.cpp.

◆ layerFontSize()

QString QgsWms::QgsWmsParameters::layerFontSize ( ) const

Returns LAYERFONTSIZE parameter or an empty string if not defined.

Returns
LAYERFONTSIZE parameter or an empty string if not defined.

Definition at line 1178 of file qgswmsparameters.cpp.

◆ layerFontSizeAsDouble()

double QgsWms::QgsWmsParameters::layerFontSizeAsDouble ( ) const

Returns LAYERFONTSIZE as a double.

An exception is raised if an invalid parameter is found.

Returns
layerFontSize
Exceptions
QgsBadRequestException

Definition at line 1183 of file qgswmsparameters.cpp.

◆ layerSpace()

QString QgsWms::QgsWmsParameters::layerSpace ( ) const

Returns LAYERSPACE parameter or an empty string if not defined.

Returns
LAYERSPACE parameter or an empty string if not defined.

Definition at line 1038 of file qgswmsparameters.cpp.

◆ layerSpaceAsDouble()

double QgsWms::QgsWmsParameters::layerSpaceAsDouble ( ) const

Returns LAYERSPACE as a double or its default value if not defined.

An exception is raised if an invalid parameter is found.

Returns
layerSpace
Exceptions
QgsBadRequestException

Definition at line 1043 of file qgswmsparameters.cpp.

◆ layersParameters()

QList< QgsWmsParametersLayer > QgsWms::QgsWmsParameters::layersParameters ( ) const

Returns parameters for each layer found in LAYER/LAYERS.

Returns
layer parameters

Definition at line 1550 of file qgswmsparameters.cpp.

◆ layerTitle()

QString QgsWms::QgsWmsParameters::layerTitle ( ) const

Returns LAYERTITLE parameter or an empty string if not defined.

Returns
LAYERTITLE parameter or an empty string if not defined.

Definition at line 1251 of file qgswmsparameters.cpp.

◆ layerTitleAsBool()

bool QgsWms::QgsWmsParameters::layerTitleAsBool ( ) const

Returns LAYERTITLE as a bool or its default value if not defined.

An exception is raised if an invalid parameter is found.

Returns
layerTitle
Exceptions
QgsBadRequestException

Definition at line 1256 of file qgswmsparameters.cpp.

◆ layerTitleSpace()

QString QgsWms::QgsWmsParameters::layerTitleSpace ( ) const

Returns LAYERTITLESPACE parameter or an empty string if not defined.

Returns
LAYERTITLESPACE parameter or an empty string if not defined.

Definition at line 1048 of file qgswmsparameters.cpp.

◆ layerTitleSpaceAsDouble()

double QgsWms::QgsWmsParameters::layerTitleSpaceAsDouble ( ) const

Returns LAYERTITLESPACE as a double.

An exception is raised if an invalid parameter is found.

Returns
layerTitleSpace
Exceptions
QgsBadRequestException

Definition at line 1053 of file qgswmsparameters.cpp.

◆ layoutParameter()

QString QgsWms::QgsWmsParameters::layoutParameter ( const QString &  id,
bool &  ok 
) const

Returns a layout parameter thanks to its id.

Parameters
idParameter id
oktrue if the parameter is valid, false otherwise
Returns
The layout parameter
Since
QGIS 3.4

Definition at line 1291 of file qgswmsparameters.cpp.

◆ legendSettings()

QgsLegendSettings QgsWms::QgsWmsParameters::legendSettings ( ) const

Returns legend settings.

Returns
legend settings

Definition at line 1261 of file qgswmsparameters.cpp.

◆ lineTolerance()

QString QgsWms::QgsWmsParameters::lineTolerance ( ) const

Returns FI_LINE_TOLERANCE parameter or an empty string if not defined.

Since
QGIS 3.4

Definition at line 1128 of file qgswmsparameters.cpp.

◆ lineToleranceAsInt()

int QgsWms::QgsWmsParameters::lineToleranceAsInt ( ) const

Returns FI_LINE_TOLERANCE parameter as an integer.

Exceptions
QgsBadRequestException
Since
QGIS 3.4

Definition at line 1143 of file qgswmsparameters.cpp.

◆ noMText()

bool QgsWms::QgsWmsParameters::noMText ( ) const
Returns
true if the FORCE_MTEXT parameter is set and the DXF should be produced with MTEXT instead of TEXT.
Since
QGIS 3.12

Definition at line 1537 of file qgswmsparameters.cpp.

◆ opacities()

QStringList QgsWms::QgsWmsParameters::opacities ( ) const

Returns the list of opacities found in OPACITIES parameter.

Returns
the list of opacities in string

Definition at line 1440 of file qgswmsparameters.cpp.

◆ opacitiesAsInt()

QList< int > QgsWms::QgsWmsParameters::opacitiesAsInt ( ) const

Returns the list of opacities found in OPACITIES parameter as integers.

If an opacity cannot be converted into an integer, then an exception is raised

Returns
a list of opacities as integers
Exceptions
QgsBadRequestException

Definition at line 1445 of file qgswmsparameters.cpp.

◆ operator[]()

QgsWmsParameter QgsWms::QgsWmsParameters::operator[] ( QgsWmsParameter::Name  name) const

Returns the parameter corresponding to name.

Since
QGIS 3.8

Definition at line 556 of file qgswmsparameters.cpp.

◆ pointTolerance()

QString QgsWms::QgsWmsParameters::pointTolerance ( ) const

Returns FI_POINT_TOLERANCE parameter or an empty string if not defined.

Since
QGIS 3.4

Definition at line 1133 of file qgswmsparameters.cpp.

◆ pointToleranceAsInt()

int QgsWms::QgsWmsParameters::pointToleranceAsInt ( ) const

Returns FI_POINT_TOLERANCE parameter as an integer.

Exceptions
QgsBadRequestException
Since
QGIS 3.4

Definition at line 1148 of file qgswmsparameters.cpp.

◆ polygonTolerance()

QString QgsWms::QgsWmsParameters::polygonTolerance ( ) const

Returns FI_POLYGON_TOLERANCE parameter or an empty string if not defined.

Since
QGIS 3.4

Definition at line 1123 of file qgswmsparameters.cpp.

◆ polygonToleranceAsInt()

int QgsWms::QgsWmsParameters::polygonToleranceAsInt ( ) const

Returns FI_POLYGON_TOLERANCE parameter as an integer.

Exceptions
QgsBadRequestException
Since
QGIS 3.4

Definition at line 1138 of file qgswmsparameters.cpp.

◆ queryLayersNickname()

QStringList QgsWms::QgsWmsParameters::queryLayersNickname ( ) const

Returns nickname of layers found in QUERY_LAYERS parameter.

Returns
nickname of layers

Definition at line 1457 of file qgswmsparameters.cpp.

◆ request()

QString QgsWms::QgsWmsParameters::request ( ) const
overridevirtual

Returns REQUEST parameter as a string or an empty string if not defined.

Returns
request

Reimplemented from QgsServerParameters.

Definition at line 797 of file qgswmsparameters.cpp.

◆ rule()

QString QgsWms::QgsWmsParameters::rule ( ) const

Returns RULE parameter or an empty string if none is defined.

Returns
RULE parameter or an empty string if none is defined

Definition at line 953 of file qgswmsparameters.cpp.

◆ ruleLabel()

QString QgsWms::QgsWmsParameters::ruleLabel ( ) const

Returns RULELABEL parameter or an empty string if none is defined.

Returns
RULELABEL parameter or an empty string if none is defined

Definition at line 958 of file qgswmsparameters.cpp.

◆ ruleLabelAsBool()

bool QgsWms::QgsWmsParameters::ruleLabelAsBool ( ) const

Returns RULELABEL as a bool.

An exception is raised if an invalid parameter is found.

Returns
ruleLabel
Exceptions
QgsBadRequestException

Definition at line 963 of file qgswmsparameters.cpp.

◆ scale()

QString QgsWms::QgsWmsParameters::scale ( ) const

Returns SCALE parameter or an empty string if none is defined.

Returns
SCALE parameter or an empty string if none is defined

Definition at line 978 of file qgswmsparameters.cpp.

◆ scaleAsDouble()

double QgsWms::QgsWmsParameters::scaleAsDouble ( ) const

Returns SCALE as a double.

An exception is raised if an invalid parameter is found.

Returns
scale
Exceptions
QgsBadRequestException

Definition at line 983 of file qgswmsparameters.cpp.

◆ selections()

QStringList QgsWms::QgsWmsParameters::selections ( ) const

Returns the list of feature selection found in SELECTION parameter.

Returns
the list of selection

Definition at line 1435 of file qgswmsparameters.cpp.

◆ set()

void QgsWms::QgsWmsParameters::set ( QgsWmsParameter::Name  name,
const QVariant &  value 
)

Sets a parameter value thanks to its name.

Since
QGIS 3.8

Definition at line 561 of file qgswmsparameters.cpp.

◆ showFeatureCount()

QString QgsWms::QgsWmsParameters::showFeatureCount ( ) const

Returns SHOWFEATURECOUNT parameter or an empty string if none is defined.

Returns
SHOWFEATURECOUNT parameter or an empty string if none is defined

Definition at line 1008 of file qgswmsparameters.cpp.

◆ showFeatureCountAsBool()

bool QgsWms::QgsWmsParameters::showFeatureCountAsBool ( ) const

Returns SHOWFEATURECOUNT as a bool.

An exception is raised if an invalid parameter is found.

Returns
showFeatureCount
Exceptions
QgsBadRequestException

Definition at line 1013 of file qgswmsparameters.cpp.

◆ sldBody()

QString QgsWms::QgsWmsParameters::sldBody ( ) const

Returns SLD_body if defined or an empty string.

Returns
sld body

Definition at line 1380 of file qgswmsparameters.cpp.

◆ srcHeight()

QString QgsWms::QgsWmsParameters::srcHeight ( ) const

Returns SRCHEIGHT parameter or an empty string if not defined.

Returns
srcHeight parameter
Since
QGIS 3.8

Definition at line 730 of file qgswmsparameters.cpp.

◆ srcHeightAsInt()

int QgsWms::QgsWmsParameters::srcHeightAsInt ( ) const

Returns SRCHEIGHT parameter as an int or its default value if not defined.

An exception is raised if SRCHEIGHT is defined and cannot be converted.

Returns
srcHeight parameter
Exceptions
QgsBadRequestException
Since
QGIS 3.8

Definition at line 740 of file qgswmsparameters.cpp.

◆ srcWidth()

QString QgsWms::QgsWmsParameters::srcWidth ( ) const

Returns SRCWIDTH parameter or an empty string if not defined.

Returns
srcWidth parameter
Since
QGIS 3.8

Definition at line 735 of file qgswmsparameters.cpp.

◆ srcWidthAsInt()

int QgsWms::QgsWmsParameters::srcWidthAsInt ( ) const

Returns SRCWIDTH parameter as an int or its default value if not defined.

An exception is raised if SRCWIDTH is defined and cannot be converted.

Returns
srcWidth parameter
Exceptions
QgsBadRequestException
Since
QGIS 3.8

Definition at line 745 of file qgswmsparameters.cpp.

◆ symbolHeight()

QString QgsWms::QgsWmsParameters::symbolHeight ( ) const

Returns SYMBOLHEIGHT parameter or an empty string if not defined.

Returns
SYMBOLHEIGHT parameter or an empty string if not defined.

Definition at line 1068 of file qgswmsparameters.cpp.

◆ symbolHeightAsDouble()

double QgsWms::QgsWmsParameters::symbolHeightAsDouble ( ) const

Returns SYMBOLHEIGHT as a double or its default value if not defined.

An exception is raised if an invalid parameter is found.

Returns
symbolHeight
Exceptions
QgsBadRequestException

Definition at line 1073 of file qgswmsparameters.cpp.

◆ symbolSpace()

QString QgsWms::QgsWmsParameters::symbolSpace ( ) const

Returns SYMBOLSPACE parameter or an empty string if not defined.

Returns
SYMBOLSPACE parameter or an empty string if not defined.

Definition at line 1058 of file qgswmsparameters.cpp.

◆ symbolSpaceAsDouble()

double QgsWms::QgsWmsParameters::symbolSpaceAsDouble ( ) const

Returns SYMBOLSPACE as a double or its default value if not defined.

An exception is raised if an invalid parameter is found.

Returns
symbolSpace
Exceptions
QgsBadRequestException

Definition at line 1063 of file qgswmsparameters.cpp.

◆ symbolWidth()

QString QgsWms::QgsWmsParameters::symbolWidth ( ) const

Returns SYMBOLWIDTH parameter or an empty string if not defined.

Returns
SYMBOLWIDTH parameter or an empty string if not defined.

Definition at line 1078 of file qgswmsparameters.cpp.

◆ symbolWidthAsDouble()

double QgsWms::QgsWmsParameters::symbolWidthAsDouble ( ) const

Returns SYMBOLWIDTH as a double or its default value if not defined.

An exception is raised if an invalid parameter is found.

Returns
symbolWidth
Exceptions
QgsBadRequestException

Definition at line 1083 of file qgswmsparameters.cpp.

◆ tiled()

QString QgsWms::QgsWmsParameters::tiled ( ) const

Returns TILED parameter or an empty string if not defined.

Since
QGIS 3.10

Definition at line 998 of file qgswmsparameters.cpp.

◆ tiledAsBool()

bool QgsWms::QgsWmsParameters::tiledAsBool ( ) const

Returns TILED parameter as a boolean.

Exceptions
QgsBadRequestException
Since
QGIS 3.10

Definition at line 1003 of file qgswmsparameters.cpp.

◆ transparent()

QString QgsWms::QgsWmsParameters::transparent ( ) const

Returns TRANSPARENT parameter or an empty string if not defined.

Returns
TRANSPARENT parameter

Definition at line 968 of file qgswmsparameters.cpp.

◆ transparentAsBool()

bool QgsWms::QgsWmsParameters::transparentAsBool ( ) const

Returns TRANSPARENT parameter as a bool or its default value if not defined.

An exception is raised if TRANSPARENT is defined and cannot be converted.

Returns
transparent parameter
Exceptions
QgsBadRequestException

Definition at line 973 of file qgswmsparameters.cpp.

◆ version()

QString QgsWms::QgsWmsParameters::version ( ) const
overridevirtual

Returns VERSION parameter as a string or an empty string if not defined.

Returns
version

Reimplemented from QgsServerParameters.

Definition at line 760 of file qgswmsparameters.cpp.

◆ versionAsNumber()

QgsProjectVersion QgsWms::QgsWmsParameters::versionAsNumber ( ) const

Returns VERSION parameter if defined or its default value.

Returns
version

Definition at line 810 of file qgswmsparameters.cpp.

◆ versionIsValid()

bool QgsWms::QgsWmsParameters::versionIsValid ( const QString  version) const

Returns true if version is valid, false otherwise.

Since
QGIS 3.4

Definition at line 815 of file qgswmsparameters.cpp.

◆ width()

QString QgsWms::QgsWmsParameters::width ( ) const

Returns WIDTH parameter or an empty string if not defined.

Returns
width parameter

Definition at line 715 of file qgswmsparameters.cpp.

◆ widthAsInt()

int QgsWms::QgsWmsParameters::widthAsInt ( ) const

Returns WIDTH parameter as an int or its default value if not defined.

An exception is raised if WIDTH is defined and cannot be converted.

Returns
width parameter
Exceptions
QgsBadRequestException

Definition at line 725 of file qgswmsparameters.cpp.

◆ withGeometry()

bool QgsWms::QgsWmsParameters::withGeometry ( ) const

Returns if the client wants the feature info response with geometry information.

Returns
true if geometry information is requested for feature info response

Definition at line 1948 of file qgswmsparameters.cpp.

◆ withMapTip()

bool QgsWms::QgsWmsParameters::withMapTip ( ) const

withMapTip

Returns
true if maptip information is requested for feature info response

Definition at line 1953 of file qgswmsparameters.cpp.

◆ wmsPrecision()

QString QgsWms::QgsWmsParameters::wmsPrecision ( ) const

Returns WMS_PRECISION parameter or an empty string if not defined.

Returns
wms precision parameter

Definition at line 1370 of file qgswmsparameters.cpp.

◆ wmsPrecisionAsInt()

int QgsWms::QgsWmsParameters::wmsPrecisionAsInt ( ) const

Returns WMS_PRECISION parameter as an int or its default value if not defined.

An exception is raised if WMS_PRECISION is defined and cannot be converted.

Returns
wms precision parameter
Exceptions
QgsBadRequestException

Definition at line 1375 of file qgswmsparameters.cpp.

◆ wmtver()

QString QgsWms::QgsWmsParameters::wmtver ( ) const

Returns WMTVER parameter or an empty string if not defined.

Since
QGIS 3.4

Definition at line 1958 of file qgswmsparameters.cpp.

◆ x()

QString QgsWms::QgsWmsParameters::x ( ) const

Returns X parameter or an empty string if not defined.

Returns
x parameter

Definition at line 933 of file qgswmsparameters.cpp.

◆ xAsInt()

int QgsWms::QgsWmsParameters::xAsInt ( ) const

Returns X parameter as an int or its default value if not defined.

An exception is raised if X is defined and cannot be converted.

Returns
x parameter
Exceptions
QgsBadRequestException

Definition at line 943 of file qgswmsparameters.cpp.

◆ y()

QString QgsWms::QgsWmsParameters::y ( ) const

Returns Y parameter or an empty string if not defined.

Returns
y parameter

Definition at line 938 of file qgswmsparameters.cpp.

◆ yAsInt()

int QgsWms::QgsWmsParameters::yAsInt ( ) const

Returns Y parameter as an int or its default value if not defined.

An exception is raised if Y is defined and cannot be converted.

Returns
j parameter
Exceptions
QgsBadRequestException

Definition at line 948 of file qgswmsparameters.cpp.


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