QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
QgsWms::QgsWmsParameter Class Reference
server library

WMS parameter received from the client. More...

#include <qgswmsparameters.h>

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

Public Types

enum  Name {
  UNKNOWN , BOXSPACE , CRS , SRS ,
  WIDTH , HEIGHT , BBOX , ICONLABELSPACE ,
  IMAGE_QUALITY , ITEMFONTFAMILY , ITEMFONTBOLD , ITEMFONTITALIC ,
  ITEMFONTSIZE , ITEMFONTCOLOR , LAYER , LAYERFONTFAMILY ,
  LAYERFONTBOLD , LAYERFONTITALIC , LAYERFONTSIZE , LAYERFONTCOLOR ,
  LAYERTITLE , LAYERS , LAYERSPACE , LAYERTITLESPACE ,
  QUERY_LAYERS , FEATURE_COUNT , SHOWFEATURECOUNT , STYLE ,
  STYLES , SYMBOLSPACE , SYMBOLHEIGHT , SYMBOLWIDTH ,
  OPACITIES , SLD , SLD_BODY , FI_POLYGON_TOLERANCE ,
  FI_LINE_TOLERANCE , FI_POINT_TOLERANCE , FILTER , FILTER_GEOM ,
  FORMAT , INFO_FORMAT , I , J ,
  X , Y , RULE , RULELABEL ,
  SCALE , SELECTION , HIGHLIGHT_GEOM , HIGHLIGHT_SYMBOL ,
  HIGHLIGHT_LABELSTRING , HIGHLIGHT_LABELFONT , HIGHLIGHT_LABELSIZE , HIGHLIGHT_LABELWEIGHT ,
  HIGHLIGHT_LABELCOLOR , HIGHLIGHT_LABELBUFFERCOLOR , HIGHLIGHT_LABELBUFFERSIZE , HIGHLIGHT_LABEL_ROTATION ,
  HIGHLIGHT_LABEL_DISTANCE , HIGHLIGHT_LABEL_HORIZONTAL_ALIGNMENT , HIGHLIGHT_LABEL_VERTICAL_ALIGNMENT , WMS_PRECISION ,
  TRANSPARENT , BGCOLOR , DPI , TEMPLATE ,
  EXTENT , ROTATION , GRID_INTERVAL_X , GRID_INTERVAL_Y ,
  WITH_GEOMETRY , WITH_MAPTIP , WMTVER , ATLAS_PK ,
  FORMAT_OPTIONS , SRCWIDTH , SRCHEIGHT , TILED
}
 Available parameters for WMS requests. More...
 

Public Member Functions

 QgsWmsParameter (const QgsWmsParameter::Name name=QgsWmsParameter::UNKNOWN, const QVariant::Type type=QVariant::String, const QVariant defaultValue=QVariant(""))
 Constructor for QgsWmsParameter. More...
 
virtual ~QgsWmsParameter () override=default
 Default destructor for QgsWmsParameter. More...
 
bool isValid () const override
 Returns true if the parameter is valid, false otherwise. More...
 
QString loadUrl () const
 Loads the data associated to the parameter converted into an url. More...
 
QString name () const
 Returns the name of the parameter. More...
 
void raiseError () const
 Raises an error in case of an invalid conversion. More...
 
QColor toColor () const
 Converts the parameter into a color. More...
 
QList< QColor > toColorList (const char delimiter=',') const
 Converts the parameter into a list of colors. More...
 
double toDouble () const
 Converts the parameter into a double. More...
 
QList< double > toDoubleList (const char delimiter=',') const
 Converts the parameter into a list of doubles. More...
 
QList< QgsGeometry > toGeomList (const char delimiter=',') const
 Converts the parameter into a list of geometries. More...
 
int toInt () const
 Converts the parameter into an integer. More...
 
QList< int > toIntList (const char delimiter=',') const
 Converts the parameter into a list of integers. More...
 
QgsRectangle toRectangle () const
 Converts the parameter into a rectangle. More...
 
