sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-03-03 00:02:25 -05:00
Code Issues Packages Projects Releases Wiki Activity
QGIS/python/core/auto_generated/qgsfeaturesink.sip.in

87 lines
2.8 KiB
Plaintext
Raw Normal View History

Add a QgsFeatureSink interface for classes which accept adding features
2017-04-26 10:39:57 +10:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsfeaturesink.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsFeatureSink
{
%Docstring
run sipify
2017-12-15 10:36:55 -04:00
An interface for objects which accept features via addFeature(s) methods.
Add a QgsFeatureSink interface for classes which accept adding features
2017-04-26 10:39:57 +10:00
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgsfeaturesink.h"
%End
public:
Ignore FID field when merging vector layers to geopackage
2018-10-19 12:35:50 +02:00
enum SinkFlag
{
RegeneratePrimaryKey,
};
typedef QFlags<QgsFeatureSink::SinkFlag> SinkFlags;
Add a flag argument to QgsFeatureSink::addFeatures Flags can be used to control how features are added to the sink. For now, there's only a single flag available - FastInsert. When FastInsert is set, faster inserts will be use at the cost of updating the passed features to reflect changes made at the provider. This includes skipping the update of the passed feature IDs to match the resulting feature IDs for the feature within the data provider. Individual sink subclasses may or may not choose to respect this flag, depending on whether or not skipping this update represents a significant speed boost for the operation. QgsVectorLayer always ignores the flag - feature ids are required for the featureAdded signal to be correctly emitted, and it's expected that performance critical applications will add features directly to a data provider instead of via QgsVectorLayer's edit buffer.
2017-06-15 12:08:43 +10:00
enum Flag
{
FastInsert,
};
typedef QFlags<QgsFeatureSink::Flag> Flags;
Add a QgsFeatureSink interface for classes which accept adding features
2017-04-26 10:39:57 +10:00
virtual ~QgsFeatureSink();
Add a flag argument to QgsFeatureSink::addFeatures Flags can be used to control how features are added to the sink. For now, there's only a single flag available - FastInsert. When FastInsert is set, faster inserts will be use at the cost of updating the passed features to reflect changes made at the provider. This includes skipping the update of the passed feature IDs to match the resulting feature IDs for the feature within the data provider. Individual sink subclasses may or may not choose to respect this flag, depending on whether or not skipping this update represents a significant speed boost for the operation. QgsVectorLayer always ignores the flag - feature ids are required for the featureAdded signal to be correctly emitted, and it's expected that performance critical applications will add features directly to a data provider instead of via QgsVectorLayer's edit buffer.
2017-06-15 12:08:43 +10:00
virtual bool addFeature( QgsFeature &feature, QgsFeatureSink::Flags flags = 0 );
Add a QgsFeatureSink interface for classes which accept adding features
2017-04-26 10:39:57 +10:00
%Docstring
run sipify
2017-12-15 10:36:55 -04:00
Adds a single ``feature`` to the sink. Feature addition behavior is controlled by the specified ``flags``.
[sipify] fix bad handling of \see within sentences and other docstrings improvements
2018-01-09 17:26:37 -04:00
.. seealso:: :py:func:`addFeatures`
run sipify
2017-12-15 10:36:55 -04:00
Sipify
2019-02-26 19:54:09 +10:00
:return: ``True`` in case of success and ``False`` in case of failure
Add a QgsFeatureSink interface for classes which accept adding features
2017-04-26 10:39:57 +10:00
%End
Add a flag argument to QgsFeatureSink::addFeatures Flags can be used to control how features are added to the sink. For now, there's only a single flag available - FastInsert. When FastInsert is set, faster inserts will be use at the cost of updating the passed features to reflect changes made at the provider. This includes skipping the update of the passed feature IDs to match the resulting feature IDs for the feature within the data provider. Individual sink subclasses may or may not choose to respect this flag, depending on whether or not skipping this update represents a significant speed boost for the operation. QgsVectorLayer always ignores the flag - feature ids are required for the featureAdded signal to be correctly emitted, and it's expected that performance critical applications will add features directly to a data provider instead of via QgsVectorLayer's edit buffer.
2017-06-15 12:08:43 +10:00
virtual bool addFeatures( QgsFeatureList &features, QgsFeatureSink::Flags flags = 0 ) = 0;
Add a QgsFeatureSink interface for classes which accept adding features
2017-04-26 10:39:57 +10:00
%Docstring
run sipify
2017-12-15 10:36:55 -04:00
Adds a list of ``features`` to the sink. Feature addition behavior is controlled by the specified ``flags``.
[sipify] fix bad handling of \see within sentences and other docstrings improvements
2018-01-09 17:26:37 -04:00
.. seealso:: :py:func:`addFeature`
run sipify
2017-12-15 10:36:55 -04:00
Sipify
2019-02-26 19:54:09 +10:00
:return: ``True`` in case of success and ``False`` in case of failure
Add a QgsFeatureSink interface for classes which accept adding features
2017-04-26 10:39:57 +10:00
%End
Add a flag argument to QgsFeatureSink::addFeatures Flags can be used to control how features are added to the sink. For now, there's only a single flag available - FastInsert. When FastInsert is set, faster inserts will be use at the cost of updating the passed features to reflect changes made at the provider. This includes skipping the update of the passed feature IDs to match the resulting feature IDs for the feature within the data provider. Individual sink subclasses may or may not choose to respect this flag, depending on whether or not skipping this update represents a significant speed boost for the operation. QgsVectorLayer always ignores the flag - feature ids are required for the featureAdded signal to be correctly emitted, and it's expected that performance critical applications will add features directly to a data provider instead of via QgsVectorLayer's edit buffer.
2017-06-15 12:08:43 +10:00
virtual bool addFeatures( QgsFeatureIterator &iterator, QgsFeatureSink::Flags flags = 0 );
Add a method to QgsFeatureSink to add all features from an iterator
2017-04-26 11:43:47 +10:00
%Docstring
run sipify
2017-12-15 10:36:55 -04:00
Adds all features from the specified ``iterator`` to the sink. Feature addition behavior is controlled by the specified ``flags``.
Sipify
2019-02-26 19:54:09 +10:00
:return: ``True`` if all features were added successfully, or ``False`` if any feature could not be added
Add a method to QgsFeatureSink to add all features from an iterator
2017-04-26 11:43:47 +10:00
%End
Move flushBuffer method up to QgsFeatureSink Allows calling flushBuffer on QgsFeatureSink objects, ensuring that any internal buffer the sink may have is flushed
2017-06-30 09:20:56 +10:00
virtual bool flushBuffer();
%Docstring
run sipify
2017-12-15 10:36:55 -04:00
Flushes any internal buffer which may exist in the sink, causing any buffered features to be added to the sink's destination.
Sipify
2019-02-26 19:54:09 +10:00
:return: ``False`` if any buffered features could not be added to the sink.
Move flushBuffer method up to QgsFeatureSink Allows calling flushBuffer on QgsFeatureSink objects, ensuring that any internal buffer the sink may have is flushed
2017-06-30 09:20:56 +10:00
%End
Add a QgsFeatureSink interface for classes which accept adding features
2017-04-26 10:39:57 +10:00
};
Add a flag argument to QgsFeatureSink::addFeatures Flags can be used to control how features are added to the sink. For now, there's only a single flag available - FastInsert. When FastInsert is set, faster inserts will be use at the cost of updating the passed features to reflect changes made at the provider. This includes skipping the update of the passed feature IDs to match the resulting feature IDs for the feature within the data provider. Individual sink subclasses may or may not choose to respect this flag, depending on whether or not skipping this update represents a significant speed boost for the operation. QgsVectorLayer always ignores the flag - feature ids are required for the featureAdded signal to be correctly emitted, and it's expected that performance critical applications will add features directly to a data provider instead of via QgsVectorLayer's edit buffer.
2017-06-15 12:08:43 +10:00
QFlags<QgsFeatureSink::Flag> operator|(QgsFeatureSink::Flag f1, QFlags<QgsFeatureSink::Flag> f2);
Add QgsProxyFeatureSink A simple feature sink which proxies feature addition on to another feature sink. This class is designed to allow factory methods which always return new QgsFeatureSink objects. Since it is not always possible to create an entirely new QgsFeatureSink (e.g. if the feature sink is a layer or a layer's data provider), a new QgsProxyFeatureSink can instead be returned which forwards features on to the destination sink. The proxy sink can be safely deleted without affecting the destination sink.
2017-05-03 16:56:37 +10:00
Add a QgsFeatureSink interface for classes which accept adding features
2017-04-26 10:39:57 +10:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsfeaturesink.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
Reference in New Issue Copy Permalink