TimeSpan.h++

Go to the documentation of this file.

/* ---------------------------------------------------------------------------
   commonc++ - A C++ Common Class Library
   Copyright (C) 2005-2012  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_TimeSpan_hxx
#define __ccxx_TimeSpan_hxx

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

namespace ccxx {

class COMMONCPP_API TimeSpan
{
  public:

  TimeSpan(int64_t span = INT64_CONST(0)) throw();

  TimeSpan(int days, int hours, int minutes, int seconds, int msec = 0)
    throw();

  TimeSpan(const TimeSpan& other) throw();

  ~TimeSpan() throw();

  void setSpan(int days, int hours, int minutes, int seconds, int msec = 0)
    throw();

  void setSpan(int64_t seconds) throw();

  inline int64_t getSpan() const throw()
  { return(_span); }

  void setDays(int days) throw();

  void addDays(int days) throw();

  void subtractDays(int days) throw();

  inline int getDays() const throw()
  { return(_days); }

  void setHours(int hours) throw();

  void addHours(int hours) throw();

  void subtractHours(int hours) throw();

  inline int getHours() const throw()
  { return(_hours); }

  void setMinutes(int minutes) throw();

  void addMinutes(int minutes) throw();

  void subtractMinutes(int minutes) throw();

  inline int getMinutes() const throw()
  { return(_minutes); }

  void setSeconds(int seconds) throw();

  void addSeconds(int seconds) throw();

  void subtractSeconds(int seconds) throw();

  inline int getSeconds() const throw()
  { return(_seconds); }

  void setMilliseconds(int msec) throw();

  void addMilliseconds(int msec) throw();

  void subtractMilliseconds(int msec) throw();

  inline int getMilliseconds() const throw()
  { return(_msec); }

  TimeSpan& operator=(const TimeSpan& other) throw();

  inline bool operator==(const TimeSpan& other) const throw()
  { return(_span == other._span); }

  inline bool operator<(const TimeSpan& other) const throw()
  { return(_span < other._span); }

  inline bool operator<=(const TimeSpan& other) const throw()
  { return(_span <= other._span); }

  inline bool operator!=(const TimeSpan& other) const throw()
  { return(_span != other._span); }

  inline bool operator>(const TimeSpan& other) const throw()
  { return(_span > other._span); }

  inline bool operator>=(const TimeSpan& other) const throw()
  { return(_span >= other._span); }

  TimeSpan& operator+=(const TimeSpan& span) throw();
  TimeSpan& operator+=(int seconds) throw();
  TimeSpan& operator-=(const TimeSpan& span) throw();
  TimeSpan& operator-=(int seconds) throw();

  TimeSpan operator-() const throw();

  inline int64_t toSeconds() const throw()
  { return(_span / msInSecond); }

  inline operator int64_t() const throw()
  { return(_span); }

  inline int64_t toMilliseconds() const throw()
  { return(_span); }

  String toString() const;

  static const int msInSecond;

  static const int msInMinute;

  static const int msInHour;

  static const int msInDay;

  private:

  void _computeFields(int days, int hours, int minutes, int seconds,
                      int msec) throw();
  void _computeFields(int64_t span) throw();

  int _days;
  int _hours;
  int _minutes;
  int _seconds;
  int _msec;
  int64_t _span;
};

}; // namespace ccxx

#endif // __ccxx_TimeSpan_hxx

/* end of header file */