16#ifndef QGSPROCESSINGPARAMETERMESHDATASET_H
17#define QGSPROCESSINGPARAMETERMESHDATASET_H
48 const QString &description = QString(),
49 const QString &meshLayerParameterName = QString(),
50 QSet<int> supportedDataType = QSet<int>(),
51 bool optional =
false );
54 QString type() const override;
55 bool checkValueIsAcceptable( const QVariant &input,
QgsProcessingContext *context =
nullptr ) const override;
57 QString asPythonString(
QgsProcessing::PythonOutputType outputType =
QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
58 QStringList dependsOnOtherParameters() const override;
59 QVariantMap toVariantMap() const override;
60 bool fromVariantMap( const QVariantMap &map ) override;
63 static QString
typeName() {
return QStringLiteral(
"meshdatasetgroups" ); }
75 QString mMeshLayerParameterName;
76 QSet<int> mSupportedDataType;
78 static bool valueIsAcceptable(
const QVariant &input,
bool allowEmpty );
100 return QCoreApplication::translate(
"Processing",
"An input allowing selection dataset groups from a mesh layer" );
103 QString
name()
const override
105 return QCoreApplication::translate(
"Processing",
"Mesh Dataset Groups" );
108 QString id()
const override
113 QString pythonImportString()
const override
115 return QStringLiteral(
"from qgis.core import QgsProcessingParameterMeshDatasetGroups" );
118 QString className()
const override
120 return QStringLiteral(
"QgsProcessingParameterMeshDatasetGroups" );
123 QStringList acceptedPythonTypes()
const override
125 return QStringList() << QObject::tr(
"list[int]: list of dataset group indexes, see QgsProcessingParameterMeshDatasetGroups docs" );
128 QStringList acceptedParameterTypes()
const override
135 QStringList acceptedOutputTypes()
const override
172 const QString &description = QString(),
173 const QString &meshLayerParameterName = QString(),
174 const QString &datasetGroupParameterName = QString() );
177 QString type() const override;
180 QString asPythonString(
QgsProcessing::PythonOutputType outputType =
QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass ) const override;
181 QStringList dependsOnOtherParameters() const override;
182 QVariantMap toVariantMap() const override;
183 bool fromVariantMap( const QVariantMap &map ) override;
186 static QString
typeName() {
return QStringLiteral(
"meshdatasettime" ); }
220 QString mMeshLayerParameterName;
221 QString mDatasetGroupParameterName;
223 static bool valueIsAcceptable(
const QVariant &input,
bool allowEmpty );
245 return QCoreApplication::translate(
"Processing",
"An input allowing selection of dataset index from a mesh layer by time setting" );
248 QString
name()
const override
250 return QCoreApplication::translate(
"Processing",
"Mesh Dataset Time" );
253 QString id()
const override
258 QString pythonImportString()
const override
260 return QStringLiteral(
"from qgis.core import QgsProcessingParameterMeshDatasetTime" );
263 QString className()
const override
265 return QStringLiteral(
"QgsProcessingParameterMeshDatasetTime" );
268 QStringList acceptedPythonTypes()
const override
270 return QStringList() << QObject::tr(
"dict{}: dictionary, see QgsProcessingParameterMeshDatasetTime docs" );
273 QStringList acceptedParameterTypes()
const override
281 QStringList acceptedOutputTypes()
const override
An index that identifies the dataset group (e.g.
Contains information about the context in which a processing algorithm is executed.
static QString typeName()
Returns the type name for the output class.
static QString typeName()
Returns the type name for the output class.
static QString typeName()
Returns the type name for the parameter class.
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.
static QString typeName()
Returns the type name for the parameter class.
static QString typeName()
Returns the type name for the parameter class.
Makes metadata of processing parameters available.
Contains enumerations and other constants for use in processing algorithms and parameters.