17 #ifndef IGNITION_COMMON_TIME_HH_
18 #define IGNITION_COMMON_TIME_HH_
23 #include <ignition/common/Export.hh>
33 class IGNITION_COMMON_VISIBLE
Time
63 public:
explicit Time(
const struct timespec &_tv);
68 public:
Time(int32_t _sec, int32_t _nsec);
72 public:
explicit Time(
double _time);
84 public:
void Set(int32_t _sec, int32_t _nsec);
88 public:
void Set(
double _seconds);
130 public:
const Time &operator +=(
const Time &_time);
135 public:
Time operator -(
const struct timespec &_tv)
const;
140 public:
const Time &operator -=(
const struct timespec &_tv);
150 public:
const Time &operator -=(
const Time &_time);
155 public:
Time operator *(
const struct timespec &_tv)
const;
160 public:
const Time &operator *=(
const struct timespec &_tv);
170 public:
const Time &operator *=(
const Time &_time);
175 public:
const Time &operator /=(
const struct timespec &_tv);
230 public:
bool operator>(
const struct timespec &_tv)
const;
264 _out << _time.
sec <<
" " << _time.
nsec;
276 _in.
setf(std::ios_base::skipws);
277 _in >> _time.
sec >> _time.
nsec;
288 private:
static Time wallTime;
292 private:
inline void Correct()
295 if (this->sec > 0 && this->nsec < 0)
297 int32_t n = abs(this->nsec / this->nsInSec) + 1;
299 this->nsec += n * this->nsInSec;
301 if (this->sec < 0 && this->nsec > 0)
303 int32_t n = abs(this->nsec / this->nsInSec) + 1;
305 this->nsec -= n * this->nsInSec;
309 this->sec += this->nsec / this->nsInSec;
310 this->nsec = this->nsec % this->nsInSec;
314 private:
static const int32_t nsInSec;
318 private:
static const int32_t nsInMs;
320 private:
static struct timespec clockResolution;
A Time class, can be used to hold wall- or sim-time. stored as sec and nano-sec.
Definition: Time.hh:34
Time(int32_t _sec, int32_t _nsec)
Constructor.
bool operator>=(const struct timespec &_tv) const
Greater than or equal operator.
static Time Sleep(const common::Time &_time)
Sleep for the specified time.
Time & operator=(const Time &_time)
Assignment operator.
bool operator>(const struct timespec &_tv) const
Greater than operator.
bool operator<(double _time) const
Less than operator.
static const Time & SystemTime()
Get the wall time.
bool operator<(const Time &_time) const
Less than operator.
friend std::istream & operator>>(std::istream &_in, Time &_time)
Stream extraction operator.
Definition: Time.hh:272
double Double() const
Get the time as a double.
friend std::ostream & operator<<(std::ostream &_out, const Time &_time)
Stream insertion operator.
Definition: Time.hh:261
bool operator==(const Time &_time) const
Equal to operator.
bool operator==(double _time) const
Equal to operator.
std::string FormattedString(FormatOption _start=FormatOption::DAYS, FormatOption _end=FormatOption::MILLISECONDS) const
Get the time as a string formatted as "DD hh:mm:ss.mmm", with the option to choose the start/end.
int32_t nsec
Nanoseconds.
Definition: Time.hh:285
bool operator>(const Time &_time) const
Greater than operator.
bool operator>=(double _time) const
Greater than or equal operator.
virtual ~Time()
Destructor.
bool operator<=(const Time &_time) const
Less than or equal to operator.
Time(double _time)
Constuctor.
bool operator<=(double _time) const
Less than or equal to operator.
float Float() const
Get the time as a float.
FormatOption
Definition: Time.hh:41
bool operator!=(double _time) const
Equal to operator.
bool operator>=(const Time &_time) const
Greater than or equal operator.
int32_t sec
Seconds.
Definition: Time.hh:282
static const Time Zero
A static zero time variable set to common::Time(0, 0).
Definition: Time.hh:36
Time operator+(const Time &_time) const
Addition operators.
void Set(double _seconds)
Set to seconds.
void Set(int32_t _sec, int32_t _nsec)
Set to sec and nsec.
bool operator!=(const Time &_time) const
Equal to operator.
bool operator>(double _time) const
Greater than operator.
Time(const struct timespec &_tv)
Constructor.
Time(const Time &_time)
Copy constructor.
Forward declarations for the common classes.