-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgsfeaturesink.h
99 lines (82 loc) · 3.39 KB
/
qgsfeaturesink.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
/***************************************************************************
qgsfeaturesink.h
----------------
begin : April 2017
copyright : (C) 2017 by Nyall Dawson
email : nyall dot dawson at gmail dot com
***************************************************************************/
/***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef QGSFEATURESINK_H
#define QGSFEATURESINK_H
#include "qgis_core.h"
#include "qgis.h"
#include "qgsfeature.h"
#include "qgsfeatureiterator.h"
/**
* \class QgsFeatureSink
* \ingroup core
* An interface for objects which accept features via addFeature(s) methods.
*
* \since QGIS 3.0
*/
class CORE_EXPORT QgsFeatureSink
{
public:
virtual ~QgsFeatureSink() = default;
/**
* Adds a single \a feature to the sink.
* \see addFeatures()
* \returns true in case of success and false in case of failure
*/
virtual bool addFeature( QgsFeature &feature );
/**
* Adds a list of \a features to the sink.
* \see addFeature()
* \returns true in case of success and false in case of failure
*/
virtual bool addFeatures( QgsFeatureList &features ) = 0;
/**
* Adds all features from the specified \a iterator to the sink.
* \returns true if all features were added successfully, or false if any feature could not be added
*/
virtual bool addFeatures( QgsFeatureIterator &iterator );
};
/**
* \class QgsProxyFeatureSink
* \ingroup core
* 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'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.
*
* \since QGIS 3.0
*/
class CORE_EXPORT QgsProxyFeatureSink : public QgsFeatureSink
{
public:
/**
* Constructs a new QgsProxyFeatureSink which forwards features onto a destination \a sink.
*/
QgsProxyFeatureSink( QgsFeatureSink *sink );
bool addFeature( QgsFeature &feature ) override { return mSink->addFeature( feature ); }
bool addFeatures( QgsFeatureList &features ) override { return mSink->addFeatures( features ); }
bool addFeatures( QgsFeatureIterator &iterator ) override { return mSink->addFeatures( iterator ); }
/**
* Returns the destination QgsFeatureSink which the proxy will forward features to.
*/
QgsFeatureSink *destinationSink() { return mSink; }
private:
QgsFeatureSink *mSink;
};
Q_DECLARE_METATYPE( QgsFeatureSink * )
#endif // QGSFEATURESINK_H