Definition of a parameter with basic conversion methods. More...

#include <qgsserverparameters.h>

Inheritance diagram for QgsServerParameterDefinition:

[legend]

Public Member Functions
	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
virtual bool	isValid () const
	Returns `true` if the parameter is valid, `false` otherwise.
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=',', bool skipEmptyParts=true) 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=',', bool skipEmptyParts=true) 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=',', bool skipEmptyParts=true) 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=',', bool skipEmptyParts=true) 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 void	raiseError (const QString &msg)
	Raises an exception in case of an invalid parameters.

Public Attributes
QVariant	mDefaultValue
QMetaType::Type	mType
QVariant	mValue

Detailed Description

Definition of a parameter with basic conversion methods.

Since: QGIS 3.4

Definition at line 35 of file qgsserverparameters.h.

Constructor & Destructor Documentation

◆ QgsServerParameterDefinition() [1/2]

QgsServerParameterDefinition::QgsServerParameterDefinition	(	const QMetaType::Type	type = QMetaType::Type::QString,
		const QVariant	defaultValue = QVariant( "" ) )

Constructor for QgsServerParameterDefinition.

Parameters

type	The type of the parameter
defaultValue	The default value of the parameter

Definition at line 36 of file qgsserverparameters.cpp.

◆ QgsServerParameterDefinition() [2/2]

QgsServerParameterDefinition::QgsServerParameterDefinition	(	const QVariant::Type	type,
		const QVariant	defaultValue = QVariant( "" ) )

Constructor for QgsServerParameterDefinition.

Parameters

type	The type of the parameter
defaultValue	The default value of the parameter

Deprecated: QGIS 3.38. Use the method with a QMetaType::Type argument instead.

Definition at line 42 of file qgsserverparameters.cpp.

◆ ~QgsServerParameterDefinition()

virtual QgsServerParameterDefinition::~QgsServerParameterDefinition ( )

virtualdefault

Member Function Documentation

◆ isValid()

bool QgsServerParameterDefinition::isValid ( ) const

virtual

Returns true if the parameter is valid, false otherwise.

Reimplemented in QgsWms::QgsWmsParameter.

Definition at line 410 of file qgsserverparameters.cpp.

◆ loadUrl()

QString QgsServerParameterDefinition::loadUrl ( bool & ok ) const

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

Parameters

ok	`true` if there's no error during the load, `false` otherwise

Returns: The content loaded

Since: QGIS 3.4

Definition at line 323 of file qgsserverparameters.cpp.

◆ raiseError()

void QgsServerParameterDefinition::raiseError ( const QString & msg )

static

Raises an exception in case of an invalid parameters.

Parameters

msg	The message describing the exception

Exceptions

QgsBadRequestException Invalid parameter exception

Definition at line 415 of file qgsserverparameters.cpp.

◆ toBool()

bool QgsServerParameterDefinition::toBool ( ) const

Converts the parameter into a boolean.

Returns: A boolean

Definition at line 385 of file qgsserverparameters.cpp.

◆ toColor()

QColor QgsServerParameterDefinition::toColor ( bool & ok ) const

Converts the parameter into a color.

Parameters

ok	`true` if there's no error during the conversion, `false` otherwise

Returns: A color

Definition at line 52 of file qgsserverparameters.cpp.

◆ toColorList()

QList< QColor > QgsServerParameterDefinition::toColorList	(	bool &	ok,
		char	delimiter = ',',
		bool	skipEmptyParts = true ) const

Converts the parameter into a list of colors.

Parameters

ok	`true` if there's no error during the conversion, `false` otherwise
delimiter	The character used for delimiting
skipEmptyParts	for splitting

Returns: A list of colors

Definition at line 208 of file qgsserverparameters.cpp.

◆ toDouble()

double QgsServerParameterDefinition::toDouble ( bool & ok ) const

Converts the parameter into a double.

Parameters

ok	`true` if there's no error during the conversion, `false` otherwise

Returns: A double

Definition at line 397 of file qgsserverparameters.cpp.

◆ toDoubleList()

QList< double > QgsServerParameterDefinition::toDoubleList	(	bool &	ok,
		char	delimiter = ',',
		bool	skipEmptyParts = true ) const

Converts the parameter into a list of doubles.

Parameters

ok	`true` if there's no error during the conversion, `false` otherwise
delimiter	The character used for delimiting
skipEmptyParts	for splitting

Returns: A list of doubles

