qgsalgorithmdistancewithin.h

Go to the documentation of this file.

/***************************************************************************
                         qgsalgorithmdistancewithin.h
                         ---------------------
    begin                : August 2021
    copyright            : (C) 2021 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 QGSALGORITHMDISTANCEWITHIN_H
#define QGSALGORITHMDISTANCEWITHIN_H
 
#define SIP_NO_FILE
 
#include "qgis_sip.h"
#include "qgsprocessingalgorithm.h"
#include "qgsapplication.h"
 
 
 
class QgsDistanceWithinAlgorithm : public QgsProcessingAlgorithm
{
 
  protected:
 
    void addDistanceParameter();
    void process( const QgsProcessingContext &context, QgsFeatureSource *targetSource,
                  QgsFeatureSource *referenceSource,
                  double distance, const QgsProperty &distanceProperty,
                  const std::function< void( const QgsFeature & )> &handleFeatureFunction, bool onlyRequireTargetIds, QgsProcessingFeedback *feedback,
                  QgsExpressionContext &expressionContext );
 
  private:
 
    void processByIteratingOverTargetSource( const QgsProcessingContext &context, QgsFeatureSource *targetSource, QgsFeatureSource *referenceSource,
        double distance, const QgsProperty &distanceProperty,
        const std::function< void( const QgsFeature & )> &handleFeatureFunction, bool onlyRequireTargetIds,
        QgsProcessingFeedback *feedback, QgsExpressionContext &expressionContext );
    void processByIteratingOverReferenceSource( const QgsProcessingContext &context, QgsFeatureSource *targetSource, QgsFeatureSource *referenceSource,
        double distance,
        const std::function< void( const QgsFeature & )> &handleFeatureFunction, bool onlyRequireTargetIds, QgsProcessingFeedback *feedback );
};
 
 
class QgsSelectWithinDistanceAlgorithm : public QgsDistanceWithinAlgorithm
{
 
  public:
 
    QgsSelectWithinDistanceAlgorithm() = default;
    void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
    QIcon icon() const override { return QgsApplication::getThemeIcon( QStringLiteral( "/algorithms/mAlgorithmSelectDistance.svg" ) ); }
    QString svgIconPath() const override { return QgsApplication::iconPath( QStringLiteral( "/algorithms/mAlgorithmSelectDistance.svg" ) ); }
    QString name() const override;
    Flags flags() const override;
    QString displayName() const override;
    QStringList tags() const override;
    QString group() const override;
    QString groupId() const override;
    QString shortHelpString() const override;
    QgsSelectWithinDistanceAlgorithm *createInstance() const override SIP_FACTORY;
 
  protected:
 
    QVariantMap processAlgorithm( const QVariantMap &parameters,
                                  QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
 
};
 
class QgsExtractWithinDistanceAlgorithm : public QgsDistanceWithinAlgorithm
{
 
  public:
 
    QgsExtractWithinDistanceAlgorithm() = default;
    void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
    QString name() const override;
    QString displayName() const override;
    QStringList tags() const override;
    QString group() const override;
    QString groupId() const override;
    QString shortHelpString() const override;
    QgsExtractWithinDistanceAlgorithm *createInstance() const override SIP_FACTORY;
 
  protected:
 
    QVariantMap processAlgorithm( const QVariantMap &parameters,
                                  QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
 
};
 
 
#endif // QGSALGORITHMDISTANCEWITHIN_H