src/marnav/nmea/date.hpp

   1 #ifndef MARNAV__NMEA__DATE__HPP
   2 #define MARNAV__NMEA__DATE__HPP
   3
   4 #include <string>
   5
   6 namespace marnav
   7 {
   8 namespace nmea
   9 {
  10
  11 /// Enumeration of all months of a year.
  12 enum class month : uint32_t {
  13         january = 1,
  14         february,
  15         march,
  16         april,
  17         may,
  18         june,
  19         july,
  20         august,
  21         september,
  22         october,
  23         november,
  24         december
  25 };
  26
  27 /// This class represents a date, suitable to be used in NMEA sentences.
  28 ///
  29 class date
  30 {
  31 public:
  32         date();
  33         date(uint32_t y, month m, uint32_t d);
  34
  35         /// Returns the year component.
  36         uint32_t year() const noexcept;
  37
  38         /// Returns the month component.
  39         month mon() const noexcept;
  40
  41         /// Returns the day component.
  42         uint32_t day() const noexcept;
  43
  44         friend bool operator==(const date & a, const date & b) noexcept;
  45
  46         /// Parses the date within the specified string.
  47         /// The date to be parsed must be in the form: "DDMMYY"
  48         static date parse(const std::string & str);
  49
  50         /// Returns true if the specified year is a leap year. This function
  51         /// does not work for dates before 17?? (only for julian calendar).
  52         ///
  53         /// Every fourth year is a leap year except for every 100 years,
  54         /// except every 400 years.
  55         static constexpr bool is_leap_year(uint32_t year) noexcept
  56         {
  57                 return ((year % 4) == 0) && (((year % 100) != 0) || ((year % 400) == 0));
  58         }
  59
  60 private:
  61         bool check() const noexcept;
  62
  63         uint32_t y_; // year
  64         month m_;
  65         uint32_t d_; // day: 1..31
  66 };
  67
  68 bool operator==(const date & a, const date & b) noexcept;
  69 std::string to_string(const date & d);
  70 }
  71 }
  72
  73 #endif