DateTime.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#define ARP_INSIDE_ARP_BASE_CORE_ARP_H
#include "Arp/Base/Core/PimplPtr.hxx"
#include "Arp/Base/Core/Detail/DateTimeKind.hpp"
#include "Arp/Base/Core/Detail/PrimitiveTypes.hpp"
#include "Arp/Base/Core/Detail/String.hpp"
#include <ctime>
#include <iosfwd>
 
namespace Arp { namespace Base { namespace Core
{
 
class ARP_EXPORT DateTime
{
public: // Impl forward declaration
    class Impl;
    friend class Impl;
 
public: // usings
    using Value = uint64;
    using Ticks = int64;
 
public: // construction/destruction/assignment
    DateTime(void);
    DateTime(int64 ticks, DateTimeKind kind);
    DateTime(int year, int month, int day, int hour, int minute, int second, int millisecond, int microsecond, DateTimeKind kind);
 
public: // operators
    ARP_EXPORT friend bool operator==(const DateTime& left, const DateTime& right);
    ARP_EXPORT friend bool operator!=(const DateTime& left, const DateTime& right);
    ARP_EXPORT friend bool operator> (const DateTime& left, const DateTime& right);
    ARP_EXPORT friend bool operator< (const DateTime& left, const DateTime& right);
    ARP_EXPORT friend bool operator>=(const DateTime& left, const DateTime& right);
    ARP_EXPORT friend bool operator<=(const DateTime& left, const DateTime& right);
 
    ARP_EXPORT friend std::ostream& operator<<(std::ostream& os, const DateTime& value);
    ARP_EXPORT friend std::istream& operator>>(std::istream& is, DateTime& value);
 
public: // static properties
    static DateTime GetUtcMin(void);
    static DateTime GetUtcMax(void);
    static int64    GetMinTicks(void);
    static int64    GetMaxTicks(void);
 
public: // static operations
    static DateTime GetUtcNow(void);
    static DateTime GetLocalNow(void);
    static DateTime FromUnixTime(time_t unixTime);
    static DateTime FromUnixTimeMicroseconds(int64 microseconds);
    static DateTime FromOpcUaTime(int64 opcUaTime);
    static DateTime FromIso8601String(const String& input);
    static DateTime FromBinary(Value value);
    static bool     IsLeapYear(int year);
 
public: // setter/getter operations
    Ticks           GetTicks(void)const;
    DateTimeKind    GetKind(void)const;
    int             GetYear(void)const;
    int             GetMonth(void)const;
    int             GetDay(void)const;
    int             GetHour(void)const;
    int             GetMinute(void)const;
    int             GetSecond(void)const;
    int             GetMillisecond(void)const;
    int             GetMicrosecond(void)const;
    bool            IsEmpty(void)const;
 
public: // operations
    time_t          ToUnixTime(void)const;
    int64           ToUnixTimeMicroseconds(void)const;
    Value           ToBinary(void)const;
    int64           ToOpcUaTime(void)const;
    String          ToIso8601String(void)const;
 
public: // deprecated static const fields
    ARP_DEPRECATED("Use DateTime::GetMinTicks() instead")
    static const int64 MinTicks;
    ARP_DEPRECATED("Use DateTime::GetMaxTicks() instead")
    static const int64 MaxTicks;
 
private: // Impl methods
    DateTime(const Impl& impl);
 
private: // fields
    Value value = 0;
};
 
}}} // end of namespace Arp::Base::Core
 
template<> struct fmt::formatter<Arp::Base::Core::DateTime>: public fmt::ostream_formatter {};