Performs mesh layer calculations. More...

#include <qgsmeshcalculator.h>

Public Types
enum	Result { Success = 0 , Canceled , CreateOutputError , InputLayerError , ParserError , InvalidDatasets , EvaluateError , MemoryError }
	Result of the calculation. More...

Public Member Functions
	QgsMeshCalculator (const QString &formulaString, const QString &outputDriver, const QString &outputGroupName, const QString &outputFile, const QgsGeometry &outputMask, double startTime, double endTime, QgsMeshLayer *layer)
	Creates calculator with geometry mask.

	QgsMeshCalculator (const QString &formulaString, const QString &outputDriver, const QString &outputGroupName, const QString &outputFile, const QgsRectangle &outputExtent, double startTime, double endTime, QgsMeshLayer *layer)
	Creates calculator with bounding box (rectangular) mask.

Q_DECL_DEPRECATED	QgsMeshCalculator (const QString &formulaString, const QString &outputFile, const QgsGeometry &outputMask, double startTime, double endTime, QgsMeshLayer *layer)
	Creates calculator with geometry mask.

Q_DECL_DEPRECATED	QgsMeshCalculator (const QString &formulaString, const QString &outputFile, const QgsRectangle &outputExtent, double startTime, double endTime, QgsMeshLayer *layer)
	Creates calculator with bounding box (rectangular) mask.

	QgsMeshCalculator (const QString &formulaString, const QString &outputGroupName, const QgsGeometry &outputMask, const QgsMeshDatasetGroup::Type &destination, QgsMeshLayer *layer, double startTime, double endTime)
	Creates calculator with with geometry mask, store the result in destination (must be on memory or virtual), see QgsMeshCalculator::Destination.

	QgsMeshCalculator (const QString &formulaString, const QString &outputGroupName, const QgsRectangle &outputExtent, const QgsMeshDatasetGroup::Type &destination, QgsMeshLayer *layer, double startTime, double endTime)
	Creates calculator with bounding box (rectangular) mask, store the result in destination (must be on memory or virtual), see QgsMeshCalculator::Destination.

Result	processCalculation (QgsFeedback *feedback=nullptr)
	Starts the calculation, creates new dataset group and adds it to the mesh layer.

Static Public Member Functions
static Q_DECL_DEPRECATED Result	expression_valid (const QString &formulaString, QgsMeshLayer *layer)
	Returns whether formula is valid for particular mesh layer.

static Result	expressionIsValid (const QString &formulaString, QgsMeshLayer *layer, QgsMeshDriverMetadata::MeshDriverCapability &requiredCapability)
	Returns whether formula is valid for particular mesh layer.

Detailed Description

Performs mesh layer calculations.

Mesh calculator can do various mathematical operations between dataset groups from a single mesh layer. Resulting dataset group is added to the mesh layer. Result can be filtered by extent or a vector layer mask spatially and by selection of times.

Resulting dataset is always scalar

Since: QGIS 3.6

Definition at line 50 of file qgsmeshcalculator.h.

Member Enumeration Documentation

◆ Result

enum QgsMeshCalculator::Result

Result of the calculation.

Enumerator
Success	Calculation successful.
Canceled	Calculation canceled.
CreateOutputError	Error creating output data file.
InputLayerError	Error reading input layer.
ParserError	Error parsing formula.
InvalidDatasets	Datasets with different time outputs or not part of the mesh.
EvaluateError	Error during evaluation.
MemoryError	Error allocating memory for result.

Definition at line 55 of file qgsmeshcalculator.h.

Constructor & Destructor Documentation

◆ QgsMeshCalculator() [1/6]

QgsMeshCalculator::QgsMeshCalculator	(	const QString &	formulaString,
		const QString &	outputFile,
		const QgsRectangle &	outputExtent,
		double	startTime,
		double	endTime,
		QgsMeshLayer *	layer
	)

Creates calculator with bounding box (rectangular) mask.

Parameters

formulaString	formula/expression to evaluate. Consists of dataset group names, operators and numbers
outputFile	file to store the resulting dataset group data
outputExtent	spatial filter defined by rectangle
startTime	time filter defining the starting dataset
endTime	time filter defining the ending dataset
layer	mesh layer with dataset groups references in formulaString

Deprecated:: QGIS 3.12

Definition at line 31 of file qgsmeshcalculator.cpp.

◆ QgsMeshCalculator() [2/6]

QgsMeshCalculator::QgsMeshCalculator	(	const QString &	formulaString,
		const QString &	outputFile,
		const QgsGeometry &	outputMask,
		double	startTime,
		double	endTime,
		QgsMeshLayer *	layer
	)

Creates calculator with geometry mask.

Parameters

formulaString	formula/expression to evaluate. Consists of dataset group names, operators and numbers
outputFile	file to store the resulting dataset group data
outputMask	spatial filter defined by geometry
startTime	time filter defining the starting dataset
endTime	time filter defining the ending dataset
layer	mesh layer with dataset groups references in formulaString

Deprecated:: QGIS 3.12

Definition at line 50 of file qgsmeshcalculator.cpp.

◆ QgsMeshCalculator() [3/6]

QgsMeshCalculator::QgsMeshCalculator	(	const QString &	formulaString,
		const QString &	outputDriver,
		const QString &	outputGroupName,
		const QString &	outputFile,
		const QgsRectangle &	outputExtent,
		double	startTime,
		double	endTime,
		QgsMeshLayer *	layer
	)

Creates calculator with bounding box (rectangular) mask.

