QGIS API Documentation 3.29.0-Master (ade4f0cf0f)
Static Public Member Functions | Public Attributes | List of all members
QgsRasterCalculatorEntry Class Reference

Represents an individual raster layer/band number entry within a raster calculation. More...

#include <qgsrastercalculator.h>

Static Public Member Functions

static QVector< QgsRasterCalculatorEntryrasterEntries ()
 Creates a list of raster entries from the current project. More...
 

Public Attributes

int bandNumber = 1
 Band number for entry. More...
 
QgsRasterLayerraster = nullptr
 Raster layer associated with entry. More...
 
QString ref
 Name of entry. More...
 

Detailed Description

Represents an individual raster layer/band number entry within a raster calculation.

Since
QGIS 2.18

Definition at line 40 of file qgsrastercalculator.h.

Member Function Documentation

◆ rasterEntries()

QVector< QgsRasterCalculatorEntry > QgsRasterCalculatorEntry::rasterEntries ( )
static

Creates a list of raster entries from the current project.

If there is more than one layer with the same data source only one of them is added to the list, duplicate names are also handled by appending an _n integer to the base name.

Returns
the list of raster entries form the current project
Since
QGIS 3.6

Definition at line 731 of file qgsrastercalculator.cpp.

Member Data Documentation

◆ bandNumber

int QgsRasterCalculatorEntry::bandNumber = 1

Band number for entry.

Numbering for bands usually starts at 1 for the first band, not 0.

Definition at line 70 of file qgsrastercalculator.h.

◆ raster

QgsRasterLayer* QgsRasterCalculatorEntry::raster = nullptr

Raster layer associated with entry.

Definition at line 65 of file qgsrastercalculator.h.

◆ ref

QString QgsRasterCalculatorEntry::ref

Name of entry.

Definition at line 60 of file qgsrastercalculator.h.


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