timestampbased.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2015 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_MISC_TIMESTAMPBASED_H
#define SWIFT_MISC_TIMESTAMPBASED_H
 
#include <QDateTime>
#include <QString>
#include <QVariant>
#include <QtGlobal>
 
#include "misc/propertyindexref.h"
#include "misc/swiftmiscexport.h"
 
namespace swift::misc
{
    class SWIFT_MISC_EXPORT ITimestampBased
    {
    public:
        enum ColumnIndex
        {
            IndexUtcTimestamp = CPropertyIndexRef::GlobalIndexITimestampBased,
            IndexUtcTimestampFormattedYmdhms,
            IndexUtcTimestampFormattedYmdhmsz,
            IndexUtcTimestampFormattedMdhms,
            IndexUtcTimestampFormattedMdhmsz,
            IndexUtcTimestampFormattedDhms,
            IndexUtcTimestampFormattedHms,
            IndexUtcTimestampFormattedHm,
            IndexMSecsSinceEpoch // keep this as last item
        };
 
        QDateTime getUtcTimestamp() const;
 
        qint64 getMSecsSinceEpoch() const { return m_timestampMSecsSinceEpoch; }
 
        qint64 getTimeDifferenceMs(qint64 compareTime) const { return compareTime - this->getMSecsSinceEpoch(); }
 
        qint64 getTimeDifferenceAbsMs(qint64 compareTime) const
        {
            return qAbs(compareTime - this->getMSecsSinceEpoch());
        }
 
        qint64 getTimeDifferenceToNowMs() const
        {
            return this->getTimeDifferenceMs(QDateTime::currentMSecsSinceEpoch());
        }
 
        qint64 getTimeDifferenceMs(const ITimestampBased &compare) const
        {
            return compare.getMSecsSinceEpoch() - this->getMSecsSinceEpoch();
        }
 
        qint64 getAbsTimeDifferenceMs(qint64 compareTime) const { return qAbs(this->getTimeDifferenceMs(compareTime)); }
 
        qint64 getAbsTimeDifferenceMs(const ITimestampBased &compare) const
        {
            return qAbs(this->getTimeDifferenceMs(compare));
        }
 
        void setTimestampToNull();
 
        void setMSecsSinceEpoch(qint64 mSecsSinceEpoch) { m_timestampMSecsSinceEpoch = mSecsSinceEpoch; }
 
        void setByYearMonthDayHourMinute(const QString &yyyyMMddhhmmss);
 
        void setUtcTimestamp(const QDateTime &timestamp);
 
        bool isNewerThan(const ITimestampBased &otherTimestampObj) const;
 
        bool isNewerThan(qint64 mSecsSinceEpoch) const;
 
        bool isOlderThan(const ITimestampBased &otherTimestampObj) const;
 
        bool isOlderThan(qint64 mSecsSinceEpoch) const;
 
        bool isOlderThanNowMinusOffset(int offsetMs) const;
 
        bool isSame(const ITimestampBased &otherTimestampObj) const;
 
        qint64 msecsTo(const ITimestampBased &otherTimestampObj) const;
 
        qint64 absMsecsTo(const ITimestampBased &otherTimestampObj) const;
 
        qint64 msecsToNow() const;
 
        void setCurrentUtcTime();
 
        void addMsecs(qint64 ms);
 
        QString getFormattedUtcTimestampHms() const;
 
        QString getFormattedUtcTimestampHmsz() const;
 
        QString getFormattedUtcTimestampHm() const;
 
        QString getFormattedUtcTimestampDhms() const;
 
        QString getFormattedUtcTimestampMdhms() const;
 
        QString getFormattedUtcTimestampMdhmsz() const;
 
        QString getFormattedUtcTimestampYmdhms() const;
 
        QString getFormattedUtcTimestampYmdhmsz() const;
 
        bool hasValidTimestamp() const;
 
        static bool isAnyTimestampIndex(int index);
 
        static bool canHandleIndex(CPropertyIndexRef index);
 
    protected:
        ITimestampBased();
 
        ITimestampBased(qint64 msSincePoch);
 
        ITimestampBased(const QDateTime &timestamp);
 
        QVariant propertyByIndex(CPropertyIndexRef index) const;
 
        void setPropertyByIndex(CPropertyIndexRef index, const QVariant &variant);
 
        int comparePropertyByIndex(CPropertyIndexRef index, const ITimestampBased &compareValue) const;
 
        void updateMissingParts(const ITimestampBased &other);
 
        qint64 m_timestampMSecsSinceEpoch = -1; 
    };
 
    class SWIFT_MISC_EXPORT ITimestampWithOffsetBased : public ITimestampBased
    {
    public:
        enum ColumnIndex
        {
            IndexOffsetMs = static_cast<int>(CPropertyIndexRef::GlobalIndexITimestampBased) +
                            ITimestampBased::IndexMSecsSinceEpoch + 1,
            IndexAdjustedMsWithOffset,
            IndexOffsetWithUnit // keep this as last item
        };
 
        void setTimeOffsetMs(qint64 offset) { m_timeOffsetMs = offset; }
 
        qint64 getTimeOffsetMs() const { return m_timeOffsetMs; }
 
        bool hasNonZeroOffsetTime() const;
 
        void addMsecsToOffsetTime(qint64 msToAdd);
 
        QString getTimeOffsetWithUnit() const;
 
        qint64 getAdjustedMSecsSinceEpoch() const { return this->getMSecsSinceEpoch() + this->getTimeOffsetMs(); }
 
        void setAdjustedMSecsSinceEpoch(qint64 adjustedTimeMs)
        {
            this->setMSecsSinceEpoch(adjustedTimeMs - this->getTimeOffsetMs());
        }
 
        qint64 getAdjustedTimeDifferenceMs(qint64 compareTime) const
        {
            return this->getAdjustedMSecsSinceEpoch() - compareTime;
        }
 
        QString getTimestampAndOffset(bool formatted) const;
 
        QString getFormattedTimestampAndOffset(bool includeRawTimestamp) const;
 
        bool isNewerThanAdjusted(const ITimestampWithOffsetBased &otherTimestampObj) const;
 
        bool isNewerThanAdjusted(qint64 mSecsSinceEpoch) const;
 
        bool isOlderThanAdjusted(const ITimestampWithOffsetBased &otherTimestampObj) const;
 
        bool isOlderThanAdjusted(qint64 mSecsSinceEpoch) const;
 
    protected:
        static bool canHandleIndex(CPropertyIndexRef index);
 
        ITimestampWithOffsetBased() : ITimestampBased() {}
 
        ITimestampWithOffsetBased(qint64 msSincePoch) : ITimestampBased(msSincePoch) {}
 
        ITimestampWithOffsetBased(const QDateTime &timestamp) : ITimestampBased(timestamp) {}
 
        QVariant propertyByIndex(swift::misc::CPropertyIndexRef index) const;
 
        void setPropertyByIndex(swift::misc::CPropertyIndexRef index, const QVariant &variant);
 
        int comparePropertyByIndex(CPropertyIndexRef index, const ITimestampWithOffsetBased &compareValue) const;
 
        qint64 m_timeOffsetMs = 0; 
    };
} // namespace swift::misc
 
#endif // SWIFT_MISC_TIMESTAMPBASED_H