QGIS API Documentation
Public Types | Public Member Functions | List of all members
QgsRasterPipe Class Reference

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 ()
 
 QgsRasterPipe (const QgsRasterPipe &thePipe)
 
 ~QgsRasterPipe ()
 
QgsRasterInterfaceat (int idx) const
 
QgsBrightnessContrastFilterbrightnessFilter () const
 
bool canSetOn (int idx, bool on)
 Test if interface at index may be swithed on/off. More...
 
QgsHueSaturationFilterhueSaturationFilter () const
 
bool insert (int idx, QgsRasterInterface *theInterface)
 Try to insert interface at specified index and connect if connection would fail, the interface is not inserted and false is returned. More...
 
QgsRasterInterfacelast () const
 
QgsRasterNullernuller () const
 
QgsRasterProjectorprojector () const
 
QgsRasterDataProviderprovider () const
 
bool remove (int idx)
 Remove and delete interface at given index if possible. More...
 
bool remove (QgsRasterInterface *theInterface)
 Remove and delete interface from pipe if possible. More...
 
QgsRasterRendererrenderer () const
 
bool replace (int idx, QgsRasterInterface *theInterface)
 Try to replace interface at specified index and connect if connection would fail, the interface is not inserted and false is returned. More...
 
QgsRasterResampleFilterresampleFilter () const
 
bool set (QgsRasterInterface *theInterface)
 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
 

Detailed Description

Base class for processing modules.

Definition at line 41 of file qgsrasterpipe.h.

Member Enumeration Documentation

Enumerator
UnknownRole 
ProviderRole 
RendererRole 
BrightnessRole 
ResamplerRole 
ProjectorRole 
NullerRole 
HueSaturationRole 

Definition at line 45 of file qgsrasterpipe.h.

Constructor & Destructor Documentation

QgsRasterPipe::QgsRasterPipe ( )

Definition at line 25 of file qgsrasterpipe.cpp.

QgsRasterPipe::QgsRasterPipe ( const QgsRasterPipe thePipe)

Definition at line 29 of file qgsrasterpipe.cpp.

QgsRasterPipe::~QgsRasterPipe ( )

Definition at line 50 of file qgsrasterpipe.cpp.

Member Function Documentation

QgsRasterInterface* QgsRasterPipe::at ( int  idx) const
inline

Definition at line 85 of file qgsrasterpipe.h.

QgsBrightnessContrastFilter * QgsRasterPipe::brightnessFilter ( ) const

Definition at line 243 of file qgsrasterpipe.cpp.

bool QgsRasterPipe::canSetOn ( int  idx,
bool  on 
)

Test if interface at index may be swithed on/off.

Definition at line 296 of file qgsrasterpipe.cpp.

QgsHueSaturationFilter * QgsRasterPipe::hueSaturationFilter ( ) const

Definition at line 248 of file qgsrasterpipe.cpp.

bool QgsRasterPipe::insert ( int  idx,
QgsRasterInterface theInterface 
)

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 76 of file qgsrasterpipe.cpp.

QgsRasterInterface* QgsRasterPipe::last ( ) const
inline

Definition at line 86 of file qgsrasterpipe.h.

QgsRasterNuller * QgsRasterPipe::nuller ( ) const

Definition at line 258 of file qgsrasterpipe.cpp.

QgsRasterProjector * QgsRasterPipe::projector ( ) const

Definition at line 253 of file qgsrasterpipe.cpp.

QgsRasterDataProvider * QgsRasterPipe::provider ( ) const

Definition at line 228 of file qgsrasterpipe.cpp.

bool QgsRasterPipe::remove ( int  idx)

Remove and delete interface at given index if possible.

Definition at line 263 of file qgsrasterpipe.cpp.

bool QgsRasterPipe::remove ( QgsRasterInterface theInterface)

Remove and delete interface from pipe if possible.

Definition at line 289 of file qgsrasterpipe.cpp.

QgsRasterRenderer * QgsRasterPipe::renderer ( ) const

Definition at line 233 of file qgsrasterpipe.cpp.

bool QgsRasterPipe::replace ( int  idx,
QgsRasterInterface theInterface 
)

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 102 of file qgsrasterpipe.cpp.

QgsRasterResampleFilter * QgsRasterPipe::resampleFilter ( ) const

Definition at line 238 of file qgsrasterpipe.cpp.

bool QgsRasterPipe::set ( QgsRasterInterface theInterface)

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 158 of file qgsrasterpipe.cpp.

bool QgsRasterPipe::setOn ( int  idx,
bool  on 
)

Set interface at index on/off Returns true on success.

Definition at line 316 of file qgsrasterpipe.cpp.

int QgsRasterPipe::size ( ) const
inline

Definition at line 84 of file qgsrasterpipe.h.


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