QGIS API Documentation  2.3.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
QgsCachedFeatureIterator Class Reference

Delivers features from the cache. More...

#include <qgscachedfeatureiterator.h>

Inheritance diagram for QgsCachedFeatureIterator:
Inheritance graph
[legend]
Collaboration diagram for QgsCachedFeatureIterator:
Collaboration graph
[legend]

Public Member Functions

 QgsCachedFeatureIterator (QgsVectorLayerCache *vlCache, QgsFeatureRequest featureRequest, QgsFeatureIds featureIds)
 This constructor creates a feature iterator, that delivers only cached information, based on the QgsFeatureIds. More...
 
 QgsCachedFeatureIterator (QgsVectorLayerCache *vlCache, QgsFeatureRequest featureRequest)
 This constructor creates a feature iterator, that delivers all cached features. More...
 
virtual bool rewind ()
 Rewind to the beginning of the iterator. More...
 
virtual bool close ()
 Close this iterator. More...
 
- 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 nextFeature (QgsFeature &f)
 fetch next feature, return true on success More...
 

Protected Member Functions

virtual bool fetchFeature (QgsFeature &f)
 Implementation for fetching a feature. More...
 
virtual bool nextFeatureFilterFids (QgsFeature &f)
 We have a local special iterator for FilterFids, no need to run the generic. More...
 
- Protected Member Functions inherited from QgsAbstractFeatureIterator
virtual bool nextFeatureFilterExpression (QgsFeature &f)
 By default, the iterator will fetch all features and check if the feature matches the expression. More...
 
void ref ()
 add reference More...
 
void deref ()
 remove reference, delete if refs == 0 More...
 
virtual bool prepareSimplification (const QgsSimplifyMethod &simplifyMethod)
 Setup the simplification of geometries to fetch using the specified simplify method. More...
 

Private Attributes

QgsFeatureIds mFeatureIds
 
QgsVectorLayerCachemVectorLayerCache
 
QgsFeatureIds::ConstIterator mFeatureIdIterator
 

Additional Inherited Members

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

Detailed Description

Delivers features from the cache.

Definition at line 29 of file qgscachedfeatureiterator.h.

Constructor & Destructor Documentation

QgsCachedFeatureIterator::QgsCachedFeatureIterator ( QgsVectorLayerCache vlCache,
QgsFeatureRequest  featureRequest,
QgsFeatureIds  featureIds 
)

This constructor creates a feature iterator, that delivers only cached information, based on the QgsFeatureIds.

No request is made to the backend.

Parameters
vlCacheThe vector layer cache to use
featureRequestThe feature request to answer
featureIdsThe feature ids to return
Deprecated:
Use QgsCachedFeatureIterator( QgsVectorLayerCache* vlCache, QgsFeatureRequest featureRequest ) instead

Definition at line 19 of file qgscachedfeatureiterator.cpp.

References close(), and mFeatureIdIterator.

QgsCachedFeatureIterator::QgsCachedFeatureIterator ( QgsVectorLayerCache vlCache,
QgsFeatureRequest  featureRequest 
)

This constructor creates a feature iterator, that delivers all cached features.

No request is made to the backend.

Parameters
vlCacheThe vector layer cache to use
featureRequestThe feature request to answer

Definition at line 30 of file qgscachedfeatureiterator.cpp.

References close(), QgsFeatureRequest::FilterFid, QgsFeatureRequest::filterFid(), QgsFeatureRequest::FilterFids, QgsFeatureRequest::filterFids(), QgsFeatureRequest::filterType(), QgsVectorLayerCache::mCache, mFeatureIdIterator, mFeatureIds, and mVectorLayerCache.

Member Function Documentation

bool QgsCachedFeatureIterator::close ( )
virtual

Close this iterator.

No further features will be available.

Returns
true if successful

Implements QgsAbstractFeatureIterator.

Definition at line 77 of file qgscachedfeatureiterator.cpp.

References QgsAbstractFeatureIterator::mClosed, and mFeatureIds.

Referenced by fetchFeature(), and QgsCachedFeatureIterator().

bool QgsCachedFeatureIterator::fetchFeature ( QgsFeature f)
protectedvirtual

Implementation for fetching a feature.

Parameters
fWill write to this feature
Returns
bool true if the operation was ok
See Also
bool getFeature( QgsFeature& f )

Implements QgsAbstractFeatureIterator.

Definition at line 55 of file qgscachedfeatureiterator.cpp.

References QgsFeatureRequest::acceptFeature(), close(), QgsVectorLayerCache::mCache, QgsAbstractFeatureIterator::mClosed, mFeatureIdIterator, mFeatureIds, QgsAbstractFeatureIterator::mRequest, and mVectorLayerCache.

virtual bool QgsCachedFeatureIterator::nextFeatureFilterFids ( QgsFeature f)
inlineprotectedvirtual

We have a local special iterator for FilterFids, no need to run the generic.

Parameters
fWill write to this feature
Returns
bool true if the operation was ok

Reimplemented from QgsAbstractFeatureIterator.

Definition at line 85 of file qgscachedfeatureiterator.h.

References QgsAbstractFeatureIterator::fetchFeature().

bool QgsCachedFeatureIterator::rewind ( )
virtual

Rewind to the beginning of the iterator.

Returns
bool true if the operation was ok

Implements QgsAbstractFeatureIterator.

Definition at line 71 of file qgscachedfeatureiterator.cpp.

References mFeatureIdIterator, and mFeatureIds.

Member Data Documentation

QgsFeatureIds::ConstIterator QgsCachedFeatureIterator::mFeatureIdIterator
private

Definition at line 90 of file qgscachedfeatureiterator.h.

Referenced by fetchFeature(), QgsCachedFeatureIterator(), and rewind().

QgsFeatureIds QgsCachedFeatureIterator::mFeatureIds
private

Definition at line 88 of file qgscachedfeatureiterator.h.

Referenced by close(), fetchFeature(), QgsCachedFeatureIterator(), and rewind().

QgsVectorLayerCache* QgsCachedFeatureIterator::mVectorLayerCache
private

Definition at line 89 of file qgscachedfeatureiterator.h.

Referenced by fetchFeature(), and QgsCachedFeatureIterator().


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