Add processedCount to report the number of processed objects

qgis · Nov 29, 2021 · 7e2eaec · 7e2eaec
1 parent 8f09f72
commit 7e2eaec
Show file tree

Hide file tree

Showing 3 changed files with 85 additions and 0 deletions.
diff --git a/python/core/auto_generated/qgsfeedback.sip.in b/python/core/auto_generated/qgsfeedback.sip.in
@@ -68,6 +68,31 @@ is in percentage and ranges from 0-100.
 .. seealso:: :py:func:`progressChanged`
 
 .. versionadded:: 3.0
+%End
+
+    unsigned long long processedCount() const /HoldGIL/;
+%Docstring
+Returns the current processed objects count reported by the feedback object. Depending on how the
+feedback object is used processed count reporting may not be supported. The returned value
+is an unsigned long integer and starts from 0.
+
+.. seealso:: :py:func:`setProcessedCount`
+
+.. seealso:: :py:func:`progressCountChanged`
+
+.. versionadded:: 3.24
+%End
+
+    void setProcessedCount( unsigned long long processedCount );
+%Docstring
+Sets the current processed objects count for the feedback object. The ``processedCount``
+argument is an unsigned long integer and starts from 0.
+
+.. seealso:: :py:func:`processedCount`
+
+.. seealso:: :py:func:`progressCountChanged`
+
+.. versionadded:: 3.24
 %End
 
   public slots:
@@ -94,10 +119,24 @@ argument is in percentage and ranges from 0-100.
 .. seealso:: :py:func:`progress`
 
 .. versionadded:: 3.0
+%End
+
+    void processedCountChanged( unsigned long long processedCount );
+%Docstring
+Emitted when the feedback object reports a change in the number of processed objects.
+Depending on how the feedback object is used processed count reporting may not be supported. The ``processedCount``
+argument is an unsigned long integer and starts from 0.
+
+.. seealso:: :py:func:`setProgress`
+
+.. seealso:: :py:func:`progress`
+
+.. versionadded:: 3.24
 %End
 
 };
 
+
 /************************************************************************
  * This file has been generated automatically from                      *
  *                                                                      *

diff --git a/src/core/qgsfeedback.h b/src/core/qgsfeedback.h
@@ -79,6 +79,29 @@ class CORE_EXPORT QgsFeedback : public QObject
      */
     double progress() const SIP_HOLDGIL { return mProgress; }
 
+    /**
+     * Returns the current processed objects count reported by the feedback object. Depending on how the
+     * feedback object is used processed count reporting may not be supported. The returned value
+     * is an unsigned long integer and starts from 0.
+     * \see setProcessedCount()
+     * \see progressCountChanged()
+     * \since QGIS 3.24
+     */
+    unsigned long long processedCount() const SIP_HOLDGIL { return mProcessedCount; }
+
+    /**
+     * Sets the current processed objects count for the feedback object. The \a processedCount
+     * argument is an unsigned long integer and starts from 0.
+     * \see processedCount()
+     * \see progressCountChanged()
+     * \since QGIS 3.24
+     */
+    void setProcessedCount( unsigned long long processedCount )
+    {
+      mProcessedCount = processedCount;
+      emit processedCountChanged( processedCount );
+    }
+
   public slots:
 
     //! Tells the internal routines that the current operation should be canceled. This should be run by the main thread
@@ -104,11 +127,23 @@ class CORE_EXPORT QgsFeedback : public QObject
      */
     void progressChanged( double progress );
 
+    /**
+     * Emitted when the feedback object reports a change in the number of processed objects.
+     * Depending on how the feedback object is used processed count reporting may not be supported. The \a processedCount
+     * argument is an unsigned long integer and starts from 0.
+     * \see setProgress()
+     * \see progress()
+     * \since QGIS 3.24
+     */
+    void processedCountChanged( unsigned long long processedCount );
+
   private:
     //! Whether the operation has been canceled already. False by default.
     bool mCanceled = false;
 
     double mProgress = 0.0;
+    unsigned long long mProcessedCount = 0;
 };
 
+
 #endif // QGSFEEDBACK_H
diff --git a/tests/src/python/test_qgsfeedback.py b/tests/src/python/test_qgsfeedback.py
@@ -40,6 +40,17 @@ def testProgress(self):
         self.assertEqual(len(progress_spy), 1)
         self.assertEqual(progress_spy[0][0], 25.0)
 
+    def testProcessedCount(self):
+        f = QgsFeedback()
+        self.assertEqual(f.processedCount(), 0)
+
+        processed_spy = QSignalSpy(f.processedCountChanged)
+
+        f.setProcessedCount(25)
+        self.assertEqual(f.processedCount(), 25)
+        self.assertEqual(len(processed_spy), 1)
+        self.assertEqual(processed_spy[0][0], 25)
+
 
 if __name__ == '__main__':
     unittest.main()