QGIS API Documentation
3.14.0-Pi (9f7028fd23)
|
WFS parameter received from the client. More...
#include <qgswfsparameters.h>
Public Types | |
enum | Name { UNKNOWN, OUTPUTFORMAT, RESULTTYPE, PROPERTYNAME, MAXFEATURES, STARTINDEX, SRSNAME, TYPENAME, FEATUREID, FILTER, BBOX, SORTBY, EXP_FILTER, GEOMETRYNAME } |
Available parameters for WFS requests. More... | |
Public Member Functions | |
QgsWfsParameter (const QgsWfsParameter::Name name=QgsWfsParameter::UNKNOWN, const QVariant::Type type=QVariant::String, const QVariant defaultValue=QVariant("")) | |
Constructor for QgsWfsParameter. More... | |
virtual | ~QgsWfsParameter ()=default |
Default destructor for QgsWfsParameter. More... | |
void | raiseError () const |
Raises an error in case of an invalid conversion. More... | |
int | toInt () const |
Converts the parameter into an integer. More... | |
QgsRectangle | toRectangle () const |
Converts the parameter into a rectangle. More... | |
QStringList | toStringListWithExp (const QString &exp="\\(([^()]+)\\)") const |
Converts the parameter into a list of string. 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< 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... | |
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 QgsWfsParameter::Name) |
Converts a parameter's name into its string representation. More... | |
static QgsWfsParameter::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 | |
QgsWfsParameter::Name | mName |
Public Attributes inherited from QgsServerParameterDefinition | |
QVariant | mDefaultValue |
QVariant::Type | mType |
QVariant | mValue |
WFS parameter received from the client.
Definition at line 50 of file qgswfsparameters.h.
Available parameters for WFS requests.
Enumerator | |
---|---|
UNKNOWN | |
OUTPUTFORMAT | |
RESULTTYPE | |
PROPERTYNAME | |
MAXFEATURES | |
STARTINDEX | |
SRSNAME | |
TYPENAME | |
FEATUREID | |
FILTER | |
BBOX | |
SORTBY | |
EXP_FILTER | |
GEOMETRYNAME |
Definition at line 56 of file qgswfsparameters.h.
QgsWfs::QgsWfsParameter::QgsWfsParameter | ( | const QgsWfsParameter::Name | name = QgsWfsParameter::UNKNOWN , |
const QVariant::Type | type = QVariant::String , |
||
const QVariant | defaultValue = QVariant( "" ) |
||
) |
Constructor for QgsWfsParameter.
name | Name of the WMS parameter |
type | Type of the parameter |
defaultValue | Default value of the parameter |
Definition at line 39 of file qgswfsparameters.cpp.
|
virtualdefault |
Default destructor for QgsWfsParameter.
|
static |
Converts a parameter's name into its string representation.
Definition at line 121 of file qgswfsparameters.cpp.
|
static |
Converts a string into a parameter's name (UNKNOWN in case of an invalid string).
Definition at line 127 of file qgswfsparameters.cpp.
void QgsWfs::QgsWfsParameter::raiseError | ( | ) | const |
Raises an error in case of an invalid conversion.
QgsBadRequestException | Invalid parameter exception |
Definition at line 115 of file qgswfsparameters.cpp.
int QgsWfs::QgsWfsParameter::toInt | ( | ) | const |
Converts the parameter into an integer.
QgsBadRequestException | Invalid parameter exception |
Definition at line 47 of file qgswfsparameters.cpp.
QgsRectangle QgsWfs::QgsWfsParameter::toRectangle | ( | ) | const |
Converts the parameter into a rectangle.
QgsBadRequestException | Invalid parameter exception |
Definition at line 60 of file qgswfsparameters.cpp.
QStringList QgsWfs::QgsWfsParameter::toStringListWithExp | ( | const QString & | exp = "\\(([^()]+)\\)" | ) | const |
Converts the parameter into a list of string.
exp | The expression to use for splitting, pass an empty string to avoid splitting |
QgsBadRequestException | Invalid parameter exception |
Definition at line 84 of file qgswfsparameters.cpp.
QgsWfsParameter::Name QgsWfs::QgsWfsParameter::mName |
Definition at line 129 of file qgswfsparameters.h.