Blame view

src/timestamp.h 2.46 KB
5251bf3a   Steven de Ridder   Initial commit. d...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
  #ifndef OSDEV_COMPONENTS_TIMESTAMP_H
  #define OSDEV_COMPONENTS_TIMESTAMP_H
  
  #include <limits>
  #include <stdexcept>
  
  #include <QString>
  
  namespace osdev {
  namespace components {
  
  /**
   * @brief Timestamp class that allows formation of a sequence of ordered events.
   */
  class Timestamp
  {
  public:
      /**
       * @brief Creates an invalid timestamp. This is the oldest possible timestamp.
       * @note A timestamp can only become valid by assigning a valid timestamp to it.
       */
      Timestamp();
  
      /**
       * @brief Creates a timestamp based on miliseconds since the epoch.
       * @param msecsSinceEpoch Number of miliseconds since the epoch. Value 0 leads to valid timestamp.
       * @note Timestamp with value 0 is larger then the invalid timestamp.
       */
      explicit Timestamp(unsigned long long msecsSinceEpoch);
  
  
      // default constructable and movable.
      Timestamp(const Timestamp&) = default;
      Timestamp& operator=(const Timestamp&) = default;
      Timestamp(Timestamp&&) = default;
      Timestamp& operator=(Timestamp&&) = default;
  
      /**
       * @return true if this timestamp is valid, false otherwise.
       */
      bool valid() const
      {
          return (m_seqNr > 0);
      }
  
      /**
       * @return true if this timestamp is smaller (older) then rhs.
       */
      bool operator<(const Timestamp& rhs) const;
  
      /**
       * @brief Prefix addition operator.
       * Increases the Timestamp sequencenumber so that timestamps with the same number of msecs since the epoch can also be ordered.
       * @note An invalid timestamp remains invalid.
       * @return Reference to this timestamp.
       * @throw std::out_of_range exception when seqnr is about to overflow.
       */
      Timestamp& operator++();
  
      /**
       * @brief Postfix addition operator.
       * Increases the Timestamp sequencenumber so that timestamps with the same number of msecs since the epoch can also be ordered.
       * @note An invalid timestamp remains invalid.
       * @return The timestamp as it was before increment.
       * @throw std::out_of_range exception when seqnr is about to overflow.
       */
      Timestamp operator++(int);
  
      /**
       * @return Stringified timestamp as msecsSinceEpoch:seqNr.
       */
      QString toString() const;
  
  private:
      unsigned long long m_msecsSinceEpoch;   ///< Number of miliseconds since the epoch.
      unsigned long long m_seqNr;             ///< Sequence number.
  };
  
  }       /* End namespace components */
  }       /* End namespace osdev      */
  
  #endif  /* OSDEV_COMPONENTS_TIMESTAMP_H */