Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :     qgscachedfeatureiterator.h
       3                 :            :      --------------------------------------
       4                 :            :     Date                 : 12.2.2013
       5                 :            :     Copyright            : (C) 2013 Matthias Kuhn
       6                 :            :     Email                : matthias at opengis dot ch
       7                 :            :  ***************************************************************************
       8                 :            :  *                                                                         *
       9                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      10                 :            :  *   it under the terms of the GNU General Public License as published by  *
      11                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      12                 :            :  *   (at your option) any later version.                                   *
      13                 :            :  *                                                                         *
      14                 :            :  ***************************************************************************/
      15                 :            : 
      16                 :            : #ifndef QGSCACHEDFEATUREITERATOR_H
      17                 :            : #define QGSCACHEDFEATUREITERATOR_H
      18                 :            : 
      19                 :            : #include "qgis_core.h"
      20                 :            : #include "qgsfeature.h"
      21                 :            : #include "qgsfeatureiterator.h"
      22                 :            : 
      23                 :            : class QgsVectorLayerCache;
      24                 :            : 
      25                 :            : /**
      26                 :            :  * \ingroup core
      27                 :            :  * \brief
      28                 :            :  * \brief Delivers features from the cache
      29                 :            :  *
      30                 :            :  */
      31                 :          0 : class CORE_EXPORT QgsCachedFeatureIterator : public QgsAbstractFeatureIterator
      32                 :            : {
      33                 :            :   public:
      34                 :            : 
      35                 :            :     /**
      36                 :            :      * This constructor creates a feature iterator, that delivers all cached features. No request is made to the backend.
      37                 :            :      *
      38                 :            :      * \param vlCache          The vector layer cache to use
      39                 :            :      * \param featureRequest   The feature request to answer
      40                 :            :      */
      41                 :            :     QgsCachedFeatureIterator( QgsVectorLayerCache *vlCache, const QgsFeatureRequest &featureRequest );
      42                 :            : 
      43                 :            :     /**
      44                 :            :      * Rewind to the beginning of the iterator
      45                 :            :      *
      46                 :            :      * \returns bool TRUE if the operation was OK
      47                 :            :      */
      48                 :            :     bool rewind() override;
      49                 :            : 
      50                 :            :     /**
      51                 :            :      * Close this iterator. No further features will be available.
      52                 :            :      *
      53                 :            :      * \returns TRUE if successful
      54                 :            :      */
      55                 :            :     bool close() override;
      56                 :            : 
      57                 :            :     // QgsAbstractFeatureIterator interface
      58                 :            :   protected:
      59                 :            : 
      60                 :            :     /**
      61                 :            :      * Implementation for fetching a feature.
      62                 :            :      *
      63                 :            :      * \param f      Will write to this feature
      64                 :            :      * \returns bool  TRUE if the operation was OK
      65                 :            :      *
      66                 :            :      * \see bool getFeature( QgsFeature& f )
      67                 :            :      */
      68                 :            :     bool fetchFeature( QgsFeature &f ) override;
      69                 :            : 
      70                 :            :     /**
      71                 :            :      * We have a local special iterator for FilterFids, no need to run the generic.
      72                 :            :      *
      73                 :            :      * \param f      Will write to this feature
      74                 :            :      * \returns bool  TRUE if the operation was OK
      75                 :            :      */
      76                 :          0 :     bool nextFeatureFilterFids( QgsFeature &f ) override { return fetchFeature( f ); }
      77                 :            : 
      78                 :            :   private:
      79                 :            :     QgsFeatureIds mFeatureIds;
      80                 :            :     QgsVectorLayerCache *mVectorLayerCache = nullptr;
      81                 :            :     QgsFeatureIds::ConstIterator mFeatureIdIterator;
      82                 :            :     QgsCoordinateTransform mTransform;
      83                 :            :     QgsRectangle mFilterRect;
      84                 :            : };
      85                 :            : 
      86                 :            : /**
      87                 :            :  * \ingroup core
      88                 :            :  * \brief
      89                 :            :  * \brief Uses another iterator as backend and writes features to the cache
      90                 :            :  *
      91                 :            :  */
      92                 :          0 : class CORE_EXPORT QgsCachedFeatureWriterIterator : public QgsAbstractFeatureIterator
      93                 :            : {
      94                 :            :   public:
      95                 :            : 
      96                 :            :     /**
      97                 :            :      * This constructor creates a feature iterator, which queries the backend and caches retrieved features.
      98                 :            :      *
      99                 :            :      * \param vlCache          The vector layer cache to use
     100                 :            :      * \param featureRequest   The feature request to answer
     101                 :            :      */
     102                 :            :     QgsCachedFeatureWriterIterator( QgsVectorLayerCache *vlCache, const QgsFeatureRequest &featureRequest );
     103                 :            : 
     104                 :            :     /**
     105                 :            :      * Rewind to the beginning of the iterator
     106                 :            :      *
     107                 :            :      * \returns bool TRUE if the operation was OK
     108                 :            :      */
     109                 :            :     bool rewind() override;
     110                 :            : 
     111                 :            :     /**
     112                 :            :      * Close this iterator. No further features will be available.
     113                 :            :      *
     114                 :            :      * \returns TRUE if successful
     115                 :            :      */
     116                 :            :     bool close() override;
     117                 :            : 
     118                 :            :   protected:
     119                 :            : 
     120                 :            :     /**
     121                 :            :      * Implementation for fetching a feature.
     122                 :            :      *
     123                 :            :      * \param f      Will write to this feature
     124                 :            :      * \returns bool  TRUE if the operation was OK
     125                 :            :      *
     126                 :            :      * \see bool getFeature( QgsFeature& f )
     127                 :            :      */
     128                 :            :     bool fetchFeature( QgsFeature &f ) override;
     129                 :            : 
     130                 :            :   private:
     131                 :            :     QgsFeatureIterator mFeatIt;
     132                 :            :     QgsVectorLayerCache *mVectorLayerCache = nullptr;
     133                 :            :     QgsFeatureIds mFids;
     134                 :            :     QgsCoordinateTransform mTransform;
     135                 :            :     QgsRectangle mFilterRect;
     136                 :            : };
     137                 :            : #endif // QGSCACHEDFEATUREITERATOR_H