QgsFeatureStore Class Reference

A container for features with the same fields and crs. More...

#include <qgsfeaturestore.h>

Inheritance diagram for QgsFeatureStore:

Public Member Functions
	QgsFeatureStore ()=default
	Constructor. More...
	QgsFeatureStore (const QgsFields &fields, const QgsCoordinateReferenceSystem &crs)
	Constructor. More...
bool	addFeature (QgsFeature &feature, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) override
	Adds a single feature to the sink. More...
bool	addFeatures (QgsFeatureList &features, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) override
	Adds a list of features to the sink. More...
int	count () const
	Returns the number of features contained in the store. More...
QgsCoordinateReferenceSystem	crs () const
	Returns the store's coordinate reference system. More...
QgsFeatureList	features () const
	Returns the list of features contained in the store. More...
QgsFields	fields () const
	Returns the store's field list. More...
QMap< QString, QVariant >	params () const
	Returns the map of optional parameters. More...
void	setCrs (const QgsCoordinateReferenceSystem &crs)
	Sets the store's crs. More...
void	setFields (const QgsFields &fields)
	Sets the store's fields. More...
void	setParams (const QMap< QString, QVariant > &parameters)
	Sets a map of optional parameters for the store. More...
Public Member Functions inherited from QgsFeatureSink
virtual	~QgsFeatureSink ()=default
virtual bool	addFeature (QgsFeature &feature, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags())
	Adds a single feature to the sink. More...
virtual bool	addFeatures (QgsFeatureIterator &iterator, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags())
	Adds all features from the specified iterator to the sink. More...
virtual bool	addFeatures (QgsFeatureList &features, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags())=0
	Adds a list of features to the sink. More...
virtual bool	flushBuffer ()
	Flushes any internal buffer which may exist in the sink, causing any buffered features to be added to the sink's destination. More...
virtual QString	lastError () const
	Returns the most recent error encountered by the sink, e.g. More...

Additional Inherited Members
Public Types inherited from QgsFeatureSink
enum	Flag { FastInsert = 1 << 1 , RollBackOnErrors = 1 << 2 }
	Flags controlling how features are added to a sink. More...
enum	SinkFlag { RegeneratePrimaryKey = 1 << 1 }
	Flags that can be set on a QgsFeatureSink. More...

Detailed Description

A container for features with the same fields and crs.

Definition at line 32 of file qgsfeaturestore.h.

Constructor & Destructor Documentation

QgsFeatureStore() [1/2]

QgsFeatureStore::QgsFeatureStore ( )

default

Constructor.

QgsFeatureStore() [2/2]

QgsFeatureStore::QgsFeatureStore	(	const QgsFields &	fields,
		const QgsCoordinateReferenceSystem &	crs
	)

Constructor.

Definition at line 19 of file qgsfeaturestore.cpp.

Member Function Documentation

addFeature()

bool QgsFeatureStore::addFeature ( QgsFeature &  feature, QgsFeatureSink::Flags  flags = QgsFeatureSink::Flags()  )

overridevirtual

Adds a single feature to the sink.

Feature addition behavior is controlled by the specified flags.

See also

addFeatures()

Returns

true in case of success and false in case of failure

Reimplemented from QgsFeatureSink.

Definition at line 35 of file qgsfeaturestore.cpp.

addFeatures()

bool QgsFeatureStore::addFeatures ( QgsFeatureList &  features, QgsFeatureSink::Flags  flags = QgsFeatureSink::Flags()  )

overridevirtual

Adds a list of features to the sink.

Feature addition behavior is controlled by the specified flags.

See also

addFeature()

Returns

true in case of success and false in case of failure

Implements QgsFeatureSink.

Definition at line 43 of file qgsfeaturestore.cpp.

count()

int QgsFeatureStore::count ( ) const

inline

Returns the number of features contained in the store.

Definition at line 71 of file qgsfeaturestore.h.

crs()

QgsCoordinateReferenceSystem QgsFeatureStore::crs ( ) const

inline

Returns the store's coordinate reference system.

See also

setCrs()

Definition at line 57 of file qgsfeaturestore.h.

features()

QgsFeatureList QgsFeatureStore::features ( ) const

inline

Returns the list of features contained in the store.

Definition at line 93 of file qgsfeaturestore.h.

fields()

QgsFields QgsFeatureStore::fields ( ) const

inline

Returns the store's field list.

See also

setFields()

Definition at line 45 of file qgsfeaturestore.h.

params()

QMap< QString, QVariant > QgsFeatureStore::params ( ) const

inline

Returns the map of optional parameters.

See also

setParams()

Definition at line 105 of file qgsfeaturestore.h.

setCrs()

void QgsFeatureStore::setCrs ( const QgsCoordinateReferenceSystem &  crs )

inline

Sets the store's crs.

See also

crs()

Definition at line 63 of file qgsfeaturestore.h.

setFields()

void QgsFeatureStore::setFields

(

const QgsFields &

fields

)

Sets the store's fields.

Every contained feature's fields will be reset to match fields.

See also

fields()

Definition at line 25 of file qgsfeaturestore.cpp.

setParams()

void QgsFeatureStore::setParams ( const QMap< QString, QVariant > &  parameters )

inline

Sets a map of optional parameters for the store.

See also

params()

Definition at line 99 of file qgsfeaturestore.h.

---

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

• /build/qgis-3.28.0+99sid/src/core/qgsfeaturestore.h
• /build/qgis-3.28.0+99sid/src/core/qgsfeaturestore.cpp