libdcp
local_time.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2014-2021 Carl Hetherington <cth@carlh.net>
3 
4  This file is part of libdcp.
5 
6  libdcp is free software; you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation; either version 2 of the License, or
9  (at your option) any later version.
10 
11  libdcp is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU General Public License for more details.
15 
16  You should have received a copy of the GNU General Public License
17  along with libdcp. If not, see <http://www.gnu.org/licenses/>.
18 
19  In addition, as a special exception, the copyright holders give
20  permission to link the code of portions of this program with the
21  OpenSSL library under certain conditions as described in each
22  individual source file, and distribute linked combinations
23  including the two.
24 
25  You must obey the GNU General Public License in all respects
26  for all of the code used other than OpenSSL. If you modify
27  file(s) with this exception, you may extend this exception to your
28  version of the file(s), but you are not obligated to do so. If you
29  do not wish to do so, delete this exception statement from your
30  version. If you delete this exception statement from all source
31  files in the program, then also delete it here.
32 */
33 
34 
40 #ifndef LIBDCP_LOCAL_TIME_H
41 #define LIBDCP_LOCAL_TIME_H
42 
43 
44 #include "utc_offset.h"
45 #include <boost/date_time/posix_time/posix_time.hpp>
46 #include <string>
47 
48 
49 struct local_time_basic_test;
50 
51 
52 namespace dcp {
53 
54 
67 class LocalTime
68 {
69 public:
71  LocalTime ();
72 
73  explicit LocalTime (struct tm tm);
74 
78  explicit LocalTime (boost::posix_time::ptime);
79 
81  LocalTime(boost::posix_time::ptime, UTCOffset offset);
82 
84  explicit LocalTime (std::string s);
85 
86  LocalTime(int year, int month, int day, int hour, int minute, UTCOffset offset)
87  : _year(year)
88  , _month(month)
89  , _day(day)
90  , _hour(hour)
91  , _minute(minute)
92  , _offset(offset)
93  {}
94 
98  std::string as_string(bool with_millisecond = false, bool with_timezone = true) const;
99 
101  std::string date () const;
102 
104  std::string time_of_day (bool with_second, bool with_millisecond) const;
105 
106  int day () const {
107  return _day;
108  }
109 
110  int month () const {
111  return _month;
112  }
113 
114  int year () const {
115  return _year;
116  }
117 
118  int hour () const {
119  return _hour;
120  }
121 
122  int minute () const {
123  return _minute;
124  }
125 
126  int second () const {
127  return _second;
128  }
129 
130  int millisecond() const {
131  return _millisecond;
132  }
133 
134  void set_day(int d) {
135  _day = d;
136  }
137 
138  void set_month(int m) {
139  _month = m;
140  }
141 
142  void set_year (int y) {
143  _year = y;
144  }
145 
146  void set_offset(UTCOffset offset) {
147  _offset = offset;
148  }
149 
150  void add_days (int d);
151  void add_months (int a);
152  void add_minutes (int a);
153 
154  void add(boost::posix_time::time_duration duration);
155 
156  static LocalTime from_asn1_utc_time (std::string time);
157  static LocalTime from_asn1_generalized_time (std::string time);
158 
159  bool operator== (LocalTime const & other) const;
160  bool operator!= (LocalTime const & other) const;
161  bool operator< (LocalTime const & other) const;
162  bool operator<=(LocalTime const & other) const;
163  bool operator>(LocalTime const & other) const;
164  bool operator>=(LocalTime const & other) const;
165 
166 private:
167  friend struct ::local_time_basic_test;
168 
169  void set (struct tm const * tm);
170  void set (boost::posix_time::ptime);
171  void set_local_time_zone ();
172  dcp::LocalTime as_utc() const;
173 
174  /* Local time */
175  int _year = 0;
176  int _month = 0;
177  int _day = 0;
178  int _hour = 0;
179  int _minute = 0;
180  int _second = 0;
181  int _millisecond = 0;
182 
183  UTCOffset _offset;
184 };
185 
186 
187 std::ostream&
188 operator<< (std::ostream& s, LocalTime const & t);
189 
190 
191 }
192 
193 
194 #endif
A representation of a local time (down to the second), including its offset from GMT (equivalent to x...
Definition: local_time.h:68
std::string date() const
Definition: local_time.cc:211
int _day
day number of the month (1-31)
Definition: local_time.h:177
int _hour
hour number of the day (0-23)
Definition: local_time.h:178
int _millisecond
millisecond number of the second (0-999)
Definition: local_time.h:181
std::string time_of_day(bool with_second, bool with_millisecond) const
Definition: local_time.cc:220
std::string as_string(bool with_millisecond=false, bool with_timezone=true) const
Definition: local_time.cc:188
void set_local_time_zone()
Definition: local_time.cc:115
int _second
second number of the minute (0-59)
Definition: local_time.h:180
int _month
month number of the year (1-12)
Definition: local_time.h:176
int _year
year
Definition: local_time.h:175
int _minute
minute number of the hour (0-59)
Definition: local_time.h:179
Namespace for everything in libdcp.
Definition: array_data.h:50