Timestamp.h

#pragma once
 
#include <Foundation/Reflection/Reflection.h>
#include <Foundation/Time/Time.h>
 
struct plSIUnitOfTime
{
  enum Enum
  {
    Nanosecond,  
    Microsecond, 
    Millisecond, 
    Second,      
  };
};
 
class PL_FOUNDATION_DLL plTimestamp
{
public:
  struct CompareMode
  {
    enum Enum
    {
      FileTimeEqual, 
      Identical,     
      Newer,         
    };
  };
  static const plTimestamp CurrentTimestamp(); // [tested]
 
  PL_DECLARE_POD_TYPE();
 
  // *** Constructors ***
public:
  plTimestamp(); // [tested]
 
  [[nodiscard]] static plTimestamp MakeInvalid() { return plTimestamp(); }
 
  [[nodiscard]] static plTimestamp MakeFromInt(plInt64 iTimeValue, plSIUnitOfTime::Enum unitOfTime);
 
  // *** Public Functions ***
public:
  bool IsValid() const; // [tested]
 
  plInt64 GetInt64(plSIUnitOfTime::Enum unitOfTime) const; // [tested]
 
  bool Compare(const plTimestamp& rhs, CompareMode::Enum mode) const; // [tested]
 
  // *** Operators ***
public:
  void operator+=(const plTime& timeSpan); // [tested]
 
  void operator-=(const plTime& timeSpan); // [tested]
 
  const plTime operator-(const plTimestamp& other) const; // [tested]
 
  const plTimestamp operator+(const plTime& timeSpan) const; // [tested]
 
  const plTimestamp operator-(const plTime& timeSpan) const; // [tested]
 
 
private:
  static constexpr const plInt64 PL_INVALID_TIME_STAMP = plMath::MinValue<plInt64>();
 
  PL_ALLOW_PRIVATE_PROPERTIES(plTimestamp);
  plInt64 m_iTimestamp = PL_INVALID_TIME_STAMP;
};
 
const plTimestamp operator+(plTime& ref_timeSpan, const plTimestamp& timestamp);
 
PL_DECLARE_REFLECTABLE_TYPE(PL_FOUNDATION_DLL, plTimestamp);
 
class PL_FOUNDATION_DLL plDateTime
{
public:
  plDateTime(); // [tested]
  ~plDateTime();
 
  bool IsValid() const;
 
  [[nodiscard]] static plDateTime MakeZero() { return plDateTime(); }
 
  [[nodiscard]] static plDateTime MakeFromTimestamp(plTimestamp timestamp);
 
  [[nodiscard]] const plTimestamp GetTimestamp() const; // [tested]
 
  plResult SetFromTimestamp(plTimestamp timestamp);
 
  // *** Accessors ***
public:
  plUInt32 GetYear() const; // [tested]
 
  void SetYear(plInt16 iYear); // [tested]
 
  plUInt8 GetMonth() const; // [tested]
 
  void SetMonth(plUInt8 uiMonth); // [tested]
 
  plUInt8 GetDay() const; // [tested]
 
  void SetDay(plUInt8 uiDay); // [tested]
 
  plUInt8 GetDayOfWeek() const;
 
  void SetDayOfWeek(plUInt8 uiDayOfWeek);
 
  plUInt8 GetHour() const; // [tested]
 
  void SetHour(plUInt8 uiHour); // [tested]
 
  plUInt8 GetMinute() const; // [tested]
 
  void SetMinute(plUInt8 uiMinute); // [tested]
 
  plUInt8 GetSecond() const; // [tested]
 
  void SetSecond(plUInt8 uiSecond); // [tested]
 
  plUInt32 GetMicroseconds() const; // [tested]
 
  void SetMicroseconds(plUInt32 uiMicroSeconds); // [tested]
 
private:
  plUInt32 m_uiMicroseconds = 0;
  plInt16 m_iYear = 0;
  plUInt8 m_uiMonth = 0;
  plUInt8 m_uiDay = 0;
  plUInt8 m_uiDayOfWeek = 0;
  plUInt8 m_uiHour = 0;
  plUInt8 m_uiMinute = 0;
  plUInt8 m_uiSecond = 0;
};
 
PL_FOUNDATION_DLL plStringView BuildString(char* szTmp, plUInt32 uiLength, const plDateTime& arg);
 
struct plArgDateTime
{
  enum FormattingFlags
  {
    ShowDate = PL_BIT(0),
    TextualDate = ShowDate | PL_BIT(1),
    ShowWeekday = PL_BIT(2),
    ShowTime = PL_BIT(3),
    ShowSeconds = ShowTime | PL_BIT(4),
    ShowMilliseconds = ShowSeconds | PL_BIT(5),
    ShowTimeZone = PL_BIT(6),
 
    Default = ShowDate | ShowSeconds,
    DefaultTextual = TextualDate | ShowSeconds,
  };
 
  inline explicit plArgDateTime(const plDateTime& dateTime, plUInt32 uiFormattingFlags = Default)
    : m_Value(dateTime)
    , m_uiFormattingFlags(uiFormattingFlags)
  {
  }
 
  plDateTime m_Value;
  plUInt32 m_uiFormattingFlags;
};
 
PL_FOUNDATION_DLL plStringView BuildString(char* szTmp, plUInt32 uiLength, const plArgDateTime& arg);
 
#include <Foundation/Time/Implementation/Timestamp_inl.h>