QStringList toStyleList (const char delimiter=',') const
 Converts the parameter into a list of strings and keeps empty parts Default style value is an empty string. More...
 
QUrl toUrl () const
 Converts the parameter into an url. More...
 
- Public Member Functions inherited from QgsServerParameterDefinition
 QgsServerParameterDefinition (const QVariant::Type type=QVariant::String, const QVariant defaultValue=QVariant(""))
 Constructor for QgsServerParameterDefinition. More...
 
virtual ~QgsServerParameterDefinition ()=default
 Default destructor for QgsServerParameterDefinition. More...
 
virtual bool isValid () const
 Returns true if the parameter is valid, false otherwise. More...
 
QString loadUrl (bool &ok) const
 Loads the data associated to the parameter converted into an url. More...
 
bool toBool () const
 Converts the parameter into a boolean. More...
 
QColor toColor (bool &ok) const
 Converts the parameter into a color. More...
 
QList< QColor > toColorList (bool &ok, char delimiter=',') const
 Converts the parameter into a list of colors. More...
 
double toDouble (bool &ok) const
 Converts the parameter into a double. More...
 
QList< double > toDoubleList (bool &ok, char delimiter=',') const
 Converts the parameter into a list of doubles. More...
 
QStringList toExpressionList () const
 Converts the parameter into a list of QGIS expressions. More...
 
QList< QgsGeometry > toGeomList (bool &ok, char delimiter=',') const
 Converts the parameter into a list of geometries. More...
 
int toInt (bool &ok) const
 Converts the parameter into an integer. More...
 
QList< int > toIntList (bool &ok, char delimiter=',') const
 Converts the parameter into a list of integers. More...
 
QStringList toOgcFilterList () const
 Converts the parameter into a list of OGC filters. More...
 
QgsRectangle toRectangle (bool &ok) const
 Converts the parameter into a rectangle. More...
 
QString toString (bool defaultValue=false) const
 Converts the parameter into a string. More...
 
QStringList toStringList (char delimiter=',', bool skipEmptyParts=true) const
 Converts the parameter into a list of strings. More...
 
QUrl toUrl (bool &ok) const
 Converts the parameter into an url. More...
 
QString typeName () const
 Returns the type of the parameter as a string. More...
 

Static Public Member Functions

static QString name (const QgsWmsParameter::Name)
 Converts a parameter's name into its string representation. More...
 
static QgsWmsParameter::Name name (const QString &name)
 Converts a string into a parameter's name (UNKNOWN in case of an invalid string). More...
 
- Static Public Member Functions inherited from QgsServerParameterDefinition
static void raiseError (const QString &msg)
 Raises an exception in case of an invalid parameters. More...
 

Public Attributes

int mMapId = -1
 Map id for prefixed parameters (e.g. "0" for "map0:LAYERS" in GetPrint requests) More...
 
QgsWmsParameter::Name mName
 
- Public Attributes inherited from QgsServerParameterDefinition
QVariant mDefaultValue
 
QVariant::Type mType
 
QVariant mValue
 

Detailed Description

WMS parameter received from the client.

Since
QGIS 3.4

Definition at line 102 of file qgswmsparameters.h.

Member Enumeration Documentation

◆ Name

enum QgsWms::QgsWmsParameter::Name

Available parameters for WMS requests.

