QGIS API Documentation: QgsVectorLayerFeatureSource Class Reference

QGIS API Documentation 3.32.0-Lima (311a8cb8a6)

Partial snapshot of vector layer's state (only the members necessary for access to features) More...

#include <qgsvectorlayerfeatureiterator.h>

Inheritance diagram for QgsVectorLayerFeatureSource:

Inheritance graph

[legend]

Classes
struct	JoinLayerSource
	Contains join layer source information prepared in a thread-safe way, ready for vector layer feature iterators with joins to utilize. More...

Public Member Functions
	QgsVectorLayerFeatureSource (const QgsVectorLayer *layer)
	Constructor for QgsVectorLayerFeatureSource. More...

	QgsVectorLayerFeatureSource (const QgsVectorLayerFeatureSource &other)=delete
	QgsVectorLayerFeatureSource cannot be copied. More...

	~QgsVectorLayerFeatureSource () override

QgsCoordinateReferenceSystem	crs () const
	Returns the coordinate reference system for features retrieved from this source. More...

QgsFields	fields () const
	Returns the fields that will be available for features that are retrieved from this source. More...

QgsFeatureIterator	getFeatures (const QgsFeatureRequest &request=QgsFeatureRequest()) override
	Gets an iterator for features matching the specified request. More...

QString	id () const
	Returns the layer id of the source layer. More...

QgsVectorLayerFeatureSource &	operator== (const QgsVectorLayerFeatureSource &other)=delete
	QgsVectorLayerFeatureSource cannot be copied. More...

Public Member Functions inherited from QgsAbstractFeatureSource
virtual	~QgsAbstractFeatureSource ()

virtual QgsFeatureIterator	getFeatures (const QgsFeatureRequest &request=QgsFeatureRequest())=0
	Gets an iterator for features matching the specified request. More...

Protected Attributes
QList< QgsField >	mAddedAttributes

QgsFeatureMap	mAddedFeatures

QgsChangedAttributesMap	mChangedAttributeValues

QgsGeometryMap	mChangedGeometries

QgsCoordinateReferenceSystem	mCrs

QgsAttributeList	mDeletedAttributeIds

QgsFeatureIds	mDeletedFeatureIds

std::unique_ptr< QgsExpressionFieldBuffer >	mExpressionFieldBuffer

QgsFields	mFields

bool	mHasEditBuffer

QString	mId

std::unique_ptr< QgsVectorLayerJoinBuffer >	mJoinBuffer

QMap< QString, JoinLayerSource >	mJoinSources
	Contains prepared join sources by layer ID. More...

QgsExpressionContextScope	mLayerScope

std::unique_ptr< QgsAbstractFeatureSource >	mProviderFeatureSource

Protected Attributes inherited from QgsAbstractFeatureSource
QSet< QgsAbstractFeatureIterator * >	mActiveIterators

Friends
class	QgsVectorLayerFeatureIterator

Additional Inherited Members
Protected Member Functions inherited from QgsAbstractFeatureSource
void	iteratorClosed (QgsAbstractFeatureIterator *it)

void	iteratorOpened (QgsAbstractFeatureIterator *it)

Detailed Description

Partial snapshot of vector layer's state (only the members necessary for access to features)

Definition at line 52 of file qgsvectorlayerfeatureiterator.h.

Constructor & Destructor Documentation

◆ QgsVectorLayerFeatureSource() [1/2]

QgsVectorLayerFeatureSource::QgsVectorLayerFeatureSource ( const QgsVectorLayer * layer )

explicit

Constructor for QgsVectorLayerFeatureSource.

Parameters

layer source layer

Definition at line 39 of file qgsvectorlayerfeatureiterator.cpp.

◆ QgsVectorLayerFeatureSource() [2/2]

QgsVectorLayerFeatureSource::QgsVectorLayerFeatureSource ( const QgsVectorLayerFeatureSource & other )

delete

QgsVectorLayerFeatureSource cannot be copied.

◆ ~QgsVectorLayerFeatureSource()

QgsVectorLayerFeatureSource::~QgsVectorLayerFeatureSource ( )

overridedefault

Member Function Documentation

◆ crs()

QgsCoordinateReferenceSystem QgsVectorLayerFeatureSource::crs ( ) const

Returns the coordinate reference system for features retrieved from this source.

Since: QGIS 3.0

Definition at line 126 of file qgsvectorlayerfeatureiterator.cpp.

◆ fields()

QgsFields QgsVectorLayerFeatureSource::fields ( ) const

Returns the fields that will be available for features that are retrieved from this source.

