QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
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 ()
 
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...
 
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...
 
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 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...
 
int size () const
 
QgsRasterInterfaceat (int idx) const
 
QgsRasterInterfacelast () const
 
bool setOn (int idx, bool on)
 Set interface at index on/off Returns true on success. More...
 
bool canSetOn (int idx, bool on)
 Test if interface at index may be swithed on/off. More...
 
QgsRasterDataProviderprovider () const
 
QgsRasterRendererrenderer () const
 
QgsRasterResampleFilterresampleFilter () const
 
QgsBrightnessContrastFilterbrightnessFilter () const
 
QgsHueSaturationFilterhueSaturationFilter () const
 
QgsRasterProjectorprojector () const
 
QgsRasterNullernuller () const
 

Detailed Description

Base class for processing modules.

Constructor & Destructor Documentation

QgsRasterPipe::QgsRasterPipe ( )
QgsRasterPipe::QgsRasterPipe ( const QgsRasterPipe thePipe)
QgsRasterPipe::~QgsRasterPipe ( )

Member Function Documentation

QgsRasterInterface* QgsRasterPipe::at ( int  idx) const
inline
QgsBrightnessContrastFilter * QgsRasterPipe::brightnessFilter ( ) const
bool QgsRasterPipe::canSetOn ( int  idx,
bool  on 
)

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

QgsHueSaturationFilter * QgsRasterPipe::hueSaturationFilter ( ) const
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.

QgsRasterInterface* QgsRasterPipe::last ( ) const
inline
QgsRasterNuller * QgsRasterPipe::nuller ( ) const
QgsRasterProjector * QgsRasterPipe::projector ( ) const
QgsRasterDataProvider * QgsRasterPipe::provider ( ) const
bool QgsRasterPipe::remove ( int  idx)

Remove and delete interface at given index if possible.

bool QgsRasterPipe::remove ( QgsRasterInterface theInterface)

Remove and delete interface from pipe if possible.

QgsRasterRenderer * QgsRasterPipe::renderer ( ) const
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.

QgsRasterResampleFilter * QgsRasterPipe::resampleFilter ( ) const
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.

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

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

int QgsRasterPipe::size ( void  ) const
inline

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