QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
WMS parameter received from the client. More...
#include <qgswmsparameters.h>
Public Member Functions | |
QgsWmsParameter (const QgsWmsParameter::Name name=QgsWmsParameter::UNKNOWN, const QMetaType::Type type=QMetaType::Type::QString, const QVariant defaultValue=QVariant("")) | |
Constructor for QgsWmsParameter. | |
virtual | ~QgsWmsParameter () override=default |
Default destructor for QgsWmsParameter. | |
bool | isValid () const override |
Returns true if the parameter is valid, false otherwise. | |
QString | loadUrl () const |
Loads the data associated to the parameter converted into an url. | |
QString | name () const |
Returns the name of the parameter. | |
void | raiseError () const |
Raises an error in case of an invalid conversion. | |
QColor | toColor () const |
Converts the parameter into a color. | |
QList< QColor > | toColorList (const char delimiter=',') const |
Converts the parameter into a list of colors. | |
double | toDouble () const |
Converts the parameter into a double. | |
QList< double > | toDoubleList (const char delimiter=',') const |
Converts the parameter into a list of doubles. | |
QList< QgsGeometry > | toGeomList (const char delimiter=',') const |
Converts the parameter into a list of geometries. | |
int | toInt () const |
Converts the parameter into an integer. | |
QList< int > | toIntList (const char delimiter=',') const |
Converts the parameter into a list of integers. | |
QgsRectangle | toRectangle () const |
Converts the parameter into a rectangle. | |
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. | |
QUrl | toUrl () const |
Converts the parameter into an url. | |
Public Member Functions inherited from QgsServerParameterDefinition | |
QgsServerParameterDefinition (const QMetaType::Type type=QMetaType::Type::QString, const QVariant defaultValue=QVariant("")) | |
Constructor for QgsServerParameterDefinition. | |
Q_DECL_DEPRECATED | QgsServerParameterDefinition (const QVariant::Type type, const QVariant defaultValue=QVariant("")) SIP_DEPRECATED |
Constructor for QgsServerParameterDefinition. | |
virtual | ~QgsServerParameterDefinition ()=default |
QString | loadUrl (bool &ok) const |
Loads the data associated to the parameter converted into an url. | |
bool | toBool () const |
Converts the parameter into a boolean. | |
QColor | toColor (bool &ok) const |
Converts the parameter into a color. | |
QList< QColor > | toColorList (bool &ok, char delimiter=',') const |
Converts the parameter into a list of colors. | |
double | toDouble (bool &ok) const |
Converts the parameter into a double. | |
QList< double > | toDoubleList (bool &ok, char delimiter=',') const |
Converts the parameter into a list of doubles. | |
QStringList | toExpressionList () const |
Converts the parameter into a list of QGIS expressions. | |
QList< QgsGeometry > | toGeomList (bool &ok, char delimiter=',') const |
Converts the parameter into a list of geometries. | |
int | toInt (bool &ok) const |
Converts the parameter into an integer. | |
QList< int > | toIntList (bool &ok, char delimiter=',') const |
Converts the parameter into a list of integers. | |
QStringList | toOgcFilterList () const |
Converts the parameter into a list of OGC filters. | |
QgsRectangle | toRectangle (bool &ok) const |
Converts the parameter into a rectangle. | |
QString | toString (bool defaultValue=false) const |
Converts the parameter into a string. | |
QStringList | toStringList (char delimiter=',', bool skipEmptyParts=true) const |
Converts the parameter into a list of strings. | |
QUrl | toUrl (bool &ok) const |
Converts the parameter into an url. | |
QString | typeName () const |
Returns the type of the parameter as a string. | |
Static Public Member Functions | |
static QString | name (const QgsWmsParameter::Name) |
Converts a parameter's name into its string representation. | |
static QgsWmsParameter::Name | name (const QString &name) |
Converts a string into a parameter's name (UNKNOWN in case of an invalid string). | |
Static Public Member Functions inherited from QgsServerParameterDefinition | |
static void | raiseError (const QString &msg) |
Raises an exception in case of an invalid parameters. | |
Public Attributes | |
int | mMapId = -1 |
Map id for prefixed parameters (e.g. "0" for "map0:LAYERS" in GetPrint requests) | |
QgsWmsParameter::Name | mName |
Public Attributes inherited from QgsServerParameterDefinition | |
QVariant | mDefaultValue |
QMetaType::Type | mType |
QVariant | mValue |
WMS parameter received from the client.
Definition at line 101 of file qgswmsparameters.h.
Available parameters for WMS requests.
Definition at line 107 of file qgswmsparameters.h.
QgsWms::QgsWmsParameter::QgsWmsParameter | ( | const QgsWmsParameter::Name | name = QgsWmsParameter::UNKNOWN , |
const QMetaType::Type | type = QMetaType::Type::QString , |
||
const QVariant | defaultValue = QVariant( "" ) |
||
) |
Constructor for QgsWmsParameter.
name | Name of the WMS parameter |
type | Type of the parameter |
defaultValue | Default value of the parameter |
Definition at line 34 of file qgswmsparameters.cpp.
|
overridevirtualdefault |
Default destructor for QgsWmsParameter.
|
overridevirtual |
Returns true
if the parameter is valid, false
otherwise.
Reimplemented from QgsServerParameterDefinition.
Definition at line 42 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameter::loadUrl | ( | ) | const |
Loads the data associated to the parameter converted into an url.
QgsBadRequestException | Invalid parameter exception |
Definition at line 99 of file qgswmsparameters.cpp.
QString QgsWms::QgsWmsParameter::name | ( | ) | const |
Returns the name of the parameter.
Definition at line 197 of file qgswmsparameters.cpp.
|
static |
Converts a parameter's name into its string representation.
Definition at line 202 of file qgswmsparameters.cpp.
|
static |
Converts a string into a parameter's name (UNKNOWN in case of an invalid string).
Definition at line 208 of file qgswmsparameters.cpp.
void QgsWms::QgsWmsParameter::raiseError | ( | ) | const |
Raises an error in case of an invalid conversion.
QgsBadRequestException | Invalid parameter exception |
Definition at line 47 of file qgswmsparameters.cpp.
QColor QgsWms::QgsWmsParameter::toColor | ( | ) | const |
Converts the parameter into a color.
QgsBadRequestException | Invalid parameter exception |
Definition at line 129 of file qgswmsparameters.cpp.
QList< QColor > QgsWms::QgsWmsParameter::toColorList | ( | const char | delimiter = ',' | ) | const |
Converts the parameter into a list of colors.
delimiter | The character delimiting string colors |
QgsBadRequestException | Invalid parameter exception |
Definition at line 142 of file qgswmsparameters.cpp.
double QgsWms::QgsWmsParameter::toDouble | ( | ) | const |
Converts the parameter into a double.
QgsBadRequestException | Invalid parameter exception |
Definition at line 184 of file qgswmsparameters.cpp.
QList< double > QgsWms::QgsWmsParameter::toDoubleList | ( | const char | delimiter = ',' | ) | const |
Converts the parameter into a list of doubles.
delimiter | The character delimiting string doubles |
QgsBadRequestException | Invalid parameter exception |
Definition at line 170 of file qgswmsparameters.cpp.
QList< QgsGeometry > QgsWms::QgsWmsParameter::toGeomList | ( | const char | delimiter = ',' | ) | const |
Converts the parameter into a list of geometries.
delimiter | The character delimiting string geometries |
QgsBadRequestException | Invalid parameter exception |
Definition at line 58 of file qgswmsparameters.cpp.
int QgsWms::QgsWmsParameter::toInt | ( | ) | const |
Converts the parameter into an integer.
QgsBadRequestException | Invalid parameter exception |
Definition at line 86 of file qgswmsparameters.cpp.
QList< int > QgsWms::QgsWmsParameter::toIntList | ( | const char | delimiter = ',' | ) | const |
Converts the parameter into a list of integers.
delimiter | The character delimiting string integers |
QgsBadRequestException | Invalid parameter exception |
Definition at line 156 of file qgswmsparameters.cpp.
QgsRectangle QgsWms::QgsWmsParameter::toRectangle | ( | ) | const |
Converts the parameter into a rectangle.
QgsBadRequestException | Invalid parameter exception |
Definition at line 72 of file qgswmsparameters.cpp.
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.
delimiter | The character used for delimiting |
Definition at line 53 of file qgswmsparameters.cpp.
QUrl QgsWms::QgsWmsParameter::toUrl | ( | ) | const |
Converts the parameter into an url.
QgsBadRequestException | Invalid parameter exception |
Definition at line 116 of file qgswmsparameters.cpp.
int QgsWms::QgsWmsParameter::mMapId = -1 |
Map id for prefixed parameters (e.g. "0" for "map0:LAYERS" in GetPrint requests)
Definition at line 326 of file qgswmsparameters.h.
QgsWmsParameter::Name QgsWms::QgsWmsParameter::mName |
Definition at line 323 of file qgswmsparameters.h.