QGIS API Documentation  2.12.0-Lyon
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsAbstractFeatureIteratorFromSource< T > Class Template Reference

Helper template that cares of two things: 1. More...

#include <qgsfeatureiterator.h>

Inheritance diagram for QgsAbstractFeatureIteratorFromSource< T >:
Inheritance graph
[legend]

Public Member Functions

 QgsAbstractFeatureIteratorFromSource (T *source, bool ownSource, const QgsFeatureRequest &request)
 
 ~QgsAbstractFeatureIteratorFromSource ()
 
- Public Member Functions inherited from QgsAbstractFeatureIterator
 QgsAbstractFeatureIterator (const QgsFeatureRequest &request)
 base class constructor - stores the iteration parameters More...
 
virtual ~QgsAbstractFeatureIterator ()
 destructor makes sure that the iterator is closed properly More...
 
virtual bool close ()=0
 end of iterating: free the resources / lock More...
 
virtual bool nextFeature (QgsFeature &f)
 fetch next feature, return true on success More...
 
virtual bool rewind ()=0
 reset the iterator to the starting position More...
 

Protected Member Functions

void iteratorClosed ()
 to be called by from subclass in close() More...
 
- Protected Member Functions inherited from QgsAbstractFeatureIterator
void deref ()
 remove reference, delete if refs == 0 More...
 
virtual bool fetchFeature (QgsFeature &f)=0
 If you write a feature iterator for your provider, this is the method you need to implement!! More...
 
virtual bool nextFeatureFilterExpression (QgsFeature &f)
 By default, the iterator will fetch all features and check if the feature matches the expression. More...
 
virtual bool nextFeatureFilterFids (QgsFeature &f)
 By default, the iterator will fetch all features and check if the id is in the request. More...
 
virtual bool prepareSimplification (const QgsSimplifyMethod &simplifyMethod)
 Setup the simplification of geometries to fetch using the specified simplify method. More...
 
void ref ()
 add reference More...
 

Protected Attributes

bool mOwnSource
 
T * mSource
 
- Protected Attributes inherited from QgsAbstractFeatureIterator
bool mClosed
 Set to true, as soon as the iterator is closed. More...
 
QgsFeatureRequest mRequest
 A copy of the feature request. More...
 
int refs
 reference counting (to allow seamless copying of QgsFeatureIterator instances) More...
 

Detailed Description

template<typename T>
class QgsAbstractFeatureIteratorFromSource< T >

Helper template that cares of two things: 1.

automatic deletion of source if owned by iterator, 2. notification of open/closed iterator

Definition at line 110 of file qgsfeatureiterator.h.

Constructor & Destructor Documentation

template<typename T>
QgsAbstractFeatureIteratorFromSource< T >::QgsAbstractFeatureIteratorFromSource ( T *  source,
bool  ownSource,
const QgsFeatureRequest request 
)
inline

Definition at line 113 of file qgsfeatureiterator.h.

Definition at line 119 of file qgsfeatureiterator.h.

Member Function Documentation

template<typename T>
void QgsAbstractFeatureIteratorFromSource< T >::iteratorClosed ( )
inlineprotected

to be called by from subclass in close()

Definition at line 127 of file qgsfeatureiterator.h.

Member Data Documentation

template<typename T>
bool QgsAbstractFeatureIteratorFromSource< T >::mOwnSource
protected

Definition at line 130 of file qgsfeatureiterator.h.

template<typename T>
T* QgsAbstractFeatureIteratorFromSource< T >::mSource
protected

Definition at line 129 of file qgsfeatureiterator.h.


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