LSSTApplications  17.0+11,17.0+34,17.0+56,17.0+57,17.0+59,17.0+7,17.0-1-g377950a+33,17.0.1-1-g114240f+2,17.0.1-1-g4d4fbc4+28,17.0.1-1-g55520dc+49,17.0.1-1-g5f4ed7e+52,17.0.1-1-g6dd7d69+17,17.0.1-1-g8de6c91+11,17.0.1-1-gb9095d2+7,17.0.1-1-ge9fec5e+5,17.0.1-1-gf4e0155+55,17.0.1-1-gfc65f5f+50,17.0.1-1-gfc6fb1f+20,17.0.1-10-g87f9f3f+1,17.0.1-11-ge9de802+16,17.0.1-16-ga14f7d5c+4,17.0.1-17-gc79d625+1,17.0.1-17-gdae4c4a+8,17.0.1-2-g26618f5+29,17.0.1-2-g54f2ebc+9,17.0.1-2-gf403422+1,17.0.1-20-g2ca2f74+6,17.0.1-23-gf3eadeb7+1,17.0.1-3-g7e86b59+39,17.0.1-3-gb5ca14a,17.0.1-3-gd08d533+40,17.0.1-30-g596af8797,17.0.1-4-g59d126d+4,17.0.1-4-gc69c472+5,17.0.1-6-g5afd9b9+4,17.0.1-7-g35889ee+1,17.0.1-7-gc7c8782+18,17.0.1-9-gc4bbfb2+3,w.2019.22
LSSTDataManagementBasePackage
DateTime.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 
3 /*
4  * LSST Data Management System
5  * Copyright 2008, 2009, 2010 LSST Corporation.
6  *
7  * This product includes software developed by the
8  * LSST Project (http://www.lsst.org/).
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the LSST License Statement and
21  * the GNU General Public License along with this program. If not,
22  * see <http://www.lsstcorp.org/LegalNotices/>.
23  */
24 
25 #ifndef LSST_DAF_BASE_DATETIME_H
26 #define LSST_DAF_BASE_DATETIME_H
27 
44 #include <cstdint>
45 #include <ctime>
46 #include <limits>
47 #include <sys/time.h>
48 #include <string>
49 
50 #include "lsst/base.h"
51 #include "lsst/pex/exceptions.h"
52 
53 // Forward declaration of the boost::serialization::access class.
54 namespace boost {
55 namespace serialization {
56 class access;
57 }
58 } // namespace boost
59 
60 namespace lsst {
61 namespace daf {
62 namespace base {
63 
65 public:
66  enum DateSystem { JD = 0, MJD, EPOCH };
67  enum Timescale {
68  TAI = 5,
69  UTC,
70  TT
71  }; // use values that do not overlap DateSystem
72  // to avoid confusing one for the other in Python
73  // an invalid DateTime has _nsec == invalid_nsecs
74  constexpr static long long invalid_nsecs = std::numeric_limits<std::int64_t>::min();
75 
79  explicit DateTime();
80 
90  explicit DateTime(long long nsecs, Timescale scale = TAI);
91 
100  explicit DateTime(double date, DateSystem system = MJD, Timescale scale = TAI);
101 
115  DateTime(int year, int month, int day, int hr, int min, int sec, Timescale scale = TAI);
116 
133  explicit DateTime(std::string const& iso8601, Timescale scale);
134 
145  long long nsecs(Timescale scale = TAI) const;
146 
156  double get(DateSystem system = MJD, Timescale scale = TAI) const;
157 
168  std::string toString(Timescale scale) const;
169 
177  struct tm gmtime(Timescale scale) const;
178 
187  struct timespec timespec(Timescale scale) const;
188 
197  struct timeval timeval(Timescale scale) const;
198 
202  bool isValid() const { return _nsecs != DateTime::invalid_nsecs; };
203 
204  bool operator==(DateTime const& rhs) const;
205 
207  std::size_t hash_value() const noexcept;
208 
213  static DateTime now(void);
214 
223  static void initializeLeapSeconds(std::string const& leapString);
224 
225 private:
226  long long _nsecs;
227 
229  void _assertValid() const {
230  if (!isValid()) {
231  throw LSST_EXCEPT(pex::exceptions::RuntimeError, "DateTime not valid");
232  }
233  }
234 
242  double _getMjd(Timescale scale) const;
243 
251  double _getJd(Timescale scale) const;
252 
260  double _getEpoch(Timescale scale) const;
261 
269  void setNsecsFromMjd(double mjd, Timescale scale);
270 
278  void setNsecsFromJd(double jd, Timescale scale);
279 
287  void setNsecsFromEpoch(double epoch, Timescale scale);
288 
289  friend class boost::serialization::access;
290 
297  template <class Archive>
298  void serialize(Archive ar, int const version) {
299  ar& _nsecs;
300  }
301 };
302 
303 } // namespace base
304 } // namespace daf
305 } // namespace lsst
306 
307 namespace std {
308 template <>
309 struct hash<lsst::daf::base::DateTime> {
312  size_t operator()(argument_type const& obj) const noexcept { return obj.hash_value(); }
313 };
314 } // namespace std
315 
316 #endif
Class for handling dates/times, including MJD, UTC, and TAI.
Definition: DateTime.h:64
Definition: Polygon.cc:25
Basic LSST definitions.
size_t operator()(argument_type const &obj) const noexcept
Definition: DateTime.h:312
def scale(algorithm, min, max=None, frame=None)
Definition: ds9.py:109
STL namespace.
std::size_t hash_value(Extent< T, N > const &extent) noexcept
Definition: Extent.cc:127
int min
STL class.
T min(T... args)
A base class for image defects.
bool isValid
Definition: fits.cc:380
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
bool isValid() const
Is this date valid?
Definition: DateTime.h:202
#define LSST_EXPORT
Make a symbol visible even if visiblity is hidden (e.g.
Definition: base.h:54
Reports errors that are due to events beyond the control of the program.
Definition: Runtime.h:104