source/time/timestamp.h

   1 /* $Id$
   2
   3 This file is part of libmspcore
   4 Copyright © 2006, 2009  Mikko Rasa, Mikkosoft Productions
   5 Distributed under the LGPL
   6 */
   7
   8 #ifndef MSP_TIME_TIMESTAMP_H_
   9 #define MSP_TIME_TIMESTAMP_H_
  10
  11 #include "timedelta.h"
  12 #include "types.h"
  13
  14 namespace Msp {
  15 namespace Time {
  16
  17 /**
  18 Represents a moment in time.  The main source of TimeStamps is the now()
  19 function.
  20
  21 For representing user-specified times, use the DateTime class.
  22 */
  23 class TimeStamp
  24 {
  25 private:
  26         RawTime usec;
  27
  28 public:
  29         /**
  30         Construct a TimeStamp that represents an arbitarily distant point in the
  31         past.  It's guaranteed to be less than any valid timestamp.
  32         */
  33         TimeStamp(): usec(0) { }
  34
  35         /**
  36         Constructs a TimeStamp from a plain number.  The purpose of this is to allow
  37         serialization together with the raw() function.
  38         */
  39         explicit TimeStamp(RawTime u): usec(u) { }
  40
  41         /**
  42         Returns the raw number stored inside the TimeStamp.  This value should be
  43         considered opaque and only be used for serialization.
  44         */
  45         RawTime raw() const { return usec; }
  46
  47         time_t to_unixtime() const { return usec/1000000LL; }
  48
  49         TimeStamp operator+(const TimeDelta &t) const  { return TimeStamp(usec+t.raw()); }
  50         TimeStamp &operator+=(const TimeDelta &t)      { usec+=t.raw(); return *this; }
  51         TimeStamp operator-(const TimeDelta &t) const  { return TimeStamp(usec-t.raw()); }
  52         TimeStamp &operator-=(const TimeDelta &t)      { usec-=t.raw(); return *this; }
  53         TimeDelta operator-(const TimeStamp &t) const  { return TimeDelta(usec-t.usec); }
  54
  55         bool      operator>=(const TimeStamp &t) const { return usec>=t.usec; }
  56         bool      operator>(const TimeStamp &t) const  { return usec>t.usec; }
  57         bool      operator<=(const TimeStamp &t) const { return usec<=t.usec; }
  58         bool      operator<(const TimeStamp &t) const  { return usec<t.usec; }
  59         bool      operator==(const TimeStamp &t) const { return usec==t.usec; }
  60         bool      operator!=(const TimeStamp &t) const { return usec!=t.usec; }
  61
  62         operator const void *() const                  { return usec>0 ? this : 0; }
  63
  64         static TimeStamp from_unixtime(time_t t) { return TimeStamp(t*1000000LL); }
  65 };
  66
  67 } // namespace Time
  68 } // namespace Msp
  69
  70 #endif