QgsCachedFeatureIterator Class Reference

Delivers features from the cache. More...

#include <qgscachedfeatureiterator.h>

Inheritance diagram for QgsCachedFeatureIterator:

Collaboration diagram for QgsCachedFeatureIterator:

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.
	QgsCachedFeatureIterator (QgsVectorLayerCache *vlCache, QgsFeatureRequest featureRequest)
	This constructor creates a feature iterator, that delivers all cached features.
virtual bool	rewind ()
	Rewind to the beginning of the iterator.
virtual bool	close ()
	Close this iterator.
Public Member Functions inherited from QgsAbstractFeatureIterator
	QgsAbstractFeatureIterator (const QgsFeatureRequest &request)
	base class constructor - stores the iteration parameters
virtual	~QgsAbstractFeatureIterator ()
	destructor makes sure that the iterator is closed properly
virtual bool	nextFeature (QgsFeature &f)
	fetch next feature, return true on success

Protected Member Functions
virtual bool	fetchFeature (QgsFeature &f)
	Implementation for fetching a feature.
virtual bool	nextFeatureFilterFids (QgsFeature &f)
	We have a local special iterator for FilterFids, no need to run the generic.
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.
void	ref ()
	add reference
void	deref ()
	remove reference, delete if refs == 0
virtual bool	prepareSimplification (const QgsSimplifyMethod &simplifyMethod)
	Setup the simplification of geometries to fetch using the specified simplify method.

Private Attributes
QgsFeatureIds	mFeatureIds
QgsVectorLayerCache *	mVectorLayerCache
QgsFeatureIds::ConstIterator	mFeatureIdIterator

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

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

vlCache	The vector layer cache to use
featureRequest	The feature request to answer
featureIds	The 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

vlCache	The vector layer cache to use
featureRequest	The 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

f	Will 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

f	Will 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:

• /tmp/buildd/qgis-2.2.0+wheezy1/src/core/qgscachedfeatureiterator.h
• /tmp/buildd/qgis-2.2.0+wheezy1/src/core/qgscachedfeatureiterator.cpp