DateTimeStamp.h

Go to the documentation of this file.

// (c) IMT - Information Management Technology AG, CH-9470 Buchs, www.imt.ch.
//
// ActiveParts (AP) and the corresponding Data Flow Framework (DFF) is invented and designed by Jakob Daescher.
// ANY USE OF THIS CODE CONSTITUTES ACCEPTANCE OF THE TERMS OF THE COPYRIGHT NOTICE.
// ===================================================================================================
// COPYRIGHT NOTICE
// ===================================================================================================
// Copyright (C) 2005-2075, IMT Information Management Technology AG, 9470 Buchs, Switzerland
// All rights reserved.
// This code is proprietary software of IMT Information Management Technology AG (hereinafter: "IMT").
// Proprietary software is computer software licensed under exclusive legal right of IMT.
//
// The licensee is given the irrevocable, perpetual, worldwide, non-exclusive right and license to use,
// execute and reproduce the software in binary form within the licensed products.
//
// Redistribution and use in source forms, without modification, are permitted provided that the following conditions are met:
// (1) Copying of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
// (2) Copying of source code is only allowed for regulatory documentation and archiving purposes
// (3) Redistributions in binary form must reproduce the above copyright notice,
//     this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
//
// IMT provide no reassurances that the source code provided does not infringe
// any patent, copyright, or any other intellectual property rights of third parties.
// IMT disclaim any liability to any recipient for claims brought against
// recipient by any third party for infringement of that parties intellectual property rights.
//
// THIS SOFTWARE IS PROVIDED BY IMT AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
// IN NO EVENT SHALL IMT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
// OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCURE-MENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
// IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// ===================================================================================================
 
#ifndef IMT_BASE_CORE_UTIL_DATETIMESTAMP_H
#define IMT_BASE_CORE_UTIL_DATETIMESTAMP_H
 
#include <Imt.Base.Core.Platform/Platform.h>
 
namespace imt {
namespace base {
namespace core {
namespace util {
 
class DateTimeStamp final {
 
public:
 
    DateTimeStamp() = default;
 
    explicit DateTimeStamp(uint16_t const year, uint8_t const month = 1U, uint8_t const day = 1U, uint8_t const hour = 0U, uint8_t const minute = 0U, uint8_t const second = 0U);
 
    DateTimeStamp(DateTimeStamp const&) noexcept = default;
 
    DateTimeStamp(DateTimeStamp&&) noexcept = default;
 
    ~DateTimeStamp() = default;
 
    DateTimeStamp& operator=(DateTimeStamp const&) & noexcept = default;
 
    DateTimeStamp& operator=(DateTimeStamp&&) & noexcept = default;
 
    void addDays(uint32_t const days);
 
    void addHours(uint32_t const hours);
 
    void addMinutes(uint32_t const minutes);
 
    void addSeconds(uint32_t const seconds);
 
    inline uint16_t getYear() const {
        return m_year;
    }
 
    uint16_t getYearShort() const;
 
    void setYear(uint16_t const year);
 
    inline uint8_t getMonth() const {
        return m_month;
    }
 
    void setMonth(uint8_t const month);
 
    inline uint8_t getDay() const {
        return m_day;
    }
 
    void setDay(uint8_t const day);
 
    inline uint8_t getHour() const {
        return m_hour;
    }
 
    void setHour(uint8_t const hour);
 
    inline uint8_t getMinute() const {
        return m_minute;
    }
 
    void setMinute(uint8_t const minute);
 
    inline uint8_t getSecond() const {
        return m_second;
    }
 
    void setSecond(uint8_t const second);
 
    static uint8_t getNumberOfDaysOfMonth(uint8_t const month, uint16_t const year);
 
    static bool isLeapYear(uint16_t const year);
 
    static uint32_t getDifferenceDays(DateTimeStamp const date1, DateTimeStamp const date2);
 
    void subtractDays(uint32_t const days);
 
    void subtractHours(uint32_t const hours);
 
    void subtractMinutes(uint32_t const minutes);
 
    void subtractSeconds(uint32_t const seconds);
 
private:
 
    static uint32_t getDifferenceDaysInSameYear(DateTimeStamp const start, DateTimeStamp const end);
    static uint32_t getDifferenceDaysOverMultipleYears(DateTimeStamp const start, DateTimeStamp const end, uint16_t const yearDifference);
 
    uint16_t m_year;
    uint8_t m_month;
    uint8_t m_day;
    uint8_t m_hour;
    uint8_t m_minute;
    uint8_t m_second;
};
 
bool operator==(DateTimeStamp const left, DateTimeStamp const right) noexcept;
 
bool operator!=(DateTimeStamp const left, DateTimeStamp const right) noexcept;
 
bool operator>(DateTimeStamp const left, DateTimeStamp const right) noexcept;
 
bool operator<(DateTimeStamp const left, DateTimeStamp const right) noexcept;
 
bool operator>=(DateTimeStamp const left, DateTimeStamp const right) noexcept;
 
bool operator<=(DateTimeStamp const left, DateTimeStamp const right) noexcept;
 
} // namespace util
} // namespace core
} // namespace base
} // namespace imt
 
#endif // IMT_BASE_CORE_UTIL_DATETIMESTAMP_H