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

#include <qgswfsparameters.h>

Inheritance diagram for QgsWfs::QgsWfsParameters:

Public Types
enum	Format { NONE , GML2 , GML3 , GeoJSON }
	Output format for the response. More...

enum	ResultType { RESULTS , HITS }
	Type of results. More...

Public Member Functions
	QgsWfsParameters ()
	Constructor for WFS parameters with default values only. More...

	QgsWfsParameters (const QgsServerParameters &parameters)
	Constructor for WFS parameters with specific values. More...

virtual	~QgsWfsParameters ()=default
	Default destructor for QgsWfsParameters. 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...

void	dump () const
	Dumps parameters. More...

QStringList	expFilters () const
	Returns EXP_FILTER parameter as list. More...

QStringList	featureIds () const
	Returns FEATUREID parameter as list. More...

QStringList	filters () const
	Returns FILTER parameter as list. More...

QString	geometryNameAsString () const
	Returns GEOMETRYNAME parameter as a string. More...

QString	maxFeatures () const
	Returns MAXFEATURES parameter as a string. More...

int	maxFeaturesAsInt () const
	Returns MAXFEATURES parameter as an int or its default value if not defined. More...

Format	outputFormat () const
	Returns format. More...

QString	outputFormatAsString () const
	Returns OUTPUTFORMAT parameter as a string. More...

QStringList	propertyNames () const
	Returns PROPERTYNAME parameter as list. More...

ResultType	resultType () const
	Returns resultType. More...

QString	resultTypeAsString () const
	Returns RESULTTYPE parameter as a string. More...

QStringList	sortBy () const
	Returns SORTBY parameter as list. More...

QString	srsName () const
	Returns SRSNAME parameter as a string. More...

QString	startIndex () const
	Returns STARTINDEX parameter as a string. More...

int	startIndexAsInt () const
	Returns STARTINDEX parameter as an int or its default value if not defined. More...

QStringList	typeNames () const
	Returns TYPENAME parameter as list. More...

QgsProjectVersion	versionAsNumber () const
	Returns VERSION parameter if defined or its default value. 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...

virtual QString	request () const
	Returns REQUEST parameter as a string or an empty string if not defined. 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...

virtual QString	version () const
	Returns VERSION parameter as a string or an empty string if not defined. More...

Additional Inherited Members
virtual bool	loadParameter (const QString &name, const QString &value)
	Loads a parameter with a specific value. More...

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

Detailed Description

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

Since: QGIS 3.0

Definition at line 125 of file qgswfsparameters.h.

Member Enumeration Documentation

◆ Format

enum QgsWfs::QgsWfsParameters::Format

Output format for the response.

Enumerator
NONE
GML2
GML3
GeoJSON

Definition at line 132 of file qgswfsparameters.h.

◆ ResultType

enum QgsWfs::QgsWfsParameters::ResultType

Type of results.

Enumerator
RESULTS
HITS

Definition at line 141 of file qgswfsparameters.h.

Constructor & Destructor Documentation

◆ QgsWfsParameters() [1/2]

QgsWfs::QgsWfsParameters::QgsWfsParameters ( const QgsServerParameters & parameters )

Constructor for WFS parameters with specific values.

Parameters

parameters Map of parameters where keys are parameters' names.

Definition at line 181 of file qgswfsparameters.cpp.

◆ QgsWfsParameters() [2/2]

QgsWfs::QgsWfsParameters::QgsWfsParameters ( )

Constructor for WFS parameters with default values only.

Definition at line 130 of file qgswfsparameters.cpp.

◆ ~QgsWfsParameters()

virtual QgsWfs::QgsWfsParameters::~QgsWfsParameters ( )

virtualdefault

Default destructor for QgsWfsParameters.

Member Function Documentation

◆ bbox()

QString QgsWfs::QgsWfsParameters::bbox ( ) const

Returns BBOX if defined or an empty string.

Returns: bbox parameter

Definition at line 341 of file qgswfsparameters.cpp.

◆ bboxAsRectangle()

QgsRectangle QgsWfs::QgsWfsParameters::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 346 of file qgswfsparameters.cpp.

◆ dump()

void QgsWfs::QgsWfsParameters::dump ( ) const

Dumps parameters.

Definition at line 211 of file qgswfsparameters.cpp.

◆ expFilters()

QStringList QgsWfs::QgsWfsParameters::expFilters ( ) const

Returns EXP_FILTER parameter as list.

Returns: expFilters parameter as list

Definition at line 356 of file qgswfsparameters.cpp.

◆ featureIds()

QStringList QgsWfs::QgsWfsParameters::featureIds ( ) const

Returns FEATUREID parameter as list.

Returns: featureId parameter as list

Definition at line 331 of file qgswfsparameters.cpp.

