QGIS API Documentation  3.16.0-Hannover (43b64b13f3)
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
QgsServerParameter Class Reference

Parameter common to all services (WMS, WFS, ...) More...

#include <qgsserverparameters.h>

Inheritance diagram for QgsServerParameter:
Inheritance graph
[legend]

Public Types

enum  Name {
  UNKNOWN, SERVICE, VERSION_SERVICE, REQUEST,
  MAP, FILE_NAME
}
 Parameter's name common to all services. More...
 

Public Member Functions

 QgsServerParameter (const QgsServerParameter::Name name=QgsServerParameter::UNKNOWN, const QVariant::Type type=QVariant::String, const QVariant defaultValue=QVariant(""))
 Constructor for QgsServerParameter. More...
 
void raiseError () const
 Raises an error in case of an invalid conversion. 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...
 
QList< QgsGeometrytoGeomList (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...
 
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 QgsServerParameter::Name name)
 Converts a parameter's name into its string representation. More...
 
static QgsServerParameter::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

QgsServerParameter::Name mName
 
- Public Attributes inherited from QgsServerParameterDefinition
QVariant mDefaultValue
 
QVariant::Type mType
 
QVariant mValue
 

Detailed Description

Parameter common to all services (WMS, WFS, ...)

Since
QGIS 3.4

Definition at line 175 of file qgsserverparameters.h.

Member Enumeration Documentation

◆ Name

Parameter's name common to all services.

Enumerator
UNKNOWN 
SERVICE 
VERSION_SERVICE 
REQUEST 
MAP 
FILE_NAME 

Definition at line 181 of file qgsserverparameters.h.

Constructor & Destructor Documentation

◆ QgsServerParameter()

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

Constructor for QgsServerParameter.

Parameters
nameThe name of the parameter
typeThe type of the parameter
defaultValueThe default value to use if not defined

Definition at line 364 of file qgsserverparameters.cpp.

Member Function Documentation

◆ name() [1/2]

QString QgsServerParameter::name ( const QgsServerParameter::Name  name)
static

Converts a parameter's name into its string representation.

Definition at line 371 of file qgsserverparameters.cpp.

◆ name() [2/2]

QgsServerParameter::Name QgsServerParameter::name ( const QString &  name)
static

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

Definition at line 384 of file qgsserverparameters.cpp.

◆ raiseError()

void QgsServerParameter::raiseError ( ) const

Raises an error in case of an invalid conversion.

Exceptions
QgsBadRequestExceptionInvalid parameter exception

Definition at line 397 of file qgsserverparameters.cpp.

Member Data Documentation

◆ mName

QgsServerParameter::Name QgsServerParameter::mName

Definition at line 219 of file qgsserverparameters.h.


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