Adding schedule related classes: Schedule, RepetitiveInterval and Interval
Change-Id: Ia3fa750270f49c1b9e3bc4c6f67281c527910c55
Refs: #3118
diff --git a/src/repetitive-interval.hpp b/src/repetitive-interval.hpp
new file mode 100644
index 0000000..1e8127f
--- /dev/null
+++ b/src/repetitive-interval.hpp
@@ -0,0 +1,145 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+/**
+ * Copyright (c) 2014-2015, Regents of the University of California
+ *
+ * This file is part of ndn-group-encrypt (Group-based Encryption Protocol for NDN).
+ * See AUTHORS.md for complete list of ndn-group-encrypt authors and contributors.
+ *
+ * ndn-group-encrypt is free software: you can redistribute it and/or modify it under the terms
+ * of the GNU General Public License as published by the Free Software Foundation,
+ * either version 3 of the License, or (at your option) any later version.
+ *
+ * ndn-group-encrypt is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
+ * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ * PURPOSE. See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * ndn-group-encrypt, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @author Zhiyi Zhang <dreamerbarrychang@gmail.com>
+ */
+
+#ifndef NDN_GEP_REPETITIVE_INTERVAL_HPP
+#define NDN_GEP_REPETITIVE_INTERVAL_HPP
+
+#include "common.hpp"
+#include "interval.hpp"
+
+namespace ndn {
+namespace gep {
+
+///@brief An advanced interval which can have a repeat pattern and repeat unit
+class RepetitiveInterval
+{
+public:
+ enum class RepeatUnit{
+ NONE = 0,
+ DAY = 1,
+ MONTH = 2,
+ YEAR = 3
+ };
+
+public:
+ RepetitiveInterval();
+
+ explicit
+ RepetitiveInterval(const Block& block);
+
+ /**
+ * @brief Construction to create an object
+ * @pre @p startDate <= @p endDate
+ * @pre @p intervalStartHour and @p intervalEndHour can be [0, 24]
+ * @pre @p intervalStartHour < @p intervalEndHour
+ * @pre when @p unit = NONE, then @p startDate == @p endDate
+ */
+ RepetitiveInterval(const TimeStamp& startDate,
+ const TimeStamp& endDate,
+ size_t intervalStartHour,
+ size_t intervalEndHour,
+ size_t nRepeats = 0,
+ RepeatUnit unit = RepeatUnit::NONE);
+
+ template<encoding::Tag TAG>
+ size_t
+ wireEncode(EncodingImpl<TAG>& encoder) const;
+
+ const Block&
+ wireEncode() const;
+
+ void
+ wireDecode(const Block& wire);
+
+ /**
+ * @brief Get get an interval that @p tp falls in
+ *
+ * @parameter tp A timestamp
+ *
+ * @return bool If the repetitive interval covers the @p tp, return true, otherwise false
+ * @return Interval Return the interval which @tp falls in
+ */
+ std::tuple<bool, Interval>
+ getInterval(const TimeStamp& tp) const;
+
+ /**
+ * @brief To store in std::set, class have to implement operator <
+ *
+ * @parameter interval Interval which will be compared with
+ */
+ bool
+ operator<(const RepetitiveInterval& interval) const;
+
+ const TimeStamp&
+ getStartDate() const
+ {
+ return m_startDate;
+ }
+
+ const TimeStamp&
+ getEndDate() const
+ {
+ return m_endDate;
+ }
+
+ size_t
+ getIntervalStartHour() const
+ {
+ return m_intervalStartHour;
+ }
+
+ size_t
+ getIntervalEndHour() const
+ {
+ return m_intervalEndHour;
+ }
+
+ size_t
+ getNRepeats() const
+ {
+ return m_nRepeats;
+ }
+
+ RepeatUnit
+ getRepeatUnit() const
+ {
+ return m_unit;
+ }
+
+private:
+ ///@brief Check if there is any interval in the date of timestamp
+ bool
+ hasIntervalOnDate(const TimeStamp& tp) const;
+
+ TimeStamp m_startDate;
+ TimeStamp m_endDate;
+ size_t m_intervalStartHour;
+ size_t m_intervalEndHour;
+ size_t m_nRepeats;
+ RepeatUnit m_unit;
+
+ mutable Block m_wire;
+};
+
+} // namespace gep
+} // namespace ndn
+
+#endif // NDN_GEP_REPETITIVE_INTERVAL_HPP