Files
pilotclient/src/blackmisc/timestampbased.h
Roland Winklmeier 794bf0cd74 Fix doxygen copydoc documentation
The following issues were fixed
* Fixed wrong/missing namespaces
* Fixed obvious typos in documentation
* Documentation not in sync with source code

refs #544
2016-02-08 01:53:17 +01:00

123 lines
3.8 KiB
C++

/* Copyright (C) 2015
* swift project Community / Contributors
*
* This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
* directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
* including this file, may be copied, modified, propagated, or distributed except according to the terms
* contained in the LICENSE file.
*/
//! \file
#ifndef BLACKMISC_TIMESTAMPBASED_H
#define BLACKMISC_TIMESTAMPBASED_H
#include "blackmiscexport.h"
#include "propertyindex.h"
#include <QDateTime>
namespace BlackMisc
{
//! Entity with timestamp
class BLACKMISC_EXPORT ITimestampBased
{
public:
//! Properties by index
enum ColumnIndex
{
IndexUtcTimestamp = BlackMisc::CPropertyIndex::GlobalIndexITimestampBased,
IndexUtcTimestampFormattedYmdhms,
IndexUtcTimestampFormattedYmdhmsz,
IndexUtcTimestampFormattedDhms,
IndexUtcTimestampFormattedHms,
IndexUtcTimestampFormattedHm,
IndexMSecsSinceEpoch // keep this as last item
};
//! Get timestamp
QDateTime getUtcTimestamp() const;
//! Timestamp as ms value
qint64 getMSecsSinceEpoch() const { return m_timestampMSecsSinceEpoch; }
//! Timestamp as ms value
void setMSecsSinceEpoch(qint64 mSecsSinceEpoch) { m_timestampMSecsSinceEpoch = mSecsSinceEpoch; }
//! Set by value such as "20141003231045"
void setByYearMonthDayHourMinute(const QString &yyyyMMddhhmmss);
//! Set timestamp
void setUtcTimestamp(const QDateTime &timestamp);
//! Is this newer than other?
bool isNewerThan(const ITimestampBased &otherTimestampObj) const;
//! Is newer than epoch value?
bool isNewerThan(qint64 mSecsSinceEpoch) const;
//! Is this older than other?
bool isOlderThan(const ITimestampBased &otherTimestampObj) const;
//! Is this older than other?
bool isOlderThan(qint64 mSecsSinceEpoch) const;
//! Older than now-offset
bool isOlderThanNowMinusOffset(int offsetMs) const;
//! Same timestamp
bool isSame(const ITimestampBased &otherTimestampObj) const;
//! Time difference
qint64 msecsTo(const ITimestampBased &otherTimestampObj) const;
//! Time difference
qint64 absMsecsTo(const ITimestampBased &otherTimestampObj) const;
//! Set the current time as timestamp
void setCurrentUtcTime();
//! Formatted timestamp
QString getFormattedUtcTimestampDhms() const;
//! As hh:mm:ss
QString getFormattedUtcTimestampHms() const;
//! As hh:mm
QString getFormattedUtcTimestampHm() const;
//! As yyyy MM dd HH mm ss
QString getFormattedUtcTimestampYmdhms() const;
//! As yyyy MM dd HH mm ss.zzz
QString getFormattedUtcTimestampYmdhmsz() const;
//! Can given index be handled
static bool canHandleIndex(const BlackMisc::CPropertyIndex &index);
protected:
//! Constructor
ITimestampBased();
//! Constructor
ITimestampBased(qint64 msSincePoch);
//! Constructor
ITimestampBased(const QDateTime &timestamp);
//! \copydoc BlackMisc::Mixin::Index::propertyByIndex
CVariant propertyByIndex(const BlackMisc::CPropertyIndex &index) const;
//! \copydoc BlackMisc::Mixin::Index::setPropertyByIndex
void setPropertyByIndex(const CVariant &variant, const BlackMisc::CPropertyIndex &index);
//! Compare for index
int comparePropertyByIndex(const ITimestampBased &compareValue, const CPropertyIndex &index) const;
qint64 m_timestampMSecsSinceEpoch; //!< timestamp value
};
} // namespace
#endif // guard