month.hpp

Go to the documentation of this file.

// Copyright 2023 Leidos
//
// 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 CARMA_COOPERATIVE_PERCEPTION__MONTH_HPP_
#define CARMA_COOPERATIVE_PERCEPTION__MONTH_HPP_
 
#include <array>
#include <ostream>
 
namespace carma_cooperative_perception
{
class Month
{
public:
  Month() = default;
 
  uint8_t get_value() const { return month_value_; }
 
  constexpr explicit Month(std::uint8_t month_value) : month_value_{month_value} {}
 
  constexpr auto operator++() -> Month &
  {
    constexpr auto jan_value{1U};
    constexpr auto dec_value{12U};
 
    month_value_ = (month_value_ + 1) % (dec_value + 1);
 
    if (month_value_ == 0) {
      month_value_ = jan_value;
    }
 
    return *this;
  }
 
  constexpr auto operator++(int /* dummy parameter */) -> Month
  {
    Month previous{*this};
    ++(*this);
 
    return previous;
  }
 
  constexpr auto operator--() -> Month &
  {
    constexpr auto dec_value{12U};
 
    month_value_ = (month_value_ - 1 % (dec_value + 1));
 
    if (month_value_ == 0) {
      month_value_ = dec_value;
    }
 
    return *this;
  }
 
  constexpr auto operator--(int /* dummy parameter */) -> Month
  {
    Month previous{*this};
    --(*this);
 
    return previous;
  }
 
  constexpr explicit operator unsigned() const { return static_cast<unsigned>(month_value_); }
 
  [[nodiscard]] constexpr auto ok() const -> bool
  {
    constexpr auto jan_value{1U};
    constexpr auto dec_value{12U};
 
    return month_value_ >= jan_value && month_value_ <= dec_value;
  }
 
  friend constexpr auto operator==(const Month & x, const Month & y) -> bool
  {
    return x.month_value_ == y.month_value_;
  }
 
  friend constexpr auto operator!=(const Month & x, const Month & y) -> bool { return !(x == y); }
 
  friend constexpr auto operator<(const Month & x, const Month & y) -> bool
  {
    return x.month_value_ < y.month_value_;
  }
 
  friend constexpr auto operator<=(const Month & x, const Month & y) -> bool
  {
    return x < y || x == y;
  }
 
  friend constexpr auto operator>(const Month & x, const Month & y) -> bool
  {
    return x.month_value_ > y.month_value_;
  }
 
  friend constexpr auto operator>=(const Month & x, const Month & y) -> bool
  {
    return x > y || x == y;
  }
 
  template <typename CharT, typename Traits>
  friend auto operator<<(std::basic_ostream<CharT, Traits> & os, const Month & m)
    -> std::basic_ostream<CharT, Traits> &
  {
    static constexpr std::array abbreviations{"Jan.", "Feb.", "Mar.", "Apr.", "May",  "Jun.",
                                              "Jul.", "Aug.", "Sep.", "Oct.", "Nov.", "Dec."};
    if (!m.ok()) {
      return os << static_cast<unsigned>(m) << " is not a valid month";
    }
 
    return os << abbreviations.at(static_cast<unsigned>(m) - 1);
  }
 
private:
  std::uint8_t month_value_;
};
 
inline constexpr Month January{1};
inline constexpr Month February{2};
inline constexpr Month March{3};
inline constexpr Month April{4};
inline constexpr Month May{5};
inline constexpr Month June{6};
inline constexpr Month July{7};
inline constexpr Month August{8};
inline constexpr Month September{9};
inline constexpr Month October{10};
inline constexpr Month November{11};
inline constexpr Month December{12};
 
}  // namespace carma_cooperative_perception
 
#endif  // CARMA_COOPERATIVE_PERCEPTION__MONTH_HPP_