Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Sipify core classes 2 #4493

Merged
merged 2 commits into from
May 3, 2017
Merged

Sipify core classes 2 #4493

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
05933b1
Sipify core.QgsFeatureFilterProvider
arnaud-morvan May 2, 2017
04a9264
Sipify core.QgsFeatureIterator
arnaud-morvan May 2, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 0 additions & 2 deletions python/auto_sip.blacklist
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ core/qgseditorwidgetsetup.sip
core/qgserror.sip
core/qgsexpressioncontext.sip
core/qgsexpressioncontextgenerator.sip
core/qgsfeaturefilterprovider.sip
core/qgsfeatureiterator.sip
core/qgsfeaturerequest.sip
core/qgsgeometrysimplifier.sip
core/qgsgeometryvalidator.sip
Expand Down
61 changes: 44 additions & 17 deletions python/core/qgsfeaturefilterprovider.sip
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,54 @@
/** \ingroup core
* \class QgsFeatureFilterProvider
* Abstract interface for use by classes that filter the features of a layer.
* A QgsFeatureFilterProvider provides a method for modifying a QgsFeatureRequest in place to apply
* additional filters to the request.
* \note added in QGIS 2.14
**/
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsfeaturefilterprovider.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/








class QgsFeatureFilterProvider
{
%TypeHeaderCode
#include <qgsfeaturefilterprovider.h>
%Docstring
Abstract interface for use by classes that filter the features of a layer.
A QgsFeatureFilterProvider provides a method for modifying a QgsFeatureRequest in place to apply
additional filters to the request.
.. versionadded:: 2.14
*
%End

%TypeHeaderCode
#include "qgsfeaturefilterprovider.h"
%End
public:

/** Add additional filters to the feature request to further restrict the features returned by the request.
* Derived classes must implement this method.
* @param layer the layer to filter
* @param featureRequest the feature request to update
*/

virtual void filterFeatures( const QgsVectorLayer *layer, QgsFeatureRequest &featureRequest ) const = 0;
%Docstring
Add additional filters to the feature request to further restrict the features returned by the request.
Derived classes must implement this method.
\param layer the layer to filter
\param featureRequest the feature request to update
%End

/** Create a clone of the feature filter provider
* @return a new clone
*/
virtual QgsFeatureFilterProvider *clone() const = 0 /Factory/;
%Docstring
Create a clone of the feature filter provider
:return: a new clone
:rtype: QgsFeatureFilterProvider
%End
};

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsfeaturefilterprovider.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
215 changes: 149 additions & 66 deletions python/core/qgsfeatureiterator.sip
View file
Open in desktop
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 *
************************************************************************/
4 changes: 4 additions & 0 deletions src/core/qgsfeaturefilterprovider.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,15 @@ class CORE_EXPORT QgsFeatureFilterProvider
{
public:

#ifndef SIP_RUN

//! Constructor
QgsFeatureFilterProvider() {}

virtual ~QgsFeatureFilterProvider() = default;

#endif

/** Add additional filters to the feature request to further restrict the features returned by the request.
* Derived classes must implement this method.
* \param layer the layer to filter
Expand Down