16#ifndef QGSPROCESSINGPARAMETERMESHDATASET_H
17#define QGSPROCESSINGPARAMETERMESHDATASET_H
47 const QString &description = QString(),
48 const QString &meshLayerParameterName = QString(),
49 QSet<int> supportedDataType = QSet<int>(),
50 bool optional =
false );
53 QString type() const override;
54 bool checkValueIsAcceptable( const QVariant &input,
QgsProcessingContext *context =
nullptr ) const override;
56 QString asPythonString(
QgsProcessing::PythonOutputType outputType =
QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
57 QStringList dependsOnOtherParameters() const override;
58 QVariantMap toVariantMap() const override;
59 bool fromVariantMap( const QVariantMap &map ) override;
62 static QString
typeName() {
return QStringLiteral(
"meshdatasetgroups" ); }
74 QString mMeshLayerParameterName;
75 QSet<int> mSupportedDataType;
77 static bool valueIsAcceptable(
const QVariant &input,
bool allowEmpty );
99 return QCoreApplication::translate(
"Processing",
"An input allowing selection dataset groups from a mesh layer" );
102 QString
name()
const override
104 return QCoreApplication::translate(
"Processing",
"Mesh Dataset Groups" );
107 QString id()
const override
112 QString pythonImportString()
const override
114 return QStringLiteral(
"from qgis.core import QgsProcessingParameterMeshDatasetGroups" );
117 QString className()
const override
119 return QStringLiteral(
"QgsProcessingParameterMeshDatasetGroups" );
122 QStringList acceptedPythonTypes()
const override
124 return QStringList() << QObject::tr(
"list[int]: list of dataset group indexes, see QgsProcessingParameterMeshDatasetGroups docs" );
158 const QString &description = QString(),
159 const QString &meshLayerParameterName = QString(),
160 const QString &datasetGroupParameterName = QString() );
163 QString type() const override;
166 QString asPythonString(
QgsProcessing::PythonOutputType outputType =
QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
167 QStringList dependsOnOtherParameters() const override;
168 QVariantMap toVariantMap() const override;
169 bool fromVariantMap( const QVariantMap &map ) override;
172 static QString
typeName() {
return QStringLiteral(
"meshdatasettime" ); }
206 QString mMeshLayerParameterName;
207 QString mDatasetGroupParameterName;
209 static bool valueIsAcceptable(
const QVariant &input,
bool allowEmpty );
231 return QCoreApplication::translate(
"Processing",
"An input allowing selection of dataset index from a mesh layer by time setting" );
234 QString
name()
const override
236 return QCoreApplication::translate(
"Processing",
"Mesh Dataset Time" );
239 QString id()
const override
244 QString pythonImportString()
const override
246 return QStringLiteral(
"from qgis.core import QgsProcessingParameterMeshDatasetTime" );
249 QString className()
const override
251 return QStringLiteral(
"QgsProcessingParameterMeshDatasetTime" );
254 QStringList acceptedPythonTypes()
const override
256 return QStringList() << QObject::tr(
"dict{}: dictionary, see QgsProcessingParameterMeshDatasetTime docs" );
QgsMeshDatasetIndex is index that identifies the dataset group (e.g.
Contains information about the context in which a processing algorithm is executed.
Base class for the definition of processing parameters.
QString description() const
Returns the description for the parameter.
QString name() const
Returns the name of the parameter.
A parameter for processing algorithms that need a list of mesh dataset groups.
QgsProcessingParameterMeshDatasetGroups(const QString &name, const QString &description=QString(), const QString &meshLayerParameterName=QString(), QSet< int > supportedDataType=QSet< int >(), bool optional=false)
Constructor.
static QString typeName()
Returns the type name for the parameter class.
static QList< int > valueAsDatasetGroup(const QVariant &value)
Returns the value as a list if dataset group indexes.
QgsProcessingParameterDefinition * clone() const override
Creates a clone of the parameter definition.
QString meshLayerParameterName() const
Returns the name of the mesh layer parameter.
bool isDataTypeSupported(QgsMeshDatasetGroupMetadata::DataType dataType) const
Returns whether the data type is supported by the parameter.
A parameter for processing algorithms that need a list of mesh dataset index from time parameter.
QgsProcessingParameterMeshDatasetTime(const QString &name, const QString &description=QString(), const QString &meshLayerParameterName=QString(), const QString &datasetGroupParameterName=QString())
Constructor.
QgsProcessingParameterDefinition * clone() const override
Creates a clone of the parameter definition.
static QString valueAsTimeType(const QVariant &value)
Returns the dataset value time type as a string : current-context-time : the time is store in the pro...
QString datasetGroupParameterName() const
Returns the name of the dataset groups parameter.
QString meshLayerParameterName() const
Returns the name of the mesh layer parameter.
static QgsMeshDatasetIndex timeValueAsDatasetIndex(const QVariant &value)
Returns the value as a QgsMeshDatasetIndex if the value has "dataset-time-step" type.
static QString typeName()
Returns the type name for the parameter class.
static QDateTime timeValueAsDefinedDateTime(const QVariant &value)
Returns the value as a QDateTime if the value has "defined-date-time" type.
Makes metadata of processing parameters available.
Contains enumerations and other constants for use in processing algorithms and parameters.