Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgsalgorithmnetworkanalysisbase.h
       3                 :            :                          ---------------------
       4                 :            :     begin                : July 2018
       5                 :            :     copyright            : (C) 2018 by Alexander Bruy
       6                 :            :     email                : alexander dot bruy at gmail dot com
       7                 :            :  ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #ifndef QGSALGORITHMNETWORKANALYSISBASE_H
      19                 :            : #define QGSALGORITHMNETWORKANALYSISBASE_H
      20                 :            : 
      21                 :            : #define SIP_NO_FILE
      22                 :            : 
      23                 :            : #include "qgis_sip.h"
      24                 :            : #include "qgsprocessingalgorithm.h"
      25                 :            : 
      26                 :            : #include "qgsgraph.h"
      27                 :            : #include "qgsgraphbuilder.h"
      28                 :            : #include "qgsvectorlayerdirector.h"
      29                 :            : #include "qgsapplication.h"
      30                 :            : 
      31                 :            : ///@cond PRIVATE
      32                 :            : 
      33                 :            : /**
      34                 :            :  * Base class for networkanalysis algorithms.
      35                 :            :  */
      36                 :          0 : class QgsNetworkAnalysisAlgorithmBase : public QgsProcessingAlgorithm
      37                 :            : {
      38                 :            :   public:
      39                 :            : 
      40                 :            :     QString group() const final;
      41                 :            :     QString groupId() const final;
      42                 :          0 :     QIcon icon() const override { return QgsApplication::getThemeIcon( QStringLiteral( "/algorithms/mAlgorithmNetworkAnalysis.svg" ) ); }
      43                 :          0 :     QString svgIconPath() const override { return QgsApplication::iconPath( QStringLiteral( "/algorithms/mAlgorithmNetworkAnalysis.svg" ) ); }
      44                 :            :     Flags flags() const override;
      45                 :            : 
      46                 :            :   protected:
      47                 :            : 
      48                 :            :     /**
      49                 :            :      * Adds common algorithm parameters.
      50                 :            :      */
      51                 :            :     void addCommonParams();
      52                 :            : 
      53                 :            :     /**
      54                 :            :      * Populates common parameters with values.
      55                 :            :      */
      56                 :            :     void loadCommonParams( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback );
      57                 :            : 
      58                 :            :     /**
      59                 :            :      * Loads point from the feature source for further processing.
      60                 :            :      */
      61                 :            :     void loadPoints( QgsFeatureSource *source, QVector< QgsPointXY > &points, QHash< int, QgsAttributes > &attributes, QgsProcessingContext &context, QgsProcessingFeedback *feedback );
      62                 :            : 
      63                 :            :     std::unique_ptr< QgsFeatureSource > mNetwork;
      64                 :          0 :     QgsVectorLayerDirector *mDirector = nullptr;
      65                 :            :     std::unique_ptr< QgsGraphBuilder > mBuilder;
      66                 :            :     std::unique_ptr< QgsGraph > mGraph;
      67                 :          0 :     double mMultiplier = 1;
      68                 :            : };
      69                 :            : 
      70                 :            : ///@endcond PRIVATE
      71                 :            : 
      72                 :            : #endif // QGSALGORITHMNETWORKANALYSISBASE_H
      73                 :            :