Definition at line 261 of file qgsserverparameters.cpp.

◆ toExpressionList()

QStringList QgsServerParameterDefinition::toExpressionList ( ) const

Converts the parameter into a list of QGIS expressions.

Returns: A list of strings

Since: QGIS 3.24

Definition at line 165 of file qgsserverparameters.cpp.

◆ toGeomList()

QList< QgsGeometry > QgsServerParameterDefinition::toGeomList	(	bool &	ok,
		char	delimiter = ',',
		bool	skipEmptyParts = true ) const

Converts the parameter into a list of geometries.

Parameters

ok	`true` if there's no error during the conversion, `false` otherwise
delimiter	The character used for delimiting
skipEmptyParts	for splitting

Returns: A list of geometries

Definition at line 101 of file qgsserverparameters.cpp.

◆ toInt()

int QgsServerParameterDefinition::toInt ( bool & ok ) const

Converts the parameter into an integer.

Parameters

ok	`true` if there's no error during the conversion, `false` otherwise

Returns: An integer

Definition at line 372 of file qgsserverparameters.cpp.

◆ toIntList()

QList< int > QgsServerParameterDefinition::toIntList	(	bool &	ok,
		char	delimiter = ',',
		bool	skipEmptyParts = true ) const

Converts the parameter into a list of integers.

Parameters

ok	`true` if there's no error during the conversion, `false` otherwise
delimiter	The character used for delimiting
skipEmptyParts	for splitting

Returns: A list of integers

Definition at line 240 of file qgsserverparameters.cpp.

◆ toOgcFilterList()

QStringList QgsServerParameterDefinition::toOgcFilterList ( ) const

Converts the parameter into a list of OGC filters.

Returns: A list of strings

Since: QGIS 3.24

Definition at line 125 of file qgsserverparameters.cpp.

◆ toRectangle()

QgsRectangle QgsServerParameterDefinition::toRectangle ( bool & ok ) const

Converts the parameter into a rectangle.

Parameters

ok	`true` if there's no error during the conversion, `false` otherwise

Returns: A rectangle

Definition at line 282 of file qgsserverparameters.cpp.

◆ toString()

QString QgsServerParameterDefinition::toString ( bool defaultValue = false ) const

Converts the parameter into a string.

If defaultValue is true and current value is empty, then the default value is returned.

Definition at line 74 of file qgsserverparameters.cpp.

◆ toStringList()

QStringList QgsServerParameterDefinition::toStringList	(	char	delimiter = ',',
		bool	skipEmptyParts = true ) const

Converts the parameter into a list of strings.

Parameters

delimiter	The character used for delimiting
skipEmptyParts	To use QString::SkipEmptyParts for splitting

Returns: A list of strings

Definition at line 84 of file qgsserverparameters.cpp.

◆ toUrl()

QUrl QgsServerParameterDefinition::toUrl ( bool & ok ) const

Converts the parameter into an url.

Parameters

ok	`true` if there's no error during the conversion, `false` otherwise

Returns: An url

Since: QGIS 3.4

Definition at line 358 of file qgsserverparameters.cpp.

◆ typeName()

QString QgsServerParameterDefinition::typeName ( ) const

Returns the type of the parameter as a string.

Definition at line 47 of file qgsserverparameters.cpp.

Member Data Documentation

◆ mDefaultValue

QVariant QgsServerParameterDefinition::mDefaultValue

Definition at line 189 of file qgsserverparameters.h.

◆ mType

QMetaType::Type QgsServerParameterDefinition::mType

Definition at line 187 of file qgsserverparameters.h.

◆ mValue

QVariant QgsServerParameterDefinition::mValue

Definition at line 188 of file qgsserverparameters.h.

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

/build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/server/qgsserverparameters.h
/build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/server/qgsserverparameters.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ QgsServerParameterDefinition() [1/2]

◆ QgsServerParameterDefinition() [2/2]

◆ ~QgsServerParameterDefinition()

Member Function Documentation

◆ isValid()

◆ loadUrl()

◆ raiseError()

◆ toBool()

◆ toColor()

◆ toColorList()

◆ toDouble()

◆ toDoubleList()

◆ toExpressionList()

◆ toGeomList()

◆ toInt()

◆ toIntList()

◆ toOgcFilterList()

◆ toRectangle()

◆ toString()

◆ toStringList()

◆ toUrl()

◆ typeName()

Member Data Documentation

◆ mDefaultValue

◆ mType

◆ mValue