qgsvectorlayerplotdatagatherer.h

Go to the documentation of this file.

/***************************************************************************
                         qgsvectorlayerplotdatagatherer.h
                         -----------------
    begin                : August 2025
    copyright            : (C) 2025 by Mathieu
    email                : mathieu at opengis dot ch
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSVECTORLAYERPLOTDATAGATHERER_H
#define QGSVECTORLAYERPLOTDATAGATHERER_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsplot.h"
#include "qgstaskmanager.h"
#include "qgsvectorlayerfeatureiterator.h"

class CORE_EXPORT QgsVectorLayerAbstractPlotDataGatherer : public QgsTask
{
    Q_OBJECT
 
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( QgsVectorLayerAbstractPlotDataGatherer *item = dynamic_cast< QgsVectorLayerAbstractPlotDataGatherer * >( sipCpp ) )
    {
      if ( dynamic_cast<QgsVectorLayerXyPlotDataGatherer *>( item ) != NULL )
      {
        sipType = sipType_QgsVectorLayerXyPlotDataGatherer;
      }
      else
      {
        sipType = sipType_QgsVectorLayerAbstractPlotDataGatherer;
      }
    }
    else
    {
      sipType = NULL;
    }
  SIP_END
#endif
 
  public:
 
    QgsVectorLayerAbstractPlotDataGatherer() = default;
    ~QgsVectorLayerAbstractPlotDataGatherer() override = default;

    virtual QgsPlotData data() const = 0;

    void setFeatureIterator( QgsFeatureIterator &iterator ) { mIterator = iterator; }

    void setExpressionContext( const QgsExpressionContext &context ) { mExpressionContext = context; }
 
  protected:
    QgsFeatureIterator mIterator;
    QgsExpressionContext mExpressionContext;
};
 

class CORE_EXPORT QgsVectorLayerXyPlotDataGatherer : public QgsVectorLayerAbstractPlotDataGatherer
{
    Q_OBJECT
 
  public:
    struct XySeriesDetails
    {
        explicit XySeriesDetails( const QString &name, const QString &xExpression, const QString &yExpression, const QString &filterExpression = QString() )
          : name( name )
          , xExpression( xExpression )
          , yExpression( yExpression )
          , filterExpression( filterExpression )
        {}
 
        QString name;
        QString xExpression;
        QString yExpression;
        QString filterExpression;
    };

    explicit QgsVectorLayerXyPlotDataGatherer( Qgis::PlotAxisType xAxisType = Qgis::PlotAxisType::Interval );
    ~QgsVectorLayerXyPlotDataGatherer() override = default;

    void setSeriesDetails( const QList<QgsVectorLayerXyPlotDataGatherer::XySeriesDetails> &details );

    void setPredefinedCategories( const QStringList &categories );

    void setXAxisType( Qgis::PlotAxisType xAxisType );
 
    bool run() override;
 
    QgsPlotData data() const override;
 
  protected:
    QgsPlotData mData;
 
  private:
    Qgis::PlotAxisType mXAxisType = Qgis::PlotAxisType::Interval;
    QList<QgsVectorLayerXyPlotDataGatherer::XySeriesDetails> mSeriesDetails;
    QStringList mPredefinedCategories;
};
 
#endif // QGSVECTORLAYERPLOTDATAGATHERER_H