QGIS API Documentation
3.14.0-Pi (9f7028fd23)
|
#include <qgsprocessingparameters.h>
Public Types | |
enum | Type { DateTime, Date, Time } |
Datetime data type. More... | |
![]() | |
enum | Flag { FlagAdvanced = 1 << 1, FlagHidden = 1 << 2, FlagOptional = 1 << 3, FlagIsModelOutput = 1 << 4 } |
Parameter flags. More... | |
Public Member Functions | |
QgsProcessingParameterDateTime (const QString &name, const QString &description=QString(), Type type=DateTime, const QVariant &defaultValue=QVariant(), bool optional=false, const QDateTime &minValue=QDateTime(), const QDateTime &maxValue=QDateTime()) | |
Constructor for QgsProcessingParameterDateTime. More... | |
QString | asPythonString (QgsProcessing::PythonOutputType outputType=QgsProcessing::PythonQgsProcessingAlgorithmSubclass) const override |
Returns the parameter definition as a Python command which can be used within a Python Processing script. 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... | |
QDateTime | maximum () const |
Returns the maximum value acceptable by the parameter. More... | |
QDateTime | 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 (const QDateTime &maximum) |
Sets the maximum value acceptable by the parameter. More... | |
void | setMinimum (const QDateTime &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... | |
![]() | |
QgsProcessingParameterDefinition (const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false) | |
Constructor for QgsProcessingParameterDefinition. More... | |
virtual | ~QgsProcessingParameterDefinition ()=default |
QStringList | additionalExpressionContextVariables () const |
Returns a list of additional expression context variables which are available for use when evaluating this parameter. More... | |
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 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 () |
Returns the parameter's freeform metadata. More... | |
QVariantMap | metadata () const |
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 | setAdditionalExpressionContextVariables (const QStringList &variables) |
Sets a list of additional expression context variables which are available for use when evaluating 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 QgsProcessingParameterDateTime * | 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 | |
![]() | |
QStringList | mAdditionalExpressionVariables |
Additional expression context variables exposed for use by this parameter. More... | |
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... | |
A datetime (or pure date or time) parameter for processing algorithms.
QgsProcessingParameterDateTime should be evaluated by calling QgsProcessingAlgorithm::parameterAsDateTime(), which will return a date time value.
Definition at line 3503 of file qgsprocessingparameters.h.
Datetime data type.
Enumerator | |
---|---|
DateTime | Datetime values. |
Date | Date values. |
Time | Time values. |
Definition at line 3508 of file qgsprocessingparameters.h.
|
explicit |
Constructor for QgsProcessingParameterDateTime.
Definition at line 6745 of file qgsprocessingparameters.cpp.
|
overridevirtual |
Returns the parameter definition as a Python command which can be used within a Python Processing script.
The outputType argument specifies the desired output format for the Python string, i.e. the intended end use of the generated Python code.
Reimplemented from QgsProcessingParameterDefinition.
Definition at line 6874 of file qgsprocessingparameters.cpp.
|
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 6762 of file qgsprocessingparameters.cpp.
|
overridevirtual |
Creates a clone of the parameter definition.
Implements QgsProcessingParameterDefinition.
Definition at line 6757 of file qgsprocessingparameters.cpp.
QgsProcessingParameterDateTime::Type QgsProcessingParameterDateTime::dataType | ( | ) | const |
Returns the acceptable data type for the parameter.
Definition at line 6920 of file qgsprocessingparameters.cpp.
|
static |
Creates a new parameter using the definition from a script code.
Definition at line 6948 of file qgsprocessingparameters.cpp.
|
overridevirtual |
Restores this parameter to a QVariantMap.
Subclasses should ensure that they call the base class method.
Reimplemented from QgsProcessingParameterDefinition.
Definition at line 6939 of file qgsprocessingparameters.cpp.
QDateTime QgsProcessingParameterDateTime::maximum | ( | ) | const |
Returns the maximum value acceptable by the parameter.
An invalid QDateTime value indicates no maximum value.
Definition at line 6910 of file qgsprocessingparameters.cpp.
QDateTime QgsProcessingParameterDateTime::minimum | ( | ) | const |
Returns the minimum value acceptable by the parameter.
An invalid QDateTime value indicates no minimum value.
Definition at line 6900 of file qgsprocessingparameters.cpp.
void QgsProcessingParameterDateTime::setDataType | ( | Type | type | ) |
Sets the acceptable data type for the parameter.
Definition at line 6925 of file qgsprocessingparameters.cpp.
void QgsProcessingParameterDateTime::setMaximum | ( | const QDateTime & | maximum | ) |
Sets the maximum value acceptable by the parameter.
An invalid QDateTime value indicates no maximum value.
If the dataType() is QgsProcessingParameterDateTime::Time, then the date component of maximum must be set to any valid date (but this date will not actually be considered when comparing parameter values to the specified maximum value, only the time component will be considered).
Definition at line 6915 of file qgsprocessingparameters.cpp.
void QgsProcessingParameterDateTime::setMinimum | ( | const QDateTime & | minimum | ) |
Sets the minimum value acceptable by the parameter.
An invalid QDateTime value indicates no minimum value.
If the dataType() is QgsProcessingParameterDateTime::Time, then the date component of minimum must be set to any valid date (but this date will not actually be considered when comparing parameter values to the specified minimum value, only the time component will be considered).
Definition at line 6905 of file qgsprocessingparameters.cpp.
|
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 6857 of file qgsprocessingparameters.cpp.
|
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.
Reimplemented from QgsProcessingParameterDefinition.
Definition at line 6930 of file qgsprocessingparameters.cpp.
|
inlineoverridevirtual |
Unique parameter type name.
Implements QgsProcessingParameterDefinition.
Definition at line 3531 of file qgsprocessingparameters.h.
|
inlinestatic |
Returns the type name for the parameter class.
Definition at line 3529 of file qgsprocessingparameters.h.
|
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 6812 of file qgsprocessingparameters.cpp.