LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
LSST Data Management Base Package
Loading...
Searching...
No Matches
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
37
43
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.
54namespace boost {
55namespace serialization {
56class access;
57}
58} // namespace boost
59
60namespace lsst {
61namespace daf {
62namespace base {
63
65public:
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,
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
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
226private:
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
309namespace std {
310template <>
311struct 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
#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
DateTime()
Default constructor: construct an invalid DateTime.
Definition DateTime.cc:307
Class for handling dates/times, including MJD, UTC, and TAI.
Definition DateTime.h:64
DateTime()
Default constructor: construct an invalid DateTime.
Definition DateTime.cc:307
std::string toString(Timescale scale) const
Get date as an ISO8601-formatted string.
Definition DateTime.cc:500
bool isValid() const
Is this date valid?
Definition DateTime.h:203
struct timespec timespec(Timescale scale) const
Get date as a timespec struct, with time in seconds and nanoseconds.
Definition DateTime.cc:482
double get(DateSystem system=MJD, Timescale scale=TAI) const
Get date as a double in a specified representation, such as MJD.
Definition DateTime.cc:430
struct timeval timeval(Timescale scale) const
Get date as a timeval struct, with time in seconds and microseconds.
Definition DateTime.cc:491
struct tm gmtime(Timescale scale) const
Get date as a tm struct, with truncated fractional seconds.
Definition DateTime.cc:466
static constexpr long long invalid_nsecs
Definition DateTime.h:75
long long nsecs(Timescale scale=TAI) const
Get date as nanoseconds since the unix epoch.
Definition DateTime.cc:448
Reports errors that are due to events beyond the control of the program.
Definition Runtime.h:104
T min(T... args)
STL namespace.
lsst::daf::base::DateTime argument_type
Definition DateTime.h:312
size_t operator()(argument_type const &obj) const noexcept
Definition DateTime.h:314