◆ filters()

QStringList QgsWfs::QgsWfsParameters::filters ( ) const

Returns FILTER parameter as list.

Returns: filter parameter as list

Definition at line 336 of file qgswfsparameters.cpp.

◆ geometryNameAsString()

QString QgsWfs::QgsWfsParameters::geometryNameAsString ( ) const

Returns GEOMETRYNAME parameter as a string.

Returns: geometryName parameter as string

Definition at line 361 of file qgswfsparameters.cpp.

◆ maxFeatures()

QString QgsWfs::QgsWfsParameters::maxFeatures ( ) const

Returns MAXFEATURES parameter as a string.

Returns: maxFeatures parameter as string

Definition at line 301 of file qgswfsparameters.cpp.

◆ maxFeaturesAsInt()

int QgsWfs::QgsWfsParameters::maxFeaturesAsInt ( ) const

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

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

Returns: maxFeatures parameter

Exceptions

QgsBadRequestException

Definition at line 306 of file qgswfsparameters.cpp.

◆ outputFormat()

QgsWfsParameters::Format QgsWfs::QgsWfsParameters::outputFormat ( ) const

Returns format.

If the OUTPUTFORMAT parameter is not used, then the default value is GML2 or GML3.

Returns: format

Definition at line 235 of file qgswfsparameters.cpp.

◆ outputFormatAsString()

QString QgsWfs::QgsWfsParameters::outputFormatAsString ( ) const

Returns OUTPUTFORMAT parameter as a string.

Returns: outputFormat parameter as string

Definition at line 230 of file qgswfsparameters.cpp.

◆ propertyNames()

QStringList QgsWfs::QgsWfsParameters::propertyNames ( ) const

Returns PROPERTYNAME parameter as list.

Returns: propertyName parameter as list

Definition at line 296 of file qgswfsparameters.cpp.

◆ resultType()

QgsWfsParameters::ResultType QgsWfs::QgsWfsParameters::resultType ( ) const

Returns resultType.

If the RESULTTYPE parameter is not used, then the default value is RESULTS.

Returns: resultType

Definition at line 284 of file qgswfsparameters.cpp.

◆ resultTypeAsString()

QString QgsWfs::QgsWfsParameters::resultTypeAsString ( ) const

Returns RESULTTYPE parameter as a string.

Returns: resultType parameter as string

Definition at line 279 of file qgswfsparameters.cpp.

◆ sortBy()

QStringList QgsWfs::QgsWfsParameters::sortBy ( ) const

Returns SORTBY parameter as list.

Returns: sortBy parameter as list

Definition at line 351 of file qgswfsparameters.cpp.

◆ srsName()

QString QgsWfs::QgsWfsParameters::srsName ( ) const

Returns SRSNAME parameter as a string.

Returns: srsName parameter as string

Definition at line 321 of file qgswfsparameters.cpp.

◆ startIndex()

QString QgsWfs::QgsWfsParameters::startIndex ( ) const

Returns STARTINDEX parameter as a string.

Returns: startIndex parameter as string

Definition at line 311 of file qgswfsparameters.cpp.

◆ startIndexAsInt()

int QgsWfs::QgsWfsParameters::startIndexAsInt ( ) const

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

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

Returns: startIndex parameter

Exceptions

QgsBadRequestException

Definition at line 316 of file qgswfsparameters.cpp.

◆ typeNames()

QStringList QgsWfs::QgsWfsParameters::typeNames ( ) const

Returns TYPENAME parameter as list.

Returns: typeName parameter as list

Definition at line 326 of file qgswfsparameters.cpp.

◆ versionAsNumber()

QgsProjectVersion QgsWfs::QgsWfsParameters::versionAsNumber ( ) const

Returns VERSION parameter if defined or its default value.

Returns: version

Definition at line 366 of file qgswfsparameters.cpp.

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

/build/qgis-3.28.0+99sid/src/server/services/wfs/qgswfsparameters.h
/build/qgis-3.28.0+99sid/src/server/services/wfs/qgswfsparameters.cpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Format

◆ ResultType

Constructor & Destructor Documentation

◆ QgsWfsParameters() [1/2]

◆ QgsWfsParameters() [2/2]

◆ ~QgsWfsParameters()

Member Function Documentation

◆ bbox()

◆ bboxAsRectangle()

◆ dump()

◆ expFilters()

◆ featureIds()

◆ filters()

◆ geometryNameAsString()

◆ maxFeatures()

◆ maxFeaturesAsInt()

◆ outputFormat()

◆ outputFormatAsString()

◆ propertyNames()

◆ resultType()

◆ resultTypeAsString()

◆ sortBy()

◆ srsName()

◆ startIndex()

◆ startIndexAsInt()

◆ typeNames()

◆ versionAsNumber()