QgsGridFileWriter Class Reference

A class that does interpolation to a grid and writes the results to an ascii grid. More...

#include <qgsgridfilewriter.h>

Public Member Functions
	QgsGridFileWriter (QgsInterpolator *interpolator, const QString &outputPath, const QgsRectangle &extent, int nCols, int nRows)
	Constructor for QgsGridFileWriter, for the specified interpolator.
QStringList	createOptions () const
	Returns the list of data source creation options which will be used when creating the output raster file.
double	noDataValue () const
	Returns no data value used for output file.
void	setCreateOptions (const QStringList &list)
	Sets a list of data source creation options to use when creating the output raster file.
void	setNoDataValue (double noDataValue)
	Set no data value for output file.
int	writeFile (QgsFeedback *feedback=nullptr)
	Writes the grid file.

Detailed Description

A class that does interpolation to a grid and writes the results to an ascii grid.

Definition at line 35 of file qgsgridfilewriter.h.

Constructor & Destructor Documentation

QgsGridFileWriter()

QgsGridFileWriter::QgsGridFileWriter	(	QgsInterpolator *	interpolator,
		const QString &	outputPath,
		const QgsRectangle &	extent,
		int	nCols,
		int	nRows
	)

Constructor for QgsGridFileWriter, for the specified interpolator.

The outputPath argument is used to set the output file path.

The extent and nCols, nRows arguments dictate the extent and size of the output raster.

Definition at line 27 of file qgsgridfilewriter.cpp.

Member Function Documentation

createOptions()

QStringList QgsGridFileWriter::createOptions ( ) const

inline

Returns the list of data source creation options which will be used when creating the output raster file.

See also

setCreateOptions()

Since

QGIS 3.44

Definition at line 70 of file qgsgridfilewriter.h.

noDataValue()

double QgsGridFileWriter::noDataValue ( ) const

inline

Returns no data value used for output file.

See also

setNoDataValue()

Since

QGIS 3.44

Definition at line 86 of file qgsgridfilewriter.h.

setCreateOptions()

void QgsGridFileWriter::setCreateOptions ( const QStringList &  list )

inline

Sets a list of data source creation options to use when creating the output raster file.

See also

createOptions()

Since

QGIS 3.44t

Definition at line 62 of file qgsgridfilewriter.h.

setNoDataValue()

void QgsGridFileWriter::setNoDataValue ( double  noDataValue )

inline

Set no data value for output file.

See also

noDataValue()

Since

QGIS 3.44

Definition at line 78 of file qgsgridfilewriter.h.

writeFile()

int QgsGridFileWriter::writeFile

(

QgsFeedback *

feedback = nullptr

)

Writes the grid file.

An optional feedback object can be set for progress reports and cancellation support

Returns

0 in case of success

Definition at line 37 of file qgsgridfilewriter.cpp.

---

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

• /build/qgis-3.43.0+git20250324+3ee7834ace6+99sid/src/analysis/interpolation/qgsgridfilewriter.h
• /build/qgis-3.43.0+git20250324+3ee7834ace6+99sid/src/analysis/interpolation/qgsgridfilewriter.cpp