Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
05933b1
commit 04a9264
Showing
3 changed files
with
196 additions
and
71 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,125 +1,208 @@ | ||
| /************************************************************************ | ||
| * This file has been generated automatically from * | ||
| * * | ||
| * src/core/qgsfeatureiterator.h * | ||
| * * | ||
| * Do not edit manually ! Edit header and run scripts/sipify.pl again * | ||
| ************************************************************************/ | ||
|
|
||
|
|
||
|
|
||
| class QgsAbstractFeatureIterator | ||
| { | ||
| %Docstring | ||
| Internal feature iterator to be implemented within data providers | ||
| %End | ||
|
|
||
| %TypeHeaderCode | ||
| #include <qgsfeatureiterator.h> | ||
| #include "qgsfeatureiterator.h" | ||
| %End | ||
| public: | ||
|
|
||
| //! Status of expression compilation for filter expression requests | ||
| enum CompileStatus | ||
| { | ||
| NoCompilation, /*!< Expression could not be compiled or not attempt was made to compile expression */ | ||
| PartiallyCompiled, /*!< Expression was partially compiled, but extra checks need to be applied to features*/ | ||
| Compiled, /*!< Expression was fully compiled and delegated to data provider source*/ | ||
| NoCompilation, | ||
| PartiallyCompiled, | ||
| Compiled, | ||
| }; | ||
|
|
||
| //! base class constructor - stores the iteration parameters | ||
| QgsAbstractFeatureIterator( const QgsFeatureRequest &request ); | ||
| %Docstring | ||
| base class constructor - stores the iteration parameters | ||
| %End | ||
|
|
||
| //! destructor makes sure that the iterator is closed properly | ||
| virtual ~QgsAbstractFeatureIterator(); | ||
| %Docstring | ||
| destructor makes sure that the iterator is closed properly | ||
| %End | ||
|
|
||
| //! fetch next feature, return true on success | ||
| virtual bool nextFeature( QgsFeature &f ); | ||
| %Docstring | ||
| fetch next feature, return true on success | ||
| :rtype: bool | ||
| %End | ||
|
|
||
| //! reset the iterator to the starting position | ||
| virtual bool rewind() = 0; | ||
| //! end of iterating: free the resources / lock | ||
| %Docstring | ||
| reset the iterator to the starting position | ||
| :rtype: bool | ||
| %End | ||
| virtual bool close() = 0; | ||
| %Docstring | ||
| end of iterating: free the resources / lock | ||
| :rtype: bool | ||
| %End | ||
|
|
||
|
|
||
| /** Returns the status of expression compilation for filter expression requests. | ||
| * @note added in QGIS 2.16 | ||
| */ | ||
| CompileStatus compileStatus() const; | ||
| %Docstring | ||
| Returns the status of expression compilation for filter expression requests. | ||
| .. versionadded:: 2.16 | ||
| :rtype: CompileStatus | ||
| %End | ||
|
|
||
| protected: | ||
| /** | ||
| * If you write a feature iterator for your provider, this is the method you | ||
| * need to implement!! | ||
| * | ||
| * @param f The feature to write to | ||
| * @return true if a feature was written to f | ||
| */ | ||
|
|
||
| virtual bool fetchFeature( QgsFeature &f ) = 0; | ||
| %Docstring | ||
| If you write a feature iterator for your provider, this is the method you | ||
| need to implement!! | ||
|
|
||
| \param f The feature to write to | ||
| :return: true if a feature was written to f | ||
| :rtype: bool | ||
| %End | ||
|
|
||
| /** | ||
| * By default, the iterator will fetch all features and check if the feature | ||
| * matches the expression. | ||
| * If you have a more sophisticated metodology (SQL request for the features...) | ||
| * and you check for the expression in your fetchFeature method, you can just | ||
| * redirect this call to fetchFeature so the default check will be omitted. | ||
| * | ||
| * @param f The feature to write to | ||
| * @return true if a feature was written to f | ||
| */ | ||
| virtual bool nextFeatureFilterExpression( QgsFeature &f ); | ||
| %Docstring | ||
| By default, the iterator will fetch all features and check if the feature | ||
| matches the expression. | ||
| If you have a more sophisticated metodology (SQL request for the features...) | ||
| and you check for the expression in your fetchFeature method, you can just | ||
| redirect this call to fetchFeature so the default check will be omitted. | ||
|
|
||
| \param f The feature to write to | ||
| :return: true if a feature was written to f | ||
| :rtype: bool | ||
| %End | ||
|
|
||
| /** | ||
| * By default, the iterator will fetch all features and check if the id | ||
| * is in the request. | ||
| * If you have a more sophisticated metodology (SQL request for the features...) | ||
| * and you are sure, that any feature you return from fetchFeature will match | ||
| * if the request was FilterFids you can just redirect this call to fetchFeature | ||
| * so the default check will be omitted. | ||
| * | ||
| * @param f The feature to write to | ||
| * @return true if a feature was written to f | ||
| */ | ||
| virtual bool nextFeatureFilterFids( QgsFeature &f ); | ||
| %Docstring | ||
| By default, the iterator will fetch all features and check if the id | ||
| is in the request. | ||
| If you have a more sophisticated metodology (SQL request for the features...) | ||
| and you are sure, that any feature you return from fetchFeature will match | ||
| if the request was FilterFids you can just redirect this call to fetchFeature | ||
| so the default check will be omitted. | ||
|
|
||
| \param f The feature to write to | ||
| :return: true if a feature was written to f | ||
| :rtype: bool | ||
| %End | ||
|
|
||
|
|
||
|
|
||
|
|
||
| void ref(); | ||
| %Docstring | ||
| Add reference | ||
| %End | ||
| void deref(); | ||
| %Docstring | ||
| Remove reference, delete if refs == 0 | ||
| %End | ||
|
|
||
|
|
||
| void ref(); //!< add reference | ||
| void deref(); //!< remove reference, delete if refs == 0 | ||
|
|
||
| //! Setup the simplification of geometries to fetch using the specified simplify method | ||
| virtual bool prepareSimplification( const QgsSimplifyMethod &simplifyMethod ); | ||
| %Docstring | ||
| Setup the simplification of geometries to fetch using the specified simplify method | ||
| :rtype: bool | ||
| %End | ||
|
|
||
| }; | ||
|
|
||
|
|
||
| class QgsFeatureIterator | ||
| { | ||
| %TypeHeaderCode | ||
| #include <qgsfeatureiterator.h> | ||
| %Docstring | ||
| Wrapper for iterator of features from vector data provider or vector layer | ||
| %End | ||
|
|
||
| %TypeHeaderCode | ||
| #include "qgsfeatureiterator.h" | ||
| %End | ||
| public: | ||
|
|
||
| QgsFeatureIterator *__iter__(); | ||
| %Docstring | ||
| :rtype: QgsFeatureIterator | ||
| %End | ||
| %MethodCode | ||
| sipRes = sipCpp; | ||
| sipRes = sipCpp; | ||
| %End | ||
|
|
||
| SIP_PYOBJECT __next__(); | ||
| SIP_PYOBJECT __next__(); | ||
| %MethodCode | ||
| QgsFeature *f = new QgsFeature; | ||
| if (sipCpp->nextFeature(*f)) | ||
| sipRes = sipConvertFromType(f, sipType_QgsFeature, Py_None); | ||
| else | ||
| { | ||
| delete f; | ||
| PyErr_SetString(PyExc_StopIteration,""); | ||
| } | ||
| QgsFeature *f = new QgsFeature; | ||
| if ( sipCpp->nextFeature( *f ) ) | ||
| sipRes = sipConvertFromType( f, sipType_QgsFeature, Py_None ); | ||
| else | ||
| { | ||
| delete f; | ||
| PyErr_SetString( PyExc_StopIteration, "" ); | ||
| } | ||
| %End | ||
|
|
||
| //! construct invalid iterator | ||
| QgsFeatureIterator(); | ||
| //! construct a valid iterator | ||
| // QgsFeatureIterator( QgsAbstractFeatureIterator *iter ); | ||
| //! copy constructor copies the iterator, increases ref.count | ||
| %Docstring | ||
| construct invalid iterator | ||
| %End | ||
| QgsFeatureIterator( const QgsFeatureIterator &fi ); | ||
| //! destructor deletes the iterator if it has no more references | ||
| %Docstring | ||
| copy constructor copies the iterator, increases ref.count | ||
| %End | ||
| ~QgsFeatureIterator(); | ||
| %Docstring | ||
| destructor deletes the iterator if it has no more references | ||
| %End | ||
|
|
||
| // QgsFeatureIterator &operator=(const QgsFeatureIterator &other); | ||
|
|
||
| bool nextFeature( QgsFeature &f ); | ||
| %Docstring | ||
| :rtype: bool | ||
| %End | ||
| bool rewind(); | ||
| %Docstring | ||
| :rtype: bool | ||
| %End | ||
| bool close(); | ||
| %Docstring | ||
| :rtype: bool | ||
| %End | ||
|
|
||
| //! find out whether the iterator is still valid or closed already | ||
| bool isClosed() const; | ||
| %Docstring | ||
| find out whether the iterator is still valid or closed already | ||
| :rtype: bool | ||
| %End | ||
|
|
||
|
|
||
| /** Returns the status of expression compilation for filter expression requests. | ||
| * @note added in QGIS 2.16 | ||
| */ | ||
| QgsAbstractFeatureIterator::CompileStatus compileStatus() const; | ||
| %Docstring | ||
| Returns the status of expression compilation for filter expression requests. | ||
| .. versionadded:: 2.16 | ||
| :rtype: QgsAbstractFeatureIterator.CompileStatus | ||
| %End | ||
|
|
||
|
|
||
| }; | ||
|
|
||
|
|
||
| /************************************************************************ | ||
| * This file has been generated automatically from * | ||
| * * | ||
| * src/core/qgsfeatureiterator.h * | ||
| * * | ||
| * Do not edit manually ! Edit header and run scripts/sipify.pl again * | ||
| ************************************************************************/ |
Oops, something went wrong.