QGIS/python/analysis/auto_generated/interpolation/qgsgridfilewriter.sip.in

87 lines
2.6 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/analysis/interpolation/qgsgridfilewriter.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsGridFileWriter
{
%Docstring(signature="appended")
Handles interpolation to a grid and writes the results to a raster grid file.
%End
%TypeHeaderCode
#include "qgsgridfilewriter.h"
%End
public:
QgsGridFileWriter( QgsInterpolator *interpolator, const QString &outputPath, const QgsRectangle &extent, int nCols, int nRows );
%Docstring
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.
%End
int writeFile( QgsFeedback *feedback = 0 );
%Docstring
Writes the grid file.
An optional ``feedback`` object can be set for progress reports and cancellation support
:return: 0 in case of success
%End
void setCreateOptions( const QStringList &list );
%Docstring
Sets a list of data source creation options to use when creating the output raster file.
.. seealso:: :py:func:`createOptions`
.. versionadded:: 3.44
%End
QStringList createOptions() const;
%Docstring
Returns the list of data source creation options which will be used when creating the output raster file.
.. seealso:: :py:func:`setCreateOptions`
.. versionadded:: 3.44
%End
void setNoDataValue( double noDataValue );
%Docstring
Set no data value for output file.
.. seealso:: :py:func:`noDataValue`
.. versionadded:: 3.44
%End
double noDataValue() const;
%Docstring
Returns no data value used for output file.
.. seealso:: :py:func:`setNoDataValue`
.. versionadded:: 3.44
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/analysis/interpolation/qgsgridfilewriter.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/