Skip to content
Permalink
Browse files

Dox++

  • Loading branch information
nyalldawson committed Sep 25, 2018
1 parent d26f25c commit f4bbb147b2f319af9e0543d21d9454cee5f6a339
@@ -10,22 +10,31 @@




struct QgsRasterCalculatorEntry
class QgsRasterCalculatorEntry
{
%Docstring
Represents an individual raster layer/band number entry within a raster calculation.
%End

%TypeHeaderCode
#include "qgsrastercalculator.h"
%TypeHeaderCode
#include <qgsrastercalculator.h>
%End
%End
public:

QString ref;

QgsRasterLayer *raster;

QString ref; //name
QgsRasterLayer *raster; //pointer to rasterlayer
int bandNumber; //raster band number
int bandNumber;
};

class QgsRasterCalculator
{
%Docstring
Raster calculator class*
Performs raster layer calculations.
%End

%TypeHeaderCode
@@ -29,23 +29,41 @@
class QgsRasterLayer;
class QgsFeedback;


struct ANALYSIS_EXPORT QgsRasterCalculatorEntry
/**
* \ingroup analysis
* \class QgsRasterCalculatorEntry
* Represents an individual raster layer/band number entry within a raster calculation.
*/
class ANALYSIS_EXPORT QgsRasterCalculatorEntry
{
#ifdef SIP_RUN
% TypeHeaderCode
% TypeHeaderCode
#include <qgsrastercalculator.h>
% End
% End
#endif

QString ref; //name
QgsRasterLayer *raster; //pointer to rasterlayer
int bandNumber; //raster band number
public:

/**
* Name of entry.
*/
QString ref;

/**
* Raster layer associated with entry.
*/
QgsRasterLayer *raster = nullptr;

/**
* Band number for entry. Numbering for bands usually starts at 1 for the first band, not 0.
*/
int bandNumber = 1;
};

/**
* \ingroup analysis
* Raster calculator class*/
* Performs raster layer calculations.
*/
class ANALYSIS_EXPORT QgsRasterCalculator
{
public:

0 comments on commit f4bbb14

Please sign in to comment.
You can’t perform that action at this time.