GTime.hpp
9.51 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
/***************************************************************************
* GTime.hpp - Time class *
* ----------------------------------------------------------------------- *
* copyright (C) 2010-2013 by Juergen Knoedlseder *
* ----------------------------------------------------------------------- *
* *
* This program 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 3 of the License, or *
* (at your option) any later version. *
* *
* This program 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, see <http://www.gnu.org/licenses/>. *
* *
***************************************************************************/
/**
* @file GTime.hpp
* @brief Time class interface definition
* @author Juergen Knoedlseder
*/
#ifndef GTIME_HPP
#define GTIME_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GBase.hpp"
#include "GTimeReference.hpp"
/***********************************************************************//**
* @class GTime
*
* @brief Handles times in a system independent way
*
* The GTime class stores a time value in seconds in a GammaLib native time
* reference system. The GammaLib native time reference (i.e. time=0) is
* defined as
*
* January 1, 2010, 00:00:00 (TT)
*
* The time system is Terrestrial Time (TT). With respect to Coordinated
* Universal Time (UTC), TT time is greater than UTC time by 66.184 sec at
* January 1, 2010, 00:00:00. The difference is due to the introduction of
* leap seconds that synchronize TT with the Earth rotation (UTC).
***************************************************************************/
class GTime : public GBase {
// Operator friends
friend GTime operator+(const GTime &a, const GTime &b);
friend GTime operator-(const GTime &a, const GTime &b);
friend GTime operator*(const double &s, const GTime &time);
friend GTime operator* (const GTime &time, const double &s);
friend GTime operator/(const GTime &time, const double &s);
friend bool operator==(const GTime &a, const GTime &b);
friend bool operator!=(const GTime &a, const GTime &b);
friend bool operator<(const GTime &a, const GTime &b);
friend bool operator<=(const GTime &a, const GTime &b);
friend bool operator>(const GTime &a, const GTime &b);
friend bool operator>=(const GTime &a, const GTime &b);
public:
// Constructors and destructors
GTime(void);
GTime(const GTime& time);
explicit GTime(const double& time, const std::string& unit = "sec");
explicit GTime(const double& time, const GTimeReference& ref);
virtual ~GTime(void);
// Operators
GTime& operator=(const GTime& time);
// Methods
void clear(void);
GTime* clone(void) const;
double jd(void) const;
double mjd(void) const;
const double& secs(void) const;
double days(void) const;
double convert(const GTimeReference& ref) const;
void jd(const double& time);
void mjd(const double& time);
void secs(const double& seconds);
void days(const double& days);
void set(const double& time, const GTimeReference& ref);
GTimeReference reference(void) const;
std::string print(const GChatter& chatter = NORMAL) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GTime& time);
void free_members(void);
// Protected data members
double m_time; //!< Time in seconds in native reference
};
/***********************************************************************//**
* @brief Return time in native reference (TT) (unit: seconds)
*
* @return Time in native reference [seconds].
***************************************************************************/
inline
const double& GTime::secs(void) const
{
return m_time;
}
/***********************************************************************//**
* @brief Set time in native reference in seconds (TT)
*
* @param[in] seconds Time (TT) [seconds].
***************************************************************************/
inline
void GTime::secs(const double& seconds)
{
m_time = seconds;
return;
}
/***********************************************************************//**
* @brief Time addition operator friend
*
* @param[in] a First time.
* @param[in] b Second time.
* @return Added time.
***************************************************************************/
inline
GTime operator+(const GTime& a, const GTime& b)
{
GTime result;
result.m_time = a.m_time + b.m_time;
return result;
}
/***********************************************************************//**
* @brief Time subtraction operator friend
*
* @param[in] a First time.
* @param[in] b Second time.
* @return Subtracted time.
***************************************************************************/
inline
GTime operator-(const GTime& a, const GTime& b)
{
GTime result;
result.m_time = a.m_time - b.m_time;
return result;
}
/***********************************************************************//**
* @brief Time multiplication operator friend
*
* @param[in] s Multiplier.
* @param[in] time Time.
* @return Multiplied time.
***************************************************************************/
inline
GTime operator*(const double& s, const GTime& time)
{
GTime result;
result.m_time = s * time.m_time;
return result;
}
/***********************************************************************//**
* @brief Time multiplication operator friend
*
* @param[in] time Time.
* @param[in] s Multiplier.
* @return Multiplied time.
***************************************************************************/
inline
GTime operator* (const GTime& time, const double& s)
{
GTime result;
result.m_time = s * time.m_time;
return result;
}
/***********************************************************************//**
* @brief Time division operator friend
*
* @param[in] time Time.
* @param[in] s Divider.
* @return Divided time.
***************************************************************************/
inline
GTime operator/(const GTime& time, const double& s)
{
GTime result;
result.m_time = time.m_time / s;
return result;
}
/***********************************************************************//**
* @brief Time equality operator friend
*
* @param[in] a First time.
* @param[in] b Second time.
* @return True if @p a equals @p b.
***************************************************************************/
inline
bool operator==(const GTime &a, const GTime &b)
{
return (a.m_time == b.m_time);
}
/***********************************************************************//**
* @brief Time non-equality operator friend
*
* @param[in] a First time.
* @param[in] b Second time.
* @return True if @p a is not equal to @p b.
***************************************************************************/
inline
bool operator!=(const GTime &a, const GTime &b)
{
return (a.m_time != b.m_time);
}
/***********************************************************************//**
* @brief Time smaller than operator friend
*
* @param[in] a First time.
* @param[in] b Second time.
* @return True if @p a is smaller than @p b.
***************************************************************************/
inline
bool operator<(const GTime &a, const GTime &b)
{
return (a.m_time < b.m_time);
}
/***********************************************************************//**
* @brief Time smaller than or equal operator friend
*
* @param[in] a First time.
* @param[in] b Second time.
* @return True if @p a is smaller than or equal to @p b.
***************************************************************************/
inline
bool operator<=(const GTime &a, const GTime &b)
{
return (a.m_time <= b.m_time);
}
/***********************************************************************//**
* @brief Time larger than operator friend
*
* @param[in] a First time.
* @param[in] b Second time.
* @return True if @p a is larger than @p b.
***************************************************************************/
inline
bool operator>(const GTime &a, const GTime &b)
{
return (a.m_time > b.m_time);
}
/***********************************************************************//**
* @brief Time larger than or equal operator friend
*
* @param[in] a First time.
* @param[in] b Second time.
* @return True if @p a is larger than or equal to @p b.
***************************************************************************/
inline
bool operator>=(const GTime &a, const GTime &b)
{
return (a.m_time >= b.m_time);
}
#endif /* GTIME_HPP */