facedbaccess.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2009-05-29
 * Description : Face database access wrapper.
 *
 * Copyright (C) 2007-2009 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2010-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_FACE_DB_ACCESS_H
#define DIGIKAM_FACE_DB_ACCESS_H
 
// Local includes
 
#include "digikam_export.h"
#include "dbengineparameters.h"
#include "collectionscannerobserver.h"
 
namespace Digikam
{
 
class FaceDb;
class FaceDbAccessStaticPriv;
class FaceDbBackend;
class DbEngineErrorHandler;
 
class DIGIKAM_GUI_EXPORT FaceDbAccess
{
public:
 
    FaceDbAccess();
    ~FaceDbAccess();
 
    FaceDb*        db()         const;
    FaceDbBackend* backend()    const;
    QString        lastError()  const;
 
    void setLastError(const QString& error);
 
    static DbEngineParameters parameters();
 
public:
 
    static void initDbEngineErrorHandler(DbEngineErrorHandler* const errorhandler);
    static void setParameters(const DbEngineParameters& parameters);
    static bool checkReadyForUse(InitializationObserver* const observer);
    static bool isInitialized();
    static void cleanUpDatabase();
 
private:
 
    explicit FaceDbAccess(bool);
 
    // Disable
    FaceDbAccess(const FaceDbAccess&)            = delete;
    FaceDbAccess& operator=(const FaceDbAccess&) = delete;
 
private:
 
    friend class FaceDbAccessUnlock;
    static FaceDbAccessStaticPriv* d;
};
 
// ------------------------------------------------------------------------------------------
 
class FaceDbAccessUnlock
{
public:
 
    FaceDbAccessUnlock();
    explicit FaceDbAccessUnlock(FaceDbAccess* const access);
    ~FaceDbAccessUnlock();
 
private:
 
    int count;
 
private:
 
    // Disable
    FaceDbAccessUnlock(const FaceDbAccessUnlock&)            = delete;
    FaceDbAccessUnlock& operator=(const FaceDbAccessUnlock&) = delete;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_FACE_DB_ACCESS_H