Parameters

formulaString	formula/expression to evaluate. Consists of dataset group names, operators and numbers
outputDriver	output driver name
outputGroupName	output group name
outputFile	file to store the resulting dataset group data
outputExtent	spatial filter defined by rectangle
startTime	time filter defining the starting dataset
endTime	time filter defining the ending dataset
layer	mesh layer with dataset groups references in formulaString

Since: QGIS 3.12

Definition at line 70 of file qgsmeshcalculator.cpp.

◆ QgsMeshCalculator() [4/6]

QgsMeshCalculator::QgsMeshCalculator	(	const QString &	formulaString,
		const QString &	outputDriver,
		const QString &	outputGroupName,
		const QString &	outputFile,
		const QgsGeometry &	outputMask,
		double	startTime,
		double	endTime,
		QgsMeshLayer *	layer
	)

Creates calculator with geometry mask.

Parameters

formulaString	formula/expression to evaluate. Consists of dataset group names, operators and numbers
outputDriver	output driver name
outputGroupName	output group name
outputFile	file to store the resulting dataset group data
outputMask	spatial filter defined by geometry
startTime	time filter defining the starting dataset
endTime	time filter defining the ending dataset
layer	mesh layer with dataset groups references in formulaString

Since: QGIS 3.12

Definition at line 91 of file qgsmeshcalculator.cpp.

◆ QgsMeshCalculator() [5/6]

QgsMeshCalculator::QgsMeshCalculator	(	const QString &	formulaString,
		const QString &	outputGroupName,
		const QgsRectangle &	outputExtent,
		const QgsMeshDatasetGroup::Type &	destination,
		QgsMeshLayer *	layer,
		double	startTime,
		double	endTime
	)

Creates calculator with bounding box (rectangular) mask, store the result in destination (must be on memory or virtual), see QgsMeshCalculator::Destination.

Parameters

formulaString	formula/expression to evaluate. Consists of dataset group names, operators and numbers
outputGroupName	output group name
outputExtent	spatial filter defined by rectangle
destination	destination of the calculation (memory or virtual)
startTime	time filter defining the starting dataset
endTime	time filter defining the ending dataset
layer	mesh layer with dataset groups references in formulaString

Since: QGIS 3.16

Definition at line 112 of file qgsmeshcalculator.cpp.

◆ QgsMeshCalculator() [6/6]

QgsMeshCalculator::QgsMeshCalculator	(	const QString &	formulaString,
		const QString &	outputGroupName,
		const QgsGeometry &	outputMask,
		const QgsMeshDatasetGroup::Type &	destination,
		QgsMeshLayer *	layer,
		double	startTime,
		double	endTime
	)

Creates calculator with with geometry mask, store the result in destination (must be on memory or virtual), see QgsMeshCalculator::Destination.

Parameters

formulaString	formula/expression to evaluate. Consists of dataset group names, operators and numbers
outputGroupName	output group name
outputMask	spatial filter defined by geometry
destination	destination of the calculation (memory or virtual)
startTime	time filter defining the starting dataset
endTime	time filter defining the ending dataset
layer	mesh layer with dataset groups references in formulaString

Since: QGIS 3.16

Definition at line 130 of file qgsmeshcalculator.cpp.

Member Function Documentation

◆ expression_valid()

QgsMeshCalculator::Result QgsMeshCalculator::expression_valid	(	const QString &	formulaString,
		QgsMeshLayer *	layer
	)

static

Returns whether formula is valid for particular mesh layer.

Parameters

formulaString	formula/expression to evaluate. Consists of dataset group names, operators and numbers
layer	mesh layer with dataset groups references in formulaString

Returns: QgsMeshCalculator::Success in case of success

Deprecated:: QGIS 3.12. Use expressionIsValid.

Definition at line 148 of file qgsmeshcalculator.cpp.

◆ expressionIsValid()

QgsMeshCalculator::Result QgsMeshCalculator::expressionIsValid	(	const QString &	formulaString,
		QgsMeshLayer *	layer,
		QgsMeshDriverMetadata::MeshDriverCapability &	requiredCapability
	)

static

Returns whether formula is valid for particular mesh layer.

Parameters

formulaString	formula/expression to evaluate. Consists of dataset group names, operators and numbers
layer	mesh layer with dataset groups references in formulaString
requiredCapability	returns required capability of driver to store results of the calculation

Returns: QgsMeshCalculator::Success in case of success

Since: QGIS 3.12

Definition at line 156 of file qgsmeshcalculator.cpp.

◆ processCalculation()

QgsMeshCalculator::Result QgsMeshCalculator::processCalculation ( QgsFeedback * feedback = nullptr )

Starts the calculation, creates new dataset group and adds it to the mesh layer.

Parameters

feedback The optional feedback argument for progress reporting and cancellation support

Returns: QgsMeshCalculator::Success in case of success

Definition at line 177 of file qgsmeshcalculator.cpp.

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

/build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/core/mesh/qgsmeshcalculator.h
/build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/core/mesh/qgsmeshcalculator.cpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ Result

Constructor & Destructor Documentation

◆ QgsMeshCalculator() [1/6]

◆ QgsMeshCalculator() [2/6]

◆ QgsMeshCalculator() [3/6]

◆ QgsMeshCalculator() [4/6]

◆ QgsMeshCalculator() [5/6]

◆ QgsMeshCalculator() [6/6]

Member Function Documentation

◆ expression_valid()

◆ expressionIsValid()

◆ processCalculation()