itemposition.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2007-11-01
 * Description : Access item position stored in database.
 *
 * Copyright (C) 2007-2009 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2009-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 * Copyright (C) 2008      by Patrick Spendrin <ps_ml at gmx dot de>
 *
 * 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_ITEM_POSITION_H
#define DIGIKAM_ITEM_POSITION_H
 
// Qt includes
 
#include <QString>
#include <QSharedDataPointer>
#include <QSharedData>
 
// Local includes
 
#include "digikam_export.h"
#include "coredbfields.h"
 
namespace Digikam
{
 
class CoreDbAccess;
class ItemPositionPriv;
 
class DIGIKAM_DATABASE_EXPORT ItemPosition
{
 
public:
 
    ItemPosition();
 
    explicit ItemPosition(qlonglong imageId);
    ItemPosition(const CoreDbAccess& access, qlonglong imageId);
 
    ItemPosition(const ItemPosition& other);
    ~ItemPosition();
 
    ItemPosition& operator=(const ItemPosition& other);
 
    bool isNull()                const;
    bool isEmpty()               const;
 
    QString latitude()           const;
    QString longitude()          const;
 
    double latitudeNumber()      const;
    double longitudeNumber()     const;
 
    QString latitudeFormatted()  const;
    QString longitudeFormatted() const;
 
    bool latitudeUserPresentableNumbers(int* degrees, int* minutes, double* seconds, char* directionReference);
    bool longitudeUserPresentableNumbers(int* degrees, int* minutes, double* seconds, char* directionReference);
 
    double altitude()            const;
 
    QString altitudeFormatted()  const;
    double orientation()         const;
    double tilt()                const;
    double roll()                const;
    double accuracy()            const;
    QString description()        const;
 
    bool hasCoordinates()        const;
    bool hasAltitude()           const;
    bool hasOrientation()        const;
    bool hasTilt()               const;
    bool hasRoll()               const;
    bool hasAccuracy()           const;
 
    bool setLatitude(const QString& latitude);
    bool setLongitude(const QString& longitude);
 
    bool setLatitude(double latitudeNumber);
    bool setLongitude(double longitudeNumber);
 
    void setAltitude(double altitude);
    void setOrientation(double orientation);
    void setTilt(double tilt);
    void setRoll(double roll);
    void setAccuracy(double accuracy);
    void setDescription(const QString& description);
 
    void apply();
 
    void remove();
 
    void removeAltitude();
 
private:
 
    QSharedDataPointer<ItemPositionPriv> d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_ITEM_POSITION_H