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

A parameter for processing algorithms that need a list of mesh dataset index from time parameter. More...

#include <qgsprocessingparametermeshdataset.h>

Inheritance diagram for QgsProcessingParameterMeshDatasetTime:
Inheritance graph
[legend]

Public Member Functions

 QgsProcessingParameterMeshDatasetTime (const QString &name, const QString &description=QString(), const QString &meshLayerParameterName=QString(), const QString &datasetGroupParameterName=QString())
 Constructor. 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...
 
QString datasetGroupParameterName () const
 Returns the name of the dataset groups parameter. More...
 
QStringList dependsOnOtherParameters () const override
 Returns a list of other parameter names on which this parameter is dependent (e.g. More...
 
QString meshLayerParameterName () const
 Returns the name of the mesh layer parameter. 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...
 
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 fromVariantMap (const QVariantMap &map)
 Restores this parameter to a QVariantMap. 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 toolTip () const
 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...
 
virtual QVariantMap toVariantMap () const
 Saves this parameter to a QVariantMap. 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 QgsMeshDatasetIndex timeValueAsDatasetIndex (const QVariant &value)
 Returns the value as a QgsMeshDatasetIndex if the value has "dataset-time-step" type. More...
 
static QDateTime timeValueAsDefinedDateTime (const QVariant &value)
 Returns the value as a QDateTime if the value has "defined-date-time" type. More...
 
static QString typeName ()
 Returns the type name for the parameter class. More...
 
static QString valueAsTimeType (const QVariant &value)
 Returns the dataset value time type as a string : current-context-time : the time is store in the processing context (e.g. More...
 

Additional Inherited Members

- Public Types inherited from QgsProcessingParameterDefinition
enum  Flag { FlagAdvanced = 1 << 1 , FlagHidden = 1 << 2 , FlagOptional = 1 << 3 , FlagIsModelOutput = 1 << 4 }
 Parameter flags. More...
 
- 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 parameter for processing algorithms that need a list of mesh dataset index from time parameter.

A valid value for this parameter is a map (QVariantMap) with in this form:

Note
This parameter is dependent on a mesh layer parameter (
See also
QgsProcessingParameterMeshLayer) and on mesh datast group parameter (
QgsProcessingParameterMeshDatasetGroups)
Since
QGIS 3.18

Definition at line 143 of file qgsprocessingparametermeshdataset.h.

Constructor & Destructor Documentation

◆ QgsProcessingParameterMeshDatasetTime()

QgsProcessingParameterMeshDatasetTime::QgsProcessingParameterMeshDatasetTime ( const QString &  name,
const QString &  description = QString(),
const QString &  meshLayerParameterName = QString(),
const QString &  datasetGroupParameterName = QString() 
)

Constructor.

Parameters
namename of the parameter
descriptiondescription of the parameter
meshLayerParameterNamename of the associated mesh layer parameter (
See also
QgsProcessingParameterMeshLayer)
Parameters
datasetGroupParameterNamename of the associated dataset group parameter (
See also
QgsProcessingParameterMeshDatasetGroups)

Member Function Documentation

◆ asPythonString()

QString QgsProcessingParameterMeshDatasetTime::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.

◆ checkValueIsAcceptable()

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

◆ clone()

QgsProcessingParameterDefinition* QgsProcessingParameterMeshDatasetTime::clone ( ) const
overridevirtual

Creates a clone of the parameter definition.

Implements QgsProcessingParameterDefinition.

◆ datasetGroupParameterName()

QString QgsProcessingParameterMeshDatasetTime::datasetGroupParameterName ( ) const

Returns the name of the dataset groups parameter.

◆ dependsOnOtherParameters()

QStringList QgsProcessingParameterMeshDatasetTime::dependsOnOtherParameters ( ) const
overridevirtual

Returns a list of other parameter names on which this parameter is dependent (e.g.

field parameters which depend on a parent layer parameter).

Reimplemented from QgsProcessingParameterDefinition.

◆ meshLayerParameterName()

QString QgsProcessingParameterMeshDatasetTime::meshLayerParameterName ( ) const

Returns the name of the mesh layer parameter.

◆ timeValueAsDatasetIndex()

static QgsMeshDatasetIndex QgsProcessingParameterMeshDatasetTime::timeValueAsDatasetIndex ( const QVariant &  value)
static

Returns the value as a QgsMeshDatasetIndex if the value has "dataset-time-step" type.

If the value has the wrong type return an invalid dataset index

See also
valueAsTimeType()

◆ timeValueAsDefinedDateTime()

static QDateTime QgsProcessingParameterMeshDatasetTime::timeValueAsDefinedDateTime ( const QVariant &  value)
static

Returns the value as a QDateTime if the value has "defined-date-time" type.

If the value has the wrong type return an invalid QDatetime

See also
valueAsTimeType()

◆ type()

QString QgsProcessingParameterMeshDatasetTime::type ( ) const
overridevirtual

Unique parameter type name.

Implements QgsProcessingParameterDefinition.

◆ typeName()

static QString QgsProcessingParameterMeshDatasetTime::typeName ( )
inlinestatic

Returns the type name for the parameter class.

Definition at line 168 of file qgsprocessingparametermeshdataset.h.

◆ valueAsPythonString()

QString QgsProcessingParameterMeshDatasetTime::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.

◆ valueAsTimeType()

static QString QgsProcessingParameterMeshDatasetTime::valueAsTimeType ( const QVariant &  value)
static

Returns the dataset value time type as a string : current-context-time : the time is store in the processing context (e.g.

current canvas time), in this case the value does not contain any time value defined-date-time : absolute time of type QDateTime dataset-time-step : a time step of existing dataset, in this case the time takes the form of a QMeshDatasetIndex with value to the corresponding dataset index static : dataset groups are all static, in this case the value does not contain any time value


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