dimgthreadedanalyser.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2012-11-13
 * Description : threaded image analys class.
 *               this class is dedicated to run algorithm in a separated thread
 *               over an image to process analys. No image data are changed.
 *
 * Copyright (C) 2012-2022 by Gilles Caulier <caulier dot gilles 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, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_DIMG_THREADED_ANALYSER_H
#define DIGIKAM_DIMG_THREADED_ANALYSER_H
 
// Local includes
 
#include "digikam_export.h"
#include "dimgthreadedfilter.h"
 
namespace Digikam
{
 
class DIGIKAM_EXPORT DImgThreadedAnalyser : public DImgThreadedFilter
{
    Q_OBJECT
 
public:
 
    explicit DImgThreadedAnalyser(QObject* const parent = nullptr, const QString& name = QString());
 
    explicit DImgThreadedAnalyser(DImg* const orgImage, QObject* const parent = nullptr,
                                  const QString& name = QString());
 
    ~DImgThreadedAnalyser() override;
 
private:
 
    FilterAction filterAction() override
    {
        // return null object
        return FilterAction();
    };
 
    void readParameters(const FilterAction&) override
    {
         // Do nothing.
    };
 
    QString filterIdentifier() const override
    {
        // return null object
        return QString();
    };
 
    QList<int> supportedVersions() const     override
    {
        // return null object
        return QList<int>();
    };
 
    void prepareDestImage()                  override
    {
        // No destination image is required here.
    };
 
    void filterImage()                       override
    {
        startAnalyse();
    };
 
protected:
 
    virtual void startAnalyse() = 0;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_DIMG_THREADED_ANALYSER_H