gz/common/Time.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2016 Open Source Robotics Foundation
 *
 * 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 IGNITION_COMMON_TIME_HH_
#define IGNITION_COMMON_TIME_HH_
 
#include <string>
#include <iostream>
 
#include <gz/common/config.hh>
#include <gz/common/Export.hh>
#include <gz/common/Util.hh>
 
namespace ignition
{
  namespace common
  {
    class IGNITION_COMMON_VISIBLE Time
    {
      public: static const Time Zero;
 
      public: enum class FormatOption
      {
        DAYS = 0,
        HOURS = 1,
        MINUTES = 2,
        SECONDS = 3,
        MILLISECONDS = 4
      };
 
      public: IGN_DEPRECATED(4) Time();
 
      public: IGN_DEPRECATED(4) Time(const Time &_time);
 
      public: explicit IGN_DEPRECATED(4) Time(const struct timespec &_tv);
 
      public: IGN_DEPRECATED(4) Time(int32_t _sec, int32_t _nsec);
 
      public: explicit IGN_DEPRECATED(4) Time(double _time);
 
      public: virtual ~Time();
 
      public: static const IGN_DEPRECATED(4) Time &SystemTime();
 
      public: void Set(int32_t _sec, int32_t _nsec);
 
      public: void Set(double _seconds);
 
      public: double Double() const;
 
      public: float Float() const;
 
      public: static Time IGN_DEPRECATED(4) Sleep(const common::Time &_time);
 
      public: std::string FormattedString(
          FormatOption _start = FormatOption::DAYS,
          FormatOption _end = FormatOption::MILLISECONDS) const;
 
      public: Time &operator=(const Time &_time);
 
      public: Time operator+(const Time &_time) const;
 
      public: const Time &operator +=(const Time &_time);
 
      public: Time operator -(const struct timespec &_tv) const;
 
      public: const Time &operator -=(const struct timespec &_tv);
 
      public: Time operator -(const Time &_time) const;
 
      public: const Time &operator -=(const Time &_time);
 
      public: Time operator *(const struct timespec &_tv) const;
 
      public: const Time &operator *=(const struct timespec &_tv);
 
      public: Time operator *(const Time &_time) const;
 
      public: const Time &operator *=(const Time &_time);
 
      public: const Time &operator /=(const struct timespec &_tv);
 
      public: Time operator /(const Time &_time) const;
 
      public: const Time &operator /=(const Time &time);
 
      public: bool operator==(const Time &_time) const;
 
      public: bool operator==(double _time) const;
 
      public: bool operator!=(const Time &_time) const;
 
      public: bool operator!=(double _time) const;
 
      public: bool operator<(const Time &_time) const;
 
      public: bool operator<(double _time) const;
 
      public: bool operator<=(const Time &_time) const;
 
      public: bool operator<=(double _time) const;
 
      public: bool operator>(const struct timespec &_tv) const;
 
      public: bool operator>(const Time &_time) const;
 
      public: bool operator>(double _time) const;
 
      public: bool operator>=(const Time &_time) const;
 
      public: bool operator>=(const struct timespec &_tv) const;
 
      public: bool operator>=(double _time) const;
 
      public: friend std::ostream &operator<<(std::ostream &_out,
                  const ignition::common::Time &_time)
              {
                _out << _time.sec << " " << _time.nsec;
                return _out;
              }
 
      public: friend std::istream &operator>>(std::istream &_in,
                                              ignition::common::Time &_time)
              {
                // Skip white spaces
                _in.setf(std::ios_base::skipws);
                _in >> _time.sec >> _time.nsec;
                return _in;
              }
 
      public: int32_t sec;
 
      public: int32_t nsec;
 
      private: static Time wallTime;
 
      private: inline void Correct()
               {
                 // In the case sec and nsec have different signs, normalize
                 if (this->sec > 0 && this->nsec < 0)
                 {
                   int32_t n = abs(this->nsec / this->nsInSec) + 1;
                   this->sec -= n;
                   this->nsec += n * this->nsInSec;
                 }
                 if (this->sec < 0 && this->nsec > 0)
                 {
                   int32_t n = abs(this->nsec / this->nsInSec) + 1;
                   this->sec += n;
                   this->nsec -= n * this->nsInSec;
                 }
 
                 // Make any corrections
                 this->sec += this->nsec / this->nsInSec;
                 this->nsec = this->nsec % this->nsInSec;
               }
 
      private: static const int32_t nsInSec;
 
      private: static const int32_t nsInMs;
 
      private: static struct timespec clockResolution;
    };
  }
}
#endif