A numeric parameter for processing algorithms. More...

#include <qgsprocessingparameters.h>

Inheritance diagram for QgsProcessingParameterNumber:

Public Types
enum	Type { Integer, Double }
	Numeric data type. More...

Public Types inherited from QgsProcessingParameterDefinition
enum	Flag { FlagAdvanced = 1 << 1, FlagHidden = 1 << 2, FlagOptional = 1 << 3, FlagIsModelOutput = 1 << 4 }
	Parameter flags. More...

Public Member Functions
	QgsProcessingParameterNumber (const QString &name, const QString &description=QString(), Type type=Integer, const QVariant &defaultValue=QVariant(), bool optional=false, double minValue=std::numeric_limits< double >::lowest()+1, double maxValue=std::numeric_limits< double >::max())
	Constructor for QgsProcessingParameterNumber. More...

bool	checkValueIsAcceptable (const QVariant &input, QgsProcessingContext *context=nullptr) const override
	Checks whether the specified input value is acceptable for the parameter. More...

QgsProcessingParameterDefinition *	clone () const override
	Creates a clone of the parameter definition. More...

Type	dataType () const
	Returns the acceptable data type for the parameter. More...

bool	fromVariantMap (const QVariantMap &map) override
	Restores this parameter to a QVariantMap. More...

double	maximum () const
	Returns the maximum value acceptable by the parameter. More...

double	minimum () const
	Returns the minimum value acceptable by the parameter. More...

void	setDataType (Type type)
	Sets the acceptable data type for the parameter. More...

void	setMaximum (double maximum)
	Sets the maximum value acceptable by the parameter. More...

void	setMinimum (double minimum)
	Sets the minimum value acceptable by the parameter. More...

QString	toolTip () const override
	Returns a formatted tooltip for use with the parameter, which gives helpful information like parameter description, ID, and extra content like default values (depending on parameter type). More...

QVariantMap	toVariantMap () const override
	Saves this parameter to a QVariantMap. More...

QString	type () const override
	Unique parameter type name. More...

QString	valueAsPythonString (const QVariant &value, QgsProcessingContext &context) const override
	Returns a string version of the parameter input value, which is suitable for use as an input parameter value when running an algorithm directly from a Python command. More...

Public Member Functions inherited from QgsProcessingParameterDefinition
	QgsProcessingParameterDefinition (const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false)
	Constructor for QgsProcessingParameterDefinition. More...

virtual	~QgsProcessingParameterDefinition ()=default

QgsProcessingAlgorithm *	algorithm () const
	Returns a pointer to the algorithm which owns this parameter. More...

virtual QString	asScriptCode () const
	Returns the parameter definition encoded in a string which can be used within a Python processing script. More...

QVariant	defaultValue () const
	Returns the default value for the parameter. More...

