// Copyright 2017 Open Source Robotics Foundation, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef RCLCPP__TIME_HPP_
#define RCLCPP__TIME_HPP_

#include "builtin_interfaces/msg/time.hpp"

#include "rclcpp/visibility_control.hpp"

#include "rcl/time.h"

#include "rclcpp/duration.hpp"

namespace rclcpp
{

class Clock;

class Time
{
public:
  /// Time constructor
  /**
   * Indicates a specific point in time, relative to a clock's 0 point (its epoch).
   * The total time since the epoch is given by seconds + nanoseconds.
   *
   * \param seconds the seconds component, valid only if positive
   * \param nanoseconds the nanoseconds component, to be added to the seconds component
   * \param clock_type clock type
   * \throws std::runtime_error if seconds are negative
   */
  RCLCPP_PUBLIC
  Time(int32_t seconds, uint32_t nanoseconds, rcl_clock_type_t clock_type = RCL_SYSTEM_TIME);

  /// Time constructor
  /**
   * \param nanoseconds the total time since the epoch in nanoseconds
   * \param clock_type clock type
   * \throws std::runtime_error if nanoseconds are negative
   */
  RCLCPP_PUBLIC
  explicit Time(int64_t nanoseconds = 0, rcl_clock_type_t clock_type = RCL_SYSTEM_TIME);

  /// Copy constructor
  RCLCPP_PUBLIC
  Time(const Time & rhs);

  /// Move constructor
  RCLCPP_PUBLIC
  Time(Time && rhs) noexcept;

  /// Time constructor
  /**
   * \param time_msg builtin_interfaces time message to copy
   * \param clock_type clock type
   * \throws std::runtime_error if seconds are negative
   */
  RCLCPP_PUBLIC
  Time(
    const builtin_interfaces::msg::Time & time_msg,
    rcl_clock_type_t clock_type = RCL_ROS_TIME);

  /// Time constructor
  /**
   * \param time_point rcl_time_point_t structure to copy
   */
  RCLCPP_PUBLIC
  explicit Time(const rcl_time_point_t & time_point);

  /// Time destructor
  RCLCPP_PUBLIC
  virtual ~Time();

  /// Return a builtin_interfaces::msg::Time object based
  RCLCPP_PUBLIC
  operator builtin_interfaces::msg::Time() const;

  /**
   * Copy assignment operator
   * \throws std::runtime_error if seconds are negative
   */
  RCLCPP_PUBLIC
  Time &
  operator=(const Time & rhs);

  /**
   * Assign Time from a builtin_interfaces::msg::Time instance.
   * The clock_type will be reset to RCL_ROS_TIME.
   * Equivalent to *this = Time(time_msg, RCL_ROS_TIME).
   * \throws std::runtime_error if seconds are negative
   */
  RCLCPP_PUBLIC
  Time &
  operator=(const builtin_interfaces::msg::Time & time_msg);

  /**
   * Move assignment operator
   */
  RCLCPP_PUBLIC
  Time &
  operator=(Time && rhs) noexcept;

  /**
   * \throws std::runtime_error if the time sources are different
   */
  RCLCPP_PUBLIC
  bool
  operator==(const rclcpp::Time & rhs) const;

  RCLCPP_PUBLIC
  bool
  operator!=(const rclcpp::Time & rhs) const;

  /**
   * \throws std::runtime_error if the time sources are different
   */
  RCLCPP_PUBLIC
  bool
  operator<(const rclcpp::Time & rhs) const;

  /**
   * \throws std::runtime_error if the time sources are different
   */
  RCLCPP_PUBLIC
  bool
  operator<=(const rclcpp::Time & rhs) const;

  /**
   * \throws std::runtime_error if the time sources are different
   */
  RCLCPP_PUBLIC
  bool
  operator>=(const rclcpp::Time & rhs) const;

  /**
   * \throws std::runtime_error if the time sources are different
   */
  RCLCPP_PUBLIC
  bool
  operator>(const rclcpp::Time & rhs) const;

  /**
   * \throws std::overflow_error if addition leads to overflow
   */
  RCLCPP_PUBLIC
  Time
  operator+(const rclcpp::Duration & rhs) const;

  /**
   * \throws std::runtime_error if the time sources are different
   * \throws std::overflow_error if addition leads to overflow
   */
  RCLCPP_PUBLIC
  Duration
  operator-(const rclcpp::Time & rhs) const;

  /**
   * \throws std::overflow_error if addition leads to overflow
   */
  RCLCPP_PUBLIC
  Time
  operator-(const rclcpp::Duration & rhs) const;

  /**
   * \throws std::overflow_error if addition leads to overflow
   */
  RCLCPP_PUBLIC
  Time &
  operator+=(const rclcpp::Duration & rhs);

  /**
   * \throws std::overflow_error if addition leads to overflow
   */
  RCLCPP_PUBLIC
  Time &
  operator-=(const rclcpp::Duration & rhs);

  /// Get the nanoseconds since epoch
  /**
   * \return the total time since the epoch in nanoseconds, as a rcl_time_point_value_t structure.
   */
  RCLCPP_PUBLIC
  rcl_time_point_value_t
  nanoseconds() const;

  /// Get the maximum representable value.
  /**
   * \return the maximum representable value
   */
  RCLCPP_PUBLIC
  static Time
  max(rcl_clock_type_t clock_type = RCL_SYSTEM_TIME);  // NOLINT

  /// Get the seconds since epoch
  /**
   * \warning Depending on sizeof(double) there could be significant precision loss.
   * When an exact time is required use nanoseconds() instead.
   *
   * \return the total time since the epoch in seconds, as a floating point number.
   */
  RCLCPP_PUBLIC
  double
  seconds() const;

  /// Get the clock type
  /**
   * \return the clock type
   */
  RCLCPP_PUBLIC
  rcl_clock_type_t
  get_clock_type() const;

private:
  rcl_time_point_t rcl_time_;
  friend Clock;  // Allow clock to manipulate internal data
};

/**
 * \throws std::overflow_error if addition leads to overflow
 */
RCLCPP_PUBLIC
Time
operator+(const rclcpp::Duration & lhs, const rclcpp::Time & rhs);

/// Convert rcl_time_point_value_t to builtin_interfaces::msg::Time
/**
 * \param[in] time_point is a rcl_time_point_value_t
 * \return the builtin_interfaces::msg::Time from the time_point
 */
RCLCPP_PUBLIC
builtin_interfaces::msg::Time
convert_rcl_time_to_sec_nanos(const rcl_time_point_value_t & time_point);

}  // namespace rclcpp

#endif  // RCLCPP__TIME_HPP_
