QGIS/python/core/auto_generated/qgsvectorlayerfeaturecounter.sip.in

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/qgsvectorlayerfeaturecounter.h                              *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/


class QgsVectorLayerFeatureCounter : QgsTask
{
%Docstring

Counts the features in a QgsVectorLayer in task.
You should most likely not use this directly and instead call
QgsVectorLayer.countSymbolFeatures() and connect to the signal
:py:func:`QgsVectorLayer.symbolFeatureCountMapChanged()`

.. versionadded:: 3.0
%End

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

    QgsVectorLayerFeatureCounter( QgsVectorLayer *layer, const QgsExpressionContext &context = QgsExpressionContext(), bool storeSymbolFids = false );
%Docstring
Create a new feature counter for ``layer``.

:param layer: Target QgsVectorLayer to perform counting on.
:param context: Specific QgsExpressionContext to use during the rendering step.
:param storeSymbolFids: If ``True`` will store the feature ids (fids), otherwise will only count the number of features per symbol. Default ``False``.
%End


    virtual bool run();

%Docstring
Calculates the feature count and Ids per symbol
%End


    long featureCount( const QString &legendKey ) const;
%Docstring
Returns the feature count for a particular ``legendKey``.
If the key has not been found, -1 will be returned.
%End


    QgsFeatureIds featureIds( const QString &symbolkey ) const;
%Docstring
Returns the feature Ids for a particular ``legendKey``.
If the key has not been found an empty QSet will be returned.

.. versionadded:: 3.10
%End

  signals:

    void symbolsCounted();
%Docstring
Emitted when the symbols have been counted.
%End

};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/qgsvectorlayerfeaturecounter.h                              *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/