Since: QGIS 3.0

Definition at line 121 of file qgsvectorlayerfeatureiterator.cpp.

◆ getFeatures()

QgsFeatureIterator QgsVectorLayerFeatureSource::getFeatures ( const QgsFeatureRequest & request = QgsFeatureRequest() )

overridevirtual

Gets an iterator for features matching the specified request.

Parameters

request The request

Returns: A feature iterator

Implements QgsAbstractFeatureSource.

Definition at line 115 of file qgsvectorlayerfeatureiterator.cpp.

◆ id()

QString QgsVectorLayerFeatureSource::id ( ) const

Returns the layer id of the source layer.

Since: QGIS 3.4

Definition at line 131 of file qgsvectorlayerfeatureiterator.cpp.

◆ operator==()

QgsVectorLayerFeatureSource & QgsVectorLayerFeatureSource::operator== ( const QgsVectorLayerFeatureSource & other )

delete

QgsVectorLayerFeatureSource cannot be copied.

Friends And Related Function Documentation

◆ QgsVectorLayerFeatureIterator

friend class QgsVectorLayerFeatureIterator

friend

Definition at line 71 of file qgsvectorlayerfeatureiterator.h.

Member Data Documentation

◆ mAddedAttributes

QList<QgsField> QgsVectorLayerFeatureSource::mAddedAttributes

protected

Definition at line 142 of file qgsvectorlayerfeatureiterator.h.

◆ mAddedFeatures

QgsFeatureMap QgsVectorLayerFeatureSource::mAddedFeatures

protected

Definition at line 139 of file qgsvectorlayerfeatureiterator.h.

◆ mChangedAttributeValues

QgsChangedAttributesMap QgsVectorLayerFeatureSource::mChangedAttributeValues

protected

Definition at line 143 of file qgsvectorlayerfeatureiterator.h.

◆ mChangedGeometries

QgsGeometryMap QgsVectorLayerFeatureSource::mChangedGeometries

protected

Definition at line 140 of file qgsvectorlayerfeatureiterator.h.

◆ mCrs

QgsCoordinateReferenceSystem QgsVectorLayerFeatureSource::mCrs

protected

Definition at line 146 of file qgsvectorlayerfeatureiterator.h.

◆ mDeletedAttributeIds

QgsAttributeList QgsVectorLayerFeatureSource::mDeletedAttributeIds

protected

Definition at line 144 of file qgsvectorlayerfeatureiterator.h.

◆ mDeletedFeatureIds

QgsFeatureIds QgsVectorLayerFeatureSource::mDeletedFeatureIds

protected

Definition at line 141 of file qgsvectorlayerfeatureiterator.h.

◆ mExpressionFieldBuffer

std::unique_ptr< QgsExpressionFieldBuffer > QgsVectorLayerFeatureSource::mExpressionFieldBuffer

protected

Definition at line 126 of file qgsvectorlayerfeatureiterator.h.

◆ mFields

QgsFields QgsVectorLayerFeatureSource::mFields

protected

Definition at line 128 of file qgsvectorlayerfeatureiterator.h.

◆ mHasEditBuffer

bool QgsVectorLayerFeatureSource::mHasEditBuffer

protected

Definition at line 134 of file qgsvectorlayerfeatureiterator.h.

◆ mId

QString QgsVectorLayerFeatureSource::mId

protected

Definition at line 130 of file qgsvectorlayerfeatureiterator.h.

◆ mJoinBuffer

std::unique_ptr< QgsVectorLayerJoinBuffer > QgsVectorLayerFeatureSource::mJoinBuffer

protected

Definition at line 98 of file qgsvectorlayerfeatureiterator.h.

◆ mJoinSources

QMap< QString, JoinLayerSource > QgsVectorLayerFeatureSource::mJoinSources

protected

Contains prepared join sources by layer ID.

Definition at line 123 of file qgsvectorlayerfeatureiterator.h.

◆ mLayerScope

QgsExpressionContextScope QgsVectorLayerFeatureSource::mLayerScope

protected

Definition at line 132 of file qgsvectorlayerfeatureiterator.h.

◆ mProviderFeatureSource

std::unique_ptr< QgsAbstractFeatureSource > QgsVectorLayerFeatureSource::mProviderFeatureSource

protected

Definition at line 96 of file qgsvectorlayerfeatureiterator.h.

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

/build/qgis-3.32.0+99sid/src/core/vector/qgsvectorlayerfeatureiterator.h
/build/qgis-3.32.0+99sid/src/core/vector/qgsvectorlayerfeatureiterator.cpp