Enumerator
UNKNOWN 
BOXSPACE 
CRS 
SRS 
WIDTH 
HEIGHT 
BBOX 
ICONLABELSPACE 
IMAGE_QUALITY 
ITEMFONTFAMILY 
ITEMFONTBOLD 
ITEMFONTITALIC 
ITEMFONTSIZE 
ITEMFONTCOLOR 
LAYER 
LAYERFONTFAMILY 
LAYERFONTBOLD 
LAYERFONTITALIC 
LAYERFONTSIZE 
LAYERFONTCOLOR 
LAYERTITLE 
LAYERS 
LAYERSPACE 
LAYERTITLESPACE 
QUERY_LAYERS 
FEATURE_COUNT 
SHOWFEATURECOUNT 
STYLE 
STYLES 
SYMBOLSPACE 
SYMBOLHEIGHT 
SYMBOLWIDTH 
OPACITIES 
SLD 
SLD_BODY 
FI_POLYGON_TOLERANCE 
FI_LINE_TOLERANCE 
FI_POINT_TOLERANCE 
FILTER 
FILTER_GEOM 
FORMAT 
INFO_FORMAT 
I 
J 
X 
Y 
RULE 
RULELABEL 
SCALE 
SELECTION 
HIGHLIGHT_GEOM 
HIGHLIGHT_SYMBOL 
HIGHLIGHT_LABELSTRING 
HIGHLIGHT_LABELFONT 
HIGHLIGHT_LABELSIZE 
HIGHLIGHT_LABELWEIGHT 
HIGHLIGHT_LABELCOLOR 
HIGHLIGHT_LABELBUFFERCOLOR 
HIGHLIGHT_LABELBUFFERSIZE 
HIGHLIGHT_LABEL_ROTATION 
HIGHLIGHT_LABEL_DISTANCE 
HIGHLIGHT_LABEL_HORIZONTAL_ALIGNMENT 
HIGHLIGHT_LABEL_VERTICAL_ALIGNMENT 
WMS_PRECISION 
TRANSPARENT 
BGCOLOR 
DPI 
TEMPLATE 
EXTENT 
ROTATION 
GRID_INTERVAL_X 
GRID_INTERVAL_Y 
WITH_GEOMETRY 
WITH_MAPTIP 
WMTVER 
ATLAS_PK 
FORMAT_OPTIONS 
SRCWIDTH 
SRCHEIGHT 
TILED 

Definition at line 108 of file qgswmsparameters.h.

Constructor & Destructor Documentation

◆ QgsWmsParameter()

QgsWms::QgsWmsParameter::QgsWmsParameter ( const QgsWmsParameter::Name  name = QgsWmsParameter::UNKNOWN,
const QVariant::Type  type = QVariant::String,
const QVariant  defaultValue = QVariant( "" ) 
)

Constructor for QgsWmsParameter.

Parameters
nameName of the WMS parameter
typeType of the parameter
defaultValueDefault value of the parameter

Definition at line 32 of file qgswmsparameters.cpp.

◆ ~QgsWmsParameter()

virtual QgsWms::QgsWmsParameter::~QgsWmsParameter ( )
overridevirtualdefault

Default destructor for QgsWmsParameter.

Member Function Documentation

◆ isValid()

bool QgsWms::QgsWmsParameter::isValid ( ) const
overridevirtual

Returns true if the parameter is valid, false otherwise.

Reimplemented from QgsServerParameterDefinition.

Definition at line 40 of file qgswmsparameters.cpp.

◆ loadUrl()

QString QgsWms::QgsWmsParameter::loadUrl ( ) const

Loads the data associated to the parameter converted into an url.

Returns
The content loaded
Exceptions
QgsBadRequestExceptionInvalid parameter exception
Since
QGIS 3.4

Definition at line 97 of file qgswmsparameters.cpp.

◆ name() [1/3]

QString QgsWms::QgsWmsParameter::name ( ) const

Returns the name of the parameter.

Since
QGIS 3.8

Definition at line 195 of file qgswmsparameters.cpp.

◆ name() [2/3]

QString QgsWms::QgsWmsParameter::name ( const QgsWmsParameter::Name  name)
static

Converts a parameter's name into its string representation.

Definition at line 200 of file qgswmsparameters.cpp.

◆ name() [3/3]

QgsWmsParameter::Name QgsWms::QgsWmsParameter::name ( const QString &  name)
static

Converts a string into a parameter's name (UNKNOWN in case of an invalid string).

Definition at line 206 of file qgswmsparameters.cpp.

◆ raiseError()

void QgsWms::QgsWmsParameter::raiseError ( ) const

Raises an error in case of an invalid conversion.

