Add some explicit declarations to constructors.

[libdcp.git] / src / local_time.h

diff --git a/src/local_time.h b/src/local_time.h
index 00b32f109b7ff9b839b978e09a8ce1740bf75994..9407aeed5962a586d2b64857e5f80495963c6a7f 100644 (file)
--- a/src/local_time.h
+++ b/src/local_time.h
@@ -1,22 +1,26 @@
 /*
-    Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2014-2015 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of libdcp.
+
+    libdcp 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 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    libdcp 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 this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
+    along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
 */
 
+/** @file  src/local_time.h
+ *  @brief LocalTime class.
+ */
+
 #ifndef LIBDCP_LOCAL_TIME_H
 #define LIBDCP_LOCAL_TIME_H
 
@@ -27,19 +31,29 @@ class local_time_test;
 
 namespace dcp {
 
-/** I tried to use boost for this, really I did, but I could not get it
+/** @class LocalTime
+ *  @brief A representation of a local time (down to the second), including its offset
+ *  from GMT (equivalent to xs:dateTime).
+ *
+ *  I tried to use boost for this, really I did, but I could not get it
  *  to parse strings of the required format (those that include time zones).
+ *
+ *  See http://www.w3.org/TR/xmlschema-2/#dateTime
  */
 class LocalTime
 {
 public:
        LocalTime ();
-       LocalTime (boost::posix_time::ptime);
-       LocalTime (std::string);
+       explicit LocalTime (boost::posix_time::ptime);
+       LocalTime (boost::posix_time::ptime, int tz_hour, int tz_minute);
+       explicit LocalTime (std::string);
 
-       std::string as_string () const;
+       std::string as_string (bool with_millisecond = false) const;
        std::string date () const;
-       std::string time_of_day () const;
+       std::string time_of_day (bool with_millisecond = false) const;
+
+       bool operator== (LocalTime const & other) const;
+       bool operator!= (LocalTime const & other) const;
 
 private:
        friend class ::local_time_test;
@@ -47,18 +61,21 @@ private:
        void set_local_time_zone ();
 
        /* Local time */
-       int _year;
-       int _month;
-       int _day;
-       int _hour;
-       int _minute;
-       int _second;
-
-       /* Amount by which this time is offset from UTC */
-       int _tz_hour;
-       int _tz_minute;
+       int _year;   ///< year
+       int _month;  ///< month number of the year (1-12)
+       int _day;    ///< day number of the month (1-31)
+       int _hour;   ///< hour number of the day (0-23)
+       int _minute; ///< minute number of the hour (0-59)
+       int _second; ///< second number of the minute (0-59)
+       int _millisecond; ///< millisecond number of the second (0-999)
+
+       int _tz_hour;   ///< hours by which this time is offset from UTC
+       int _tz_minute; ///< minutes by which this time is offset from UTC
 };
 
+std::ostream&
+operator<< (std::ostream& s, LocalTime const & t);
+
 }
 
 #endif