TimeSpec.h++

Go to the documentation of this file.

/* ---------------------------------------------------------------------------
   commonc++ - A C++ Common Class Library
   Copyright (C) 2005-2014  Mark A Lindner

   This file is part of commonc++.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
   ---------------------------------------------------------------------------
*/

#ifndef __ccxx_TimeSpec_hxx
#define __ccxx_TimeSpec_hxx

#include <commonc++/Common.h++>
#include <commonc++/BitSet.h++>
#include <commonc++/DateTime.h++>
#include <commonc++/String.h++>

namespace ccxx {

class COMMONCPP_API TimeSpec
{
 public:

  TimeSpec();

  TimeSpec(const DateTime& time);

  TimeSpec(uint_t hour, uint_t minute);

  TimeSpec(uint_t hour, uint_t minute, uint_t month, uint_t day);

  TimeSpec(const String& spec);

  virtual ~TimeSpec();

  void setSpec(const String& spec);

  TimeSpec& setMonth(uint_t month);

  TimeSpec& setMonths(uint_t month1, uint_t month2);

  TimeSpec& clearMonth(uint_t month);

  TimeSpec& clearMonths(uint_t month1, uint_t month2);

  TimeSpec& setAllMonths();

  TimeSpec& clearAllMonths();

  TimeSpec& setDay(uint_t day);

  TimeSpec& setDays(uint_t day1, uint_t day2);

  TimeSpec& clearDay(uint_t day);

  TimeSpec& clearDays(uint_t day1, uint_t day2);

  TimeSpec& setAllDays();

  TimeSpec& clearAllDays();

  TimeSpec& setDayOfWeek(uint_t dow);

  TimeSpec& setDaysOfWeek(uint_t dow1, uint_t dow2);

  TimeSpec& clearDayOfWeek(uint_t dow);

  TimeSpec& clearDaysOfWeek(uint_t dow1, uint_t dow2);

  TimeSpec& setAllDaysOfWeek();

  TimeSpec& clearAllDaysOfWeek();

  TimeSpec& setHour(uint_t hour);

  TimeSpec& setHours(uint_t hour1, uint_t hour2);

  TimeSpec& clearHour(uint_t hour);

  TimeSpec& clearHours(uint_t hour1, uint_t hour2);

  TimeSpec& setAllHours();

  TimeSpec& clearAllHours();

  TimeSpec& setMinute(uint_t minute);

  TimeSpec& setMinutes(uint_t minute1, uint_t minute2);

  TimeSpec& clearMinute(uint_t minute);

  TimeSpec& clearMinutes(uint_t minute1, uint_t minute2);

  TimeSpec& setAllMinutes();

  TimeSpec& clearAllMinutes();

  bool matches(time_s_t time) const;

  bool matches(time_ms_t time) const;

  bool matches(uint_t month, uint_t day, uint_t weekday, uint_t hour,
               uint_t minute) const;

  String toString() const;

 private:

  void _parseValues(String str, uint_t base, BitSet& set);
  void _set(BitSet& bset, uint_t base, uint_t pos, bool set);
  void _setRange(BitSet& bset, uint_t base, uint_t min, uint_t max, bool set);
  void _format(const BitSet& set, uint_t base, String& s) const;

  BitSet _months;
  BitSet _days;
  BitSet _dow;
  BitSet _hours;
  BitSet _minutes;
};

} // namespace ccxx

#endif // __ccxx_TimeSpec_hxx