QGIS API Documentation
3.0.2-Girona (307d082)
|
Base class for processing modules. More...
#include <qgsrasterpipe.h>
Public Types | |
enum | Role { UnknownRole = 0, ProviderRole = 1, RendererRole = 2, BrightnessRole = 3, ResamplerRole = 4, ProjectorRole = 5, NullerRole = 6, HueSaturationRole = 7 } |
Public Member Functions | |
QgsRasterPipe ()=default | |
Constructor for QgsRasterPipe. More... | |
QgsRasterPipe (const QgsRasterPipe &pipe) | |
~QgsRasterPipe () | |
QgsRasterInterface * | at (int idx) const |
QgsBrightnessContrastFilter * | brightnessFilter () const |
bool | canSetOn (int idx, bool on) |
Test if interface at index may be swithed on/off. More... | |
QgsHueSaturationFilter * | hueSaturationFilter () const |
bool | insert (int idx, QgsRasterInterface *interface) |
Try to insert interface at specified index and connect if connection would fail, the interface is not inserted and false is returned. More... | |
QgsRasterInterface * | last () const |
QgsRasterNuller * | nuller () const |
QgsRasterPipe & | operator= (const QgsRasterPipe &rh)=delete |
QgsRasterProjector * | projector () const |
QgsRasterDataProvider * | provider () const |
bool | remove (int idx) |
Remove and delete interface at given index if possible. More... | |
bool | remove (QgsRasterInterface *interface) |
Remove and delete interface from pipe if possible. More... | |
QgsRasterRenderer * | renderer () const |
bool | replace (int idx, QgsRasterInterface *interface) |
Try to replace interface at specified index and connect if connection would fail, the interface is not inserted and false is returned. More... | |
QgsRasterResampleFilter * | resampleFilter () const |
bool | set (QgsRasterInterface *interface) |
Insert a new known interface in default place or replace interface of the same role if it already exists. More... | |
bool | setOn (int idx, bool on) |
Set interface at index on/off Returns true on success. More... | |
int | size () const |
Base class for processing modules.
Definition at line 46 of file qgsrasterpipe.h.
enum QgsRasterPipe::Role |
Enumerator | |
---|---|
UnknownRole | |
ProviderRole | |
RendererRole | |
BrightnessRole | |
ResamplerRole | |
ProjectorRole | |
NullerRole | |
HueSaturationRole |
Definition at line 50 of file qgsrasterpipe.h.
|
default |
Constructor for QgsRasterPipe.
QgsRasterPipe::QgsRasterPipe | ( | const QgsRasterPipe & | pipe | ) |
Definition at line 32 of file qgsrasterpipe.cpp.
QgsRasterPipe::~QgsRasterPipe | ( | ) |
Definition at line 53 of file qgsrasterpipe.cpp.
|
inline |
Definition at line 111 of file qgsrasterpipe.h.
QgsBrightnessContrastFilter * QgsRasterPipe::brightnessFilter | ( | ) | const |
Definition at line 246 of file qgsrasterpipe.cpp.
bool QgsRasterPipe::canSetOn | ( | int | idx, |
bool | on | ||
) |
Test if interface at index may be swithed on/off.
Definition at line 299 of file qgsrasterpipe.cpp.
QgsHueSaturationFilter * QgsRasterPipe::hueSaturationFilter | ( | ) | const |
Definition at line 251 of file qgsrasterpipe.cpp.
bool QgsRasterPipe::insert | ( | int | idx, |
QgsRasterInterface * | interface | ||
) |
Try to insert interface at specified index and connect if connection would fail, the interface is not inserted and false is returned.
Definition at line 79 of file qgsrasterpipe.cpp.
|
inline |
Definition at line 112 of file qgsrasterpipe.h.
QgsRasterNuller * QgsRasterPipe::nuller | ( | ) | const |
Definition at line 261 of file qgsrasterpipe.cpp.
|
delete |
QgsRasterProjector * QgsRasterPipe::projector | ( | ) | const |
Definition at line 256 of file qgsrasterpipe.cpp.
QgsRasterDataProvider * QgsRasterPipe::provider | ( | ) | const |
Definition at line 231 of file qgsrasterpipe.cpp.
bool QgsRasterPipe::remove | ( | int | idx | ) |
Remove and delete interface at given index if possible.
Definition at line 266 of file qgsrasterpipe.cpp.
bool QgsRasterPipe::remove | ( | QgsRasterInterface * | interface | ) |
Remove and delete interface from pipe if possible.
Definition at line 292 of file qgsrasterpipe.cpp.
QgsRasterRenderer * QgsRasterPipe::renderer | ( | ) | const |
Definition at line 236 of file qgsrasterpipe.cpp.
bool QgsRasterPipe::replace | ( | int | idx, |
QgsRasterInterface * | interface | ||
) |
Try to replace interface at specified index and connect if connection would fail, the interface is not inserted and false is returned.
Definition at line 105 of file qgsrasterpipe.cpp.
QgsRasterResampleFilter * QgsRasterPipe::resampleFilter | ( | ) | const |
Definition at line 241 of file qgsrasterpipe.cpp.
bool QgsRasterPipe::set | ( | QgsRasterInterface * | interface | ) |
Insert a new known interface in default place or replace interface of the same role if it already exists.
Known interfaces are: QgsRasterDataProvider, QgsRasterRenderer, QgsRasterResampleFilter, QgsRasterProjector and their subclasses. For unknown interfaces it mus be explicitly specified position where it should be inserted using insert() method.
Definition at line 161 of file qgsrasterpipe.cpp.
bool QgsRasterPipe::setOn | ( | int | idx, |
bool | on | ||
) |
Set interface at index on/off Returns true on success.
Definition at line 319 of file qgsrasterpipe.cpp.
|
inline |
Definition at line 110 of file qgsrasterpipe.h.