dataproviders.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam
 *
 * Date        : 2013-05-18
 * Description : Wrapper class for face recognition
 *
 * Copyright (C)      2013 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2014-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_FACESENGINE_DATAPROVIDERS_H
#define DIGIKAM_FACESENGINE_DATAPROVIDERS_H
 
// Qt includes
 
#include <QImage>
#include <QList>
 
// Local includes
 
#include "digikam_export.h"
#include "identity.h"
 
namespace Digikam
{
 
class DIGIKAM_GUI_EXPORT ImageListProvider
{
public:
 
    ImageListProvider()                           = default;
    virtual ~ImageListProvider()                  = default;
 
    virtual int            size() const           = 0;
    virtual bool           atEnd() const          = 0;
    virtual void           proceed(int steps = 1) = 0;
    virtual QImage*        image()                = 0;
    virtual QList<QImage*> images()               = 0;
    virtual void setImages(const QList<QImage*>&) = 0;
 
private:
 
    Q_DISABLE_COPY(ImageListProvider)
};
 
// ----------------------------------------------------------------------------------------
 
class DIGIKAM_GUI_EXPORT QListImageListProvider : public ImageListProvider
{
public:
 
    QListImageListProvider();
    ~QListImageListProvider()             override;
 
    void reset();
 
public:
 
    int            size()  const          override;
    bool           atEnd() const          override;
    void           proceed(int steps = 1) override;
    QImage*        image()                override;
    QList<QImage*> images()               override;
    void setImages(const QList<QImage*>&) override;
 
public:
 
    QList<QImage*>                 list;
    QList<QImage*>::const_iterator it;
 
private:
 
    Q_DISABLE_COPY(QListImageListProvider)
};
 
// ----------------------------------------------------------------------------------------
 
class DIGIKAM_GUI_EXPORT EmptyImageListProvider : public ImageListProvider
{
public:
 
    EmptyImageListProvider()              = default;
    ~EmptyImageListProvider()             = default;
 
    int     size()  const                 override;
    bool    atEnd() const                 override;
    void    proceed(int steps = 1)        override;
    QImage* image()                       override;
    QList<QImage*> images()               override;
    void setImages(const QList<QImage*>&) override;
 
private:
 
    Q_DISABLE_COPY(EmptyImageListProvider)
};
 
// ----------------------------------------------------------------------------------------
 
class DIGIKAM_GUI_EXPORT TrainingDataProvider
{
public:
 
    TrainingDataProvider()                                         = default;
    virtual ~TrainingDataProvider()                                = default;
 
    virtual ImageListProvider* newImages(const Identity& identity) = 0;
 
    virtual ImageListProvider* images(const Identity& identity)    = 0;
 
private:
 
    Q_DISABLE_COPY(TrainingDataProvider)
};
 
} // namespace Digikam
 
#endif // DIGIKAM_FACESENGINE_DATAPROVIDERS_H