timestamp.h

Go to the documentation of this file.

// === timestamp.h =====================================================================================================
//                                               Sen Infrastructure
//                   Released under the Apache License v2.0 (SPDX-License-Identifier Apache-2.0).
//                                    See the LICENSE.txt file for more information.
//                   © Airbus SAS, Airbus Helicopters, and Airbus Defence and Space SAU/GmbH/SAS.
// =====================================================================================================================
 
#ifndef SEN_CORE_BASE_TIMESTAMP_H
#define SEN_CORE_BASE_TIMESTAMP_H
 
// sen
#include "sen/core/base/duration.h"
#include "sen/core/base/result.h"
 
// std
#include <string>
 
namespace sen
{


class TimeStamp
{
public:
  using ValueType = Duration::ValueType;
 
public:  // defaults
  constexpr TimeStamp() noexcept = default;
  constexpr explicit TimeStamp(Duration timeSinceEpoch) noexcept: timeSinceEpoch_(timeSinceEpoch) {}
  ~TimeStamp() noexcept = default;
 
public:  // special members
  constexpr SEN_COPY_CONSTRUCT(TimeStamp) = default;
  constexpr SEN_MOVE_CONSTRUCT(TimeStamp) = default;
  SEN_COPY_ASSIGN(TimeStamp) = default;
  SEN_MOVE_ASSIGN(TimeStamp) = default;
 
public:  // factories
  static Result<TimeStamp, std::string> make(const std::string_view iso8601Time);
 
public:  // accessors
  [[nodiscard]] constexpr Duration sinceEpoch() const noexcept { return timeSinceEpoch_; }
 
public:  // operators
  constexpr bool operator==(const TimeStamp& other) const noexcept { return timeSinceEpoch_ == other.timeSinceEpoch_; }

  constexpr bool operator!=(const TimeStamp& other) const noexcept { return timeSinceEpoch_ != other.timeSinceEpoch_; }

  constexpr bool operator<(const TimeStamp& other) const noexcept { return timeSinceEpoch_ < other.timeSinceEpoch_; }

  constexpr bool operator<=(const TimeStamp& other) const noexcept { return timeSinceEpoch_ <= other.timeSinceEpoch_; }

  constexpr bool operator>(const TimeStamp& other) const noexcept { return timeSinceEpoch_ > other.timeSinceEpoch_; }

  constexpr bool operator>=(const TimeStamp& other) const noexcept { return timeSinceEpoch_ >= other.timeSinceEpoch_; }

  TimeStamp& operator+=(const Duration& other) noexcept
  {
    timeSinceEpoch_ += other;
    return *this;
  }

  constexpr TimeStamp operator+(const Duration& other) const noexcept { return TimeStamp(timeSinceEpoch_ + other); }

  TimeStamp& operator-=(const Duration& other) noexcept
  {
    timeSinceEpoch_ -= other;
    return *this;
  }

  constexpr TimeStamp operator-(const Duration& other) const noexcept { return TimeStamp(timeSinceEpoch_ - other); }

  constexpr Duration operator-(const TimeStamp& other) const noexcept { return sinceEpoch() - other.sinceEpoch(); }
 
public:
  [[nodiscard]] std::string toUtcString() const;

  [[nodiscard]] std::string toLocalString() const;
 
private:
  Duration timeSinceEpoch_ {};
};
 
template <>
struct ShouldBePassedByValue<TimeStamp>: std::true_type
{
};
 
static_assert(sizeof(TimeStamp) == 8, "TimeStamp should be 8 bytes");
static_assert(std::is_trivially_copyable_v<TimeStamp>);

 
}  // namespace sen
 
#endif  // SEN_CORE_BASE_TIMESTAMP_H