virtual QStringList	dependsOnOtherParameters () const
	Returns a list of other parameter names on which this parameter is dependent (e.g. More...

QString	description () const
	Returns the description for the parameter. More...

QString	dynamicLayerParameterName () const
	Returns the name of the parameter for a layer linked to a dynamic parameter, or an empty string if this is not set. More...

QgsPropertyDefinition	dynamicPropertyDefinition () const
	Returns the property definition for dynamic properties. More...

Flags	flags () const
	Returns any flags associated with the parameter. More...

virtual bool	isDestination () const
	Returns true if this parameter represents a file or layer destination, e.g. More...

bool	isDynamic () const
	Returns true if the parameter supports is dynamic, and can support data-defined values (i.e. More...

QVariantMap	metadata () const
	Returns the parameter's freeform metadata. More...

QVariantMap &	metadata ()
	Returns the parameter's freeform metadata. More...

QString	name () const
	Returns the name of the parameter. More...

QgsProcessingProvider *	provider () const
	Returns a pointer to the provider for the algorithm which owns this parameter. More...

void	setDefaultValue (const QVariant &value)
	Sets the default value for the parameter. More...

void	setDescription (const QString &description)
	Sets the description for the parameter. More...

void	setDynamicLayerParameterName (const QString &name)
	Sets the name for the parameter for a layer linked to a dynamic parameter, or an empty string if this is not set. More...

void	setDynamicPropertyDefinition (const QgsPropertyDefinition &definition)
	Sets the property definition for dynamic properties. More...

void	setFlags (Flags flags)
	Sets the flags associated with the parameter. More...

void	setIsDynamic (bool dynamic)
	Sets whether the parameter is dynamic, and can support data-defined values (i.e. More...

void	setMetadata (const QVariantMap &metadata)
	Sets the parameter's freeform metadata. More...

void	setName (const QString &name)
	Sets the name of the parameter. More...

Static Public Member Functions
static QgsProcessingParameterNumber *	fromScriptCode (const QString &name, const QString &description, bool isOptional, const QString &definition)
	Creates a new parameter using the definition from a script code. More...

static QString	typeName ()
	Returns the type name for the parameter class. More...

Additional Inherited Members
Protected Attributes inherited from QgsProcessingParameterDefinition
QgsProcessingAlgorithm *	mAlgorithm = nullptr
	Pointer to algorithm which owns this parameter. More...

QVariant	mDefault
	Default value for parameter. More...

QString	mDescription
	Parameter description. More...

QString	mDynamicLayerParameterName
	Linked vector layer parameter name for dynamic properties. More...

Flags	mFlags
	Parameter flags. More...

bool	mIsDynamic = false
	True for dynamic parameters, which can have data-defined (QgsProperty) based values. More...

QVariantMap	mMetadata
	Freeform metadata for parameter. Mostly used by widget wrappers to customize their appearance and behavior. More...

QString	mName
	Parameter name. More...

QgsPropertyDefinition	mPropertyDefinition
	Data defined property definition. More...

Detailed Description

A numeric parameter for processing algorithms.

For numeric parameters with a dataType() of Double, the number of decimals places shown in the parameter's widget can be specified by setting the parameter's metadata. For example:

1 param = QgsProcessingParameterNumber( 'VAL', 'Threshold', type=QgsProcessingParameter.Double)
2 # only show two decimal places in parameter's widgets, not 6:
3 param.setMetadata( {'widget_wrapper':
4 { 'decimals': 2 }
5 })

Since: QGIS 3.0

Definition at line 1375 of file qgsprocessingparameters.h.

Member Enumeration Documentation

enum QgsProcessingParameterNumber::Type

Numeric data type.

Enumerator
Integer	Integer values.
Double	Double/float values.

Definition at line 1380 of file qgsprocessingparameters.h.

Constructor & Destructor Documentation

QgsProcessingParameterNumber::QgsProcessingParameterNumber	(	const QString &	name,
		const QString &	description = `QString()`,
		Type	type = `Integer`,
		const QVariant &	defaultValue = `QVariant()`,
		bool	optional = `false`,
		double	minValue = `std::numeric_limits<double>::lowest() + 1`,
		double	maxValue = `std::numeric_limits<double>::max()`
	)

explicit

Constructor for QgsProcessingParameterNumber.

Definition at line 2462 of file qgsprocessingparameters.cpp.

Member Function Documentation

bool QgsProcessingParameterNumber::checkValueIsAcceptable	(	const QVariant &	input,
		QgsProcessingContext *	context = `nullptr`
	)		const

overridevirtual

Checks whether the specified input value is acceptable for the parameter.

Returns true if the value can be accepted. The optional context parameter can be specified to allow a more stringent check to be performed, capable of checking for the presence of required layers and other factors within the context.

Reimplemented from QgsProcessingParameterDefinition.

Definition at line 2479 of file qgsprocessingparameters.cpp.

QgsProcessingParameterDefinition * QgsProcessingParameterNumber::clone ( ) const

overridevirtual

Creates a clone of the parameter definition.

Implements QgsProcessingParameterDefinition.

Reimplemented in QgsProcessingParameterDistance.

Definition at line 2474 of file qgsprocessingparameters.cpp.

QgsProcessingParameterNumber::Type QgsProcessingParameterNumber::dataType ( ) const

Returns the acceptable data type for the parameter.

See also: setDataType()

Definition at line 2550 of file qgsprocessingparameters.cpp.

QgsProcessingParameterNumber * QgsProcessingParameterNumber::fromScriptCode	(	const QString &	name,
		const QString &	description,
		bool	isOptional,
		const QString &	definition
	)

static

Creates a new parameter using the definition from a script code.

Definition at line 2578 of file qgsprocessingparameters.cpp.

bool QgsProcessingParameterNumber::fromVariantMap ( const QVariantMap & map )

overridevirtual

Restores this parameter to a QVariantMap.

Subclasses should ensure that they call the base class method.

See also: toVariantMap()

Reimplemented from QgsProcessingParameterDefinition.

Reimplemented in QgsProcessingParameterDistance.

Definition at line 2569 of file qgsprocessingparameters.cpp.

double QgsProcessingParameterNumber::maximum ( ) const

Returns the maximum value acceptable by the parameter.

See also: setMaximum()

Definition at line 2540 of file qgsprocessingparameters.cpp.

double QgsProcessingParameterNumber::minimum ( ) const

Returns the minimum value acceptable by the parameter.

See also: setMinimum()

Definition at line 2530 of file qgsprocessingparameters.cpp.

void QgsProcessingParameterNumber::setDataType ( Type type )

Sets the acceptable data type for the parameter.

See also: dataType()

Definition at line 2555 of file qgsprocessingparameters.cpp.

void QgsProcessingParameterNumber::setMaximum ( double maximum )

Sets the maximum value acceptable by the parameter.

See also: maximum()

Definition at line 2545 of file qgsprocessingparameters.cpp.

void QgsProcessingParameterNumber::setMinimum ( double minimum )

Sets the minimum value acceptable by the parameter.

See also: minimum()

Definition at line 2535 of file qgsprocessingparameters.cpp.

QString QgsProcessingParameterNumber::toolTip ( ) const

overridevirtual

Returns a formatted tooltip for use with the parameter, which gives helpful information like parameter description, ID, and extra content like default values (depending on parameter type).

Reimplemented from QgsProcessingParameterDefinition.

Definition at line 2514 of file qgsprocessingparameters.cpp.

QVariantMap QgsProcessingParameterNumber::toVariantMap ( ) const

overridevirtual

Saves this parameter to a QVariantMap.

Subclasses should ensure that they call the base class method and then extend the result with additional properties.

See also: fromVariantMap()

Reimplemented from QgsProcessingParameterDefinition.

Reimplemented in QgsProcessingParameterDistance.

Definition at line 2560 of file qgsprocessingparameters.cpp.

QString QgsProcessingParameterNumber::type ( ) const

inlineoverridevirtual

Unique parameter type name.

Implements QgsProcessingParameterDefinition.

Reimplemented in QgsProcessingParameterDistance.

Definition at line 1402 of file qgsprocessingparameters.h.

static QString QgsProcessingParameterNumber::typeName ( )

inlinestatic

Returns the type name for the parameter class.

Definition at line 1400 of file qgsprocessingparameters.h.

QString QgsProcessingParameterNumber::valueAsPythonString	(	const QVariant &	value,
		QgsProcessingContext &	context
	)		const

overridevirtual

Returns a string version of the parameter input value, which is suitable for use as an input parameter value when running an algorithm directly from a Python command.

Reimplemented from QgsProcessingParameterDefinition.

Definition at line 2503 of file qgsprocessingparameters.cpp.

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

/build/qgis-3.4.15+24xenial/src/core/processing/qgsprocessingparameters.h
/build/qgis-3.4.15+24xenial/src/core/processing/qgsprocessingparameters.cpp

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation