QGIS API Documentation  3.21.0-Master (5b68dc587e)
Public Types | Public Member Functions | Static Public Member Functions | List of all members
QgsProcessingParameterDateTime Class Reference

A datetime (or pure date or time) parameter for processing algorithms. More...

#include <qgsprocessingparameters.h>

Inheritance diagram for QgsProcessingParameterDateTime:
Inheritance graph
[legend]

Public Types

enum  Type { DateTime , Date , Time }
 Datetime 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

 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...
 
QgsProcessingParameterDefinitionclone () 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...
 
- Public Member Functions inherited from QgsProcessingParameterDefinition
 QgsProcessingParameterDefinition (const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, const QString &help=QString())
 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...
 
QgsProcessingAlgorithmalgorithm () 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...
 
QVariant defaultValueForGui () const
 Returns the default value to use for the parameter in a GUI. 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...
 
QVariant guiDefaultValueOverride () const
 Returns the default value to use in the GUI for the parameter. More...
 
QString help () const
 Returns the help for 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...
 
QgsProcessingProviderprovider () 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 setGuiDefaultValueOverride (const QVariant &value)
 Sets the default value to use for the parameter in GUI widgets. More...
 
void setHelp (const QString &help)
 Sets the help for 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...
 
virtual QString valueAsPythonComment (const QVariant &value, QgsProcessingContext &context) const
 Returns a Python comment explaining a parameter value, or an empty string if no comment is required. More...
 

Static Public Member Functions

static QgsProcessingParameterDateTimefromScriptCode (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
QStringList mAdditionalExpressionVariables
 Additional expression context variables exposed for use by this parameter. More...
 
QgsProcessingAlgorithmmAlgorithm = 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...
 
QVariant mGuiDefault
 Default value for parameter in GUI. More...
 
QString mHelp
 Parameter help. 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 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.

Since
QGIS 3.14

Definition at line 3887 of file qgsprocessingparameters.h.

Member Enumeration Documentation

◆ Type

Datetime data type.

Enumerator
DateTime 

Datetime values.

Date 

Date values.

Time 

Time values.

Definition at line 3892 of file qgsprocessingparameters.h.

Constructor & Destructor Documentation

◆ QgsProcessingParameterDateTime()

QgsProcessingParameterDateTime::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() 
)
explicit

Constructor for QgsProcessingParameterDateTime.

Definition at line 7630 of file qgsprocessingparameters.cpp.

Member Function Documentation

◆ asPythonString()

QString QgsProcessingParameterDateTime::asPythonString ( QgsProcessing::PythonOutputType  outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass) const
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.

Since
QGIS 3.6

Reimplemented from QgsProcessingParameterDefinition.

Definition at line 7759 of file qgsprocessingparameters.cpp.

◆ checkValueIsAcceptable()

bool QgsProcessingParameterDateTime::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 7647 of file qgsprocessingparameters.cpp.

◆ clone()

QgsProcessingParameterDefinition * QgsProcessingParameterDateTime::clone ( ) const
overridevirtual

Creates a clone of the parameter definition.

Implements QgsProcessingParameterDefinition.

Definition at line 7642 of file qgsprocessingparameters.cpp.

◆ dataType()

QgsProcessingParameterDateTime::Type QgsProcessingParameterDateTime::dataType ( ) const

Returns the acceptable data type for the parameter.

See also
setDataType()

Definition at line 7806 of file qgsprocessingparameters.cpp.

◆ fromScriptCode()

QgsProcessingParameterDateTime * QgsProcessingParameterDateTime::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 7834 of file qgsprocessingparameters.cpp.

◆ fromVariantMap()

bool QgsProcessingParameterDateTime::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.

Definition at line 7825 of file qgsprocessingparameters.cpp.

◆ maximum()

QDateTime QgsProcessingParameterDateTime::maximum ( ) const

Returns the maximum value acceptable by the parameter.

An invalid QDateTime value indicates no maximum value.

See also
setMaximum()

Definition at line 7796 of file qgsprocessingparameters.cpp.

◆ minimum()

QDateTime QgsProcessingParameterDateTime::minimum ( ) const

Returns the minimum value acceptable by the parameter.

An invalid QDateTime value indicates no minimum value.

See also
setMinimum()

Definition at line 7786 of file qgsprocessingparameters.cpp.

◆ setDataType()

void QgsProcessingParameterDateTime::setDataType ( Type  type)

Sets the acceptable data type for the parameter.

See also
dataType()

Definition at line 7811 of file qgsprocessingparameters.cpp.

◆ setMaximum()

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).

See also
maximum()

Definition at line 7801 of file qgsprocessingparameters.cpp.

◆ setMinimum()

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).

See also
minimum()

Definition at line 7791 of file qgsprocessingparameters.cpp.

◆ toolTip()

QString QgsProcessingParameterDateTime::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 7742 of file qgsprocessingparameters.cpp.

◆ toVariantMap()

QVariantMap QgsProcessingParameterDateTime::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.

Definition at line 7816 of file qgsprocessingparameters.cpp.

◆ type()

QString QgsProcessingParameterDateTime::type ( ) const
inlineoverridevirtual

Unique parameter type name.

Implements QgsProcessingParameterDefinition.

Definition at line 3915 of file qgsprocessingparameters.h.

◆ typeName()

static QString QgsProcessingParameterDateTime::typeName ( )
inlinestatic

Returns the type name for the parameter class.

Definition at line 3913 of file qgsprocessingparameters.h.

◆ valueAsPythonString()

QString QgsProcessingParameterDateTime::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 7697 of file qgsprocessingparameters.cpp.


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