LSST Applications  21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
LSST Data Management Base Package
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 }; // EPOCH is Julian epoch year
67  // e.g. 2000.0 for J2000
68  enum Timescale {
69  TAI = 5,
70  UTC,
71  TT
72  }; // use values that do not overlap DateSystem
73  // to avoid confusing one for the other in Python
74  // an invalid DateTime has _nsec == invalid_nsecs
75  constexpr static long long invalid_nsecs = std::numeric_limits<std::int64_t>::min();
76 
80  explicit DateTime();
81 
91  explicit DateTime(long long nsecs, Timescale scale = TAI);
92 
101  explicit DateTime(double date, DateSystem system = MJD, Timescale scale = TAI);
102 
116  DateTime(int year, int month, int day, int hr, int min, int sec, Timescale scale = TAI);
117 
134  explicit DateTime(std::string const& iso8601, Timescale scale);
135 
146  long long nsecs(Timescale scale = TAI) const;
147 
157  double get(DateSystem system = MJD, Timescale scale = TAI) const;
158 
169  std::string toString(Timescale scale) const;
170 
178  struct tm gmtime(Timescale scale) const;
179 
188  struct timespec timespec(Timescale scale) const;
189 
198  struct timeval timeval(Timescale scale) const;
199 
203  bool isValid() const { return _nsecs != DateTime::invalid_nsecs; };
204 
205  bool operator==(DateTime const& rhs) const;
206 
208  std::size_t hash_value() const noexcept;
209 
214  static DateTime now(void);
215 
224  static void initializeLeapSeconds(std::string const& leapString);
225 
226 private:
227  long long _nsecs;
228 
230  void _assertValid() const {
231  if (!isValid()) {
232  throw LSST_EXCEPT(pex::exceptions::RuntimeError, "DateTime not valid");
233  }
234  }
235 
243  double _getMjd(Timescale scale) const;
244 
252  double _getJd(Timescale scale) const;
253 
262  double _getEpoch(Timescale scale) const;
263 
271  void setNsecsFromMjd(double mjd, Timescale scale);
272 
280  void setNsecsFromJd(double jd, Timescale scale);
281 
289  void setNsecsFromEpoch(double epoch, Timescale scale);
290 
291  friend class boost::serialization::access;
292 
299  template <class Archive>
300  void serialize(Archive ar, int const version) {
301  ar& _nsecs;
302  }
303 };
304 
305 } // namespace base
306 } // namespace daf
307 } // namespace lsst
308 
309 namespace std {
310 template <>
311 struct hash<lsst::daf::base::DateTime> {
314  size_t operator()(argument_type const& obj) const noexcept { return obj.hash_value(); }
315 };
316 } // namespace std
317 
318 #endif
int min
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
Basic LSST definitions.
#define LSST_EXPORT
Make a symbol visible even if visiblity is hidden (e.g.
Definition: base.h:37
Class for handling dates/times, including MJD, UTC, and TAI.
Definition: DateTime.h:64
bool isValid() const
Is this date valid?
Definition: DateTime.h:203
constexpr static long long invalid_nsecs
Definition: DateTime.h:75
Reports errors that are due to events beyond the control of the program.
Definition: Runtime.h:104
bool isValid
Definition: fits.cc:399
T min(T... args)
Definition: Polygon.cc:24
def scale(algorithm, min, max=None, frame=None)
Definition: ds9.py:108
bool operator==(FilterProperty const &rhs) const noexcept
Return true iff two FilterProperties are identical.
std::size_t hash_value() const noexcept
Return a hash of this object.
A base class for image defects.
STL namespace.
size_t operator()(argument_type const &obj) const noexcept
Definition: DateTime.h:314