Exceptions
QgsBadRequestExceptionInvalid parameter exception

Definition at line 45 of file qgswmsparameters.cpp.

◆ toColor()

QColor QgsWms::QgsWmsParameter::toColor ( ) const

Converts the parameter into a color.

Returns
A color
Exceptions
QgsBadRequestExceptionInvalid parameter exception

Definition at line 127 of file qgswmsparameters.cpp.

◆ toColorList()

QList< QColor > QgsWms::QgsWmsParameter::toColorList ( const char  delimiter = ',') const

Converts the parameter into a list of colors.

Parameters
delimiterThe character delimiting string colors
Returns
A list of colors
Exceptions
QgsBadRequestExceptionInvalid parameter exception

Definition at line 140 of file qgswmsparameters.cpp.

◆ toDouble()

double QgsWms::QgsWmsParameter::toDouble ( ) const

Converts the parameter into a double.

Returns
A double
Exceptions
QgsBadRequestExceptionInvalid parameter exception

Definition at line 182 of file qgswmsparameters.cpp.

◆ toDoubleList()

QList< double > QgsWms::QgsWmsParameter::toDoubleList ( const char  delimiter = ',') const

Converts the parameter into a list of doubles.

Parameters
delimiterThe character delimiting string doubles
Returns
A list of doubles
Exceptions
QgsBadRequestExceptionInvalid parameter exception

Definition at line 168 of file qgswmsparameters.cpp.

◆ toGeomList()

QList< QgsGeometry > QgsWms::QgsWmsParameter::toGeomList ( const char  delimiter = ',') const

Converts the parameter into a list of geometries.

Parameters
delimiterThe character delimiting string geometries
Returns
A list of geometries
Exceptions
QgsBadRequestExceptionInvalid parameter exception

Definition at line 56 of file qgswmsparameters.cpp.

◆ toInt()

int QgsWms::QgsWmsParameter::toInt ( ) const

Converts the parameter into an integer.

Returns
An integer
Exceptions
QgsBadRequestExceptionInvalid parameter exception

Definition at line 84 of file qgswmsparameters.cpp.

◆ toIntList()

QList< int > QgsWms::QgsWmsParameter::toIntList ( const char  delimiter = ',') const

Converts the parameter into a list of integers.

Parameters
delimiterThe character delimiting string integers
Returns
A list of integers
Exceptions
QgsBadRequestExceptionInvalid parameter exception

Definition at line 154 of file qgswmsparameters.cpp.

◆ toRectangle()

QgsRectangle QgsWms::QgsWmsParameter::toRectangle ( ) const

Converts the parameter into a rectangle.

Returns
A rectangle
Exceptions
QgsBadRequestExceptionInvalid parameter exception

Definition at line 70 of file qgswmsparameters.cpp.

◆ toStyleList()

QStringList QgsWms::QgsWmsParameter::toStyleList ( const char  delimiter = ',') const

Converts the parameter into a list of strings and keeps empty parts Default style value is an empty string.

Parameters
delimiterThe character used for delimiting
Returns
A list of strings
Since
QGIS 3.8

Definition at line 51 of file qgswmsparameters.cpp.

◆ toUrl()

QUrl QgsWms::QgsWmsParameter::toUrl ( ) const

Converts the parameter into an url.

Returns
An url
Exceptions
QgsBadRequestExceptionInvalid parameter exception
Since
QGIS 3.4

Definition at line 114 of file qgswmsparameters.cpp.

Member Data Documentation

◆ mMapId

int QgsWms::QgsWmsParameter::mMapId = -1

Map id for prefixed parameters (e.g. "0" for "map0:LAYERS" in GetPrint requests)

Definition at line 324 of file qgswmsparameters.h.

◆ mName

QgsWmsParameter::Name QgsWms::QgsWmsParameter::mName

Definition at line 321 of file qgswmsparameters.h.

The documentation for this class was generated from the following files:
Generated on Sat Oct 22 2022 16:10:47 for QGIS API Documentation by doxygen 1.9.4