qgsalgorithmrandompointsonlines.h

Go to the documentation of this file.

/***************************************************************************
                         qgsalgorithmrandompointsonlines.h
                         ---------------------
    begin                : March 2020
    copyright            : (C) 2020 by Håvard Tveite
    email                : havard dot tveite at nmbu dot no
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 QGSALGORITHMRANDOMPOINTSONLINES_H
#define QGSALGORITHMRANDOMPOINTSONLINES_H
 
#define SIP_NO_FILE
 
#include "qgis_sip.h"
#include "qgsprocessingalgorithm.h"
#include "qgsapplication.h"
 
 
class QgsRandomPointsOnLinesAlgorithm : public QgsProcessingAlgorithm
{
  public:
    QgsRandomPointsOnLinesAlgorithm() = default;
    void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
    QIcon icon() const override { return QgsApplication::getThemeIcon( QStringLiteral( "/algorithms/mAlgorithmRandomPointsOnLines.svg" ) ); }
    QString svgIconPath() const override { return QgsApplication::iconPath( QStringLiteral( "/algorithms/mAlgorithmRandomPointsOnLines.svg" ) ); }
    QString name() const override;
    QString displayName() const override;
    QStringList tags() const override;
    QString group() const override;
    QString groupId() const override;
    QString shortHelpString() const override;
    QgsRandomPointsOnLinesAlgorithm *createInstance() const override SIP_FACTORY;
 
  protected:
    bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * ) override;
    QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
 
 
  private:
    // The algorithm parameter names:
    static inline const QString INPUT = QStringLiteral( "INPUT" );
    static inline const QString POINTS_NUMBER = QStringLiteral( "POINTS_NUMBER" );
    static inline const QString MIN_DISTANCE_GLOBAL = QStringLiteral( "MIN_DISTANCE_GLOBAL" );
    static inline const QString MIN_DISTANCE = QStringLiteral( "MIN_DISTANCE" );
    static inline const QString MAX_TRIES_PER_POINT = QStringLiteral( "MAX_TRIES_PER_POINT" );
    static inline const QString SEED = QStringLiteral( "SEED" );
    static inline const QString INCLUDE_LINE_ATTRIBUTES = QStringLiteral( "INCLUDE_LINE_ATTRIBUTES" );
    static inline const QString OUTPUT = QStringLiteral( "OUTPUT" );
    static inline const QString OUTPUT_POINTS = QStringLiteral( "OUTPUT_POINTS" );
    static inline const QString POINTS_MISSED = QStringLiteral( "POINTS_MISSED" );
    static inline const QString LINES_WITH_MISSED_POINTS = QStringLiteral( "LINES_WITH_MISSED_POINTS" );
    static inline const QString FEATURES_WITH_EMPTY_OR_NO_GEOMETRY = QStringLiteral( "FEATURES_WITH_EMPTY_OR_NO_GEOMETRY" );
 
    int mNumPoints = 0;
    bool mDynamicNumPoints = false;
    QgsProperty mNumPointsProperty;
 
    double mMinDistance = 0;
    bool mDynamicMinDistance = false;
    QgsProperty mMinDistanceProperty;
 
    double mMinDistanceGlobal = 0;
 
    int mMaxAttempts = 10;
    bool mDynamicMaxAttempts = false;
    QgsProperty mMaxAttemptsProperty;
 
    bool mUseRandomSeed = false;
    int mRandSeed = 0;
    bool mIncludeLineAttr = false;
};
 
 
#endif // QGSALGORITHMRANDOMPOINTSONLINES_H