/src/poco/Foundation/include/Poco/LocalDateTime.h

Source (jump to first uncovered line)
//
// LocalDateTime.h
//
// Library: Foundation
// Package: DateTime
// Module:  LocalDateTime
//
// Definition of the LocalDateTime class.
//
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
// and Contributors.
//
// SPDX-License-Identifier: BSL-1.0
//


#ifndef Foundation_LocalDateTime_INCLUDED
#define Foundation_LocalDateTime_INCLUDED


#include "Poco/Foundation.h"
#include "Poco/DateTime.h"


namespace Poco {


class Foundation_API LocalDateTime
  /// This class represents an instant in local time
  /// (as opposed to UTC), expressed in years, months, days,
  /// hours, minutes, seconds and milliseconds based on the
  /// Gregorian calendar.
  ///
  /// In addition to the date and time, the class also
  /// maintains a time zone differential, which denotes
  /// the difference in seconds from UTC to local time,
  /// i.e. UTC = local time - time zone differential.
  ///
  /// Although LocalDateTime supports relational and arithmetic
  /// operators, all date/time comparisons and date/time arithmetic
  /// should be done in UTC, using the DateTime or Timestamp
  /// class for better performance. The relational operators
  /// normalize the dates/times involved to UTC before carrying out
  /// the comparison.
  ///
  /// The time zone differential is based on the input date and
  /// time and current time zone. A number of constructors accept
  /// an explicit time zone differential parameter. These should
  /// not be used since daylight savings time processing is impossible
  /// since the time zone is unknown. Each of the constructors
  /// accepting a tzd parameter have been marked as deprecated and
  /// may be removed in a future revision.
{
public:
  LocalDateTime();
    /// Creates a LocalDateTime with the current date/time
    /// for the current time zone.

  LocalDateTime(int year, int month, int day, int hour = 0, int minute = 0, int second = 0, int millisecond = 0, int microsecond = 0);
    /// Creates a LocalDateTime for the given Gregorian local date and time.
    ///   * year is from 0 to 9999.
    ///   * month is from 1 to 12.
    ///   * day is from 1 to 31.
    ///   * hour is from 0 to 23.
    ///   * minute is from 0 to 59.
    ///   * second is from 0 to 60 (allowing leap seconds).
    ///   * millisecond is from 0 to 999.
    ///   * microsecond is from 0 to 999.

  //@ deprecated
  LocalDateTime(int tzd, int year, int month, int day, int hour, int minute, int second, int millisecond, int microsecond);
    /// Creates a LocalDateTime for the given Gregorian date and time in the
    /// time zone denoted by the time zone differential in tzd.
    ///   * tzd is in seconds.
    ///   * year is from 0 to 9999.
    ///   * month is from 1 to 12.
    ///   * day is from 1 to 31.
    ///   * hour is from 0 to 23.
    ///   * minute is from 0 to 59.
    ///   * second is from 0 to 60 (allowing leap seconds).
    ///   * millisecond is from 0 to 999.
    ///   * microsecond is from 0 to 999.

  LocalDateTime(const DateTime& dateTime);
    /// Creates a LocalDateTime from the UTC time given in dateTime,
    /// using the time zone differential of the current time zone.

  //@ deprecated
  LocalDateTime(int tzd, const DateTime& dateTime);
    /// Creates a LocalDateTime from the UTC time given in dateTime,
    /// using the given time zone differential. Adjusts dateTime
    /// for the given time zone differential.

  //@ deprecated
  LocalDateTime(int tzd, const DateTime& dateTime, bool adjust);
    /// Creates a LocalDateTime from the UTC time given in dateTime,
    /// using the given time zone differential. If adjust is true,
    /// adjusts dateTime for the given time zone differential.

  LocalDateTime(double julianDay);
    /// Creates a LocalDateTime for the given Julian day in the local time zone.

  //@ deprecated
  LocalDateTime(int tzd, double julianDay);
    /// Creates a LocalDateTime for the given Julian day in the time zone
    /// denoted by the time zone differential in tzd.

  LocalDateTime(const LocalDateTime& dateTime);
    /// Copy constructor. Creates the LocalDateTime from another one.

  ~LocalDateTime();
    /// Destroys the LocalDateTime.

  LocalDateTime& operator = (const LocalDateTime& dateTime);
    /// Assigns another LocalDateTime.

  LocalDateTime& operator = (const Timestamp& timestamp);
    /// Assigns a timestamp

  LocalDateTime& operator = (double julianDay);
    /// Assigns a Julian day in the local time zone.

  LocalDateTime& assign(int year, int month, int day, int hour = 0, int minute = 0, int second = 0, int millisecond = 0, int microseconds = 0);
    /// Assigns a Gregorian local date and time.
    ///   * year is from 0 to 9999.
    ///   * month is from 1 to 12.
    ///   * day is from 1 to 31.
    ///   * hour is from 0 to 23.
    ///   * minute is from 0 to 59.
    ///   * second is from 0 to 60 (allowing leap seconds).
    ///   * millisecond is from 0 to 999.
    ///   * microsecond is from 0 to 999.

  //@ deprecated
  LocalDateTime& assign(int tzd, int year, int month, int day, int hour, int minute, int second, int millisecond, int microseconds);
    /// Assigns a Gregorian local date and time in the time zone denoted by
    /// the time zone differential in tzd.
    ///   * tzd is in seconds.
    ///   * year is from 0 to 9999.
    ///   * month is from 1 to 12.
    ///   * day is from 1 to 31.
    ///   * hour is from 0 to 23.
    ///   * minute is from 0 to 59.
    ///   * second is from 0 to 60 (allowing leap seconds).
    ///   * millisecond is from 0 to 999.
    ///   * microsecond is from 0 to 999.

  //@ deprecated
  LocalDateTime& assign(int tzd, double julianDay);
    /// Assigns a Julian day in the time zone denoted by the
    /// time zone differential in tzd.

  void swap(LocalDateTime& dateTime);
    /// Swaps the LocalDateTime with another one.

  int year() const;
    /// Returns the year.

  int month() const;
    /// Returns the month (1 to 12).

  int week(int firstDayOfWeek = DateTime::MONDAY) const;
    /// Returns the week number within the year.
    /// FirstDayOfWeek should be either SUNDAY (0) or MONDAY (1).
    /// The returned week number will be from 0 to 53. Week number 1 is the week
    /// containing January 4. This is in accordance to ISO 8601.
    ///
    /// The following example assumes that firstDayOfWeek is MONDAY. For 2005, which started
    /// on a Saturday, week 1 will be the week starting on Monday, January 3.
    /// January 1 and 2 will fall within week 0 (or the last week of the previous year).
    ///
    /// For 2007, which starts on a Monday, week 1 will be the week starting on Monday, January 1.
    /// There will be no week 0 in 2007.

  int day() const;
    /// Returns the day within the month (1 to 31).

  int dayOfWeek() const;
    /// Returns the weekday (0 to 6, where
    /// 0 = Sunday, 1 = Monday, ..., 6 = Saturday).

  int dayOfYear() const;
    /// Returns the number of the day in the year.
    /// January 1 is 1, February 1 is 32, etc.

  int hour() const;
    /// Returns the hour (0 to 23).

  int hourAMPM() const;
    /// Returns the hour (0 to 12).

  bool isAM() const;
    /// Returns true if hour < 12;

  bool isPM() const;
    /// Returns true if hour >= 12.

  int minute() const;
    /// Returns the minute (0 to 59).

  int second() const;
    /// Returns the second (0 to 59).

  int millisecond() const;
    /// Returns the millisecond (0 to 999)

  int microsecond() const;
    /// Returns the microsecond (0 to 999)

  double julianDay() const;
    /// Returns the Julian day for the date.

  int tzd() const;
    /// Returns the time zone differential.

  DateTime utc() const;
    /// Returns the UTC equivalent for the local date and time.

  Timestamp timestamp() const;
    /// Returns the date and time expressed as a Timestamp.

  Timestamp::UtcTimeVal utcTime() const;
    /// Returns the UTC equivalent for the local date and time.

  bool operator == (const LocalDateTime& dateTime) const;
  bool operator != (const LocalDateTime& dateTime) const;
  bool operator <  (const LocalDateTime& dateTime) const;
  bool operator <= (const LocalDateTime& dateTime) const;
  bool operator >  (const LocalDateTime& dateTime) const;
  bool operator >= (const LocalDateTime& dateTime) const;

  LocalDateTime  operator +  (const Timespan& span) const;
  LocalDateTime  operator -  (const Timespan& span) const;
  Timespan       operator -  (const LocalDateTime& dateTime) const;
  LocalDateTime& operator += (const Timespan& span);
  LocalDateTime& operator -= (const Timespan& span);

protected:
  LocalDateTime(Timestamp::UtcTimeVal utcTime, Timestamp::TimeDiff diff, int tzd);

  void determineTzd(bool adjust = false);
    /// Recalculate the tzd based on the _dateTime member based
    /// on the current timezone using the Standard C runtime functions.
    /// If adjust is true, then adjustForTzd() is called after the
    /// differential is calculated.

  void adjustForTzd();
    /// Adjust the _dateTime member based on the _tzd member.

  std::time_t dstOffset(int& dstOffset) const;
    /// Determine the DST offset for the current date/time.

private:
  DateTime _dateTime;
  int      _tzd;

  friend class DateTimeFormatter;
  friend class DateTimeParser;
};


//
// inlines
//
inline int LocalDateTime::year() const
{
  return _dateTime.year();
}


inline int LocalDateTime::month() const
{
  return _dateTime.month();
}


inline int LocalDateTime::week(int firstDayOfWeek) const
{
  return _dateTime.week(firstDayOfWeek);
}


inline int LocalDateTime::day() const
{
  return _dateTime.day();
}


inline int LocalDateTime::dayOfWeek() const
{
  return _dateTime.dayOfWeek();
}


inline int LocalDateTime::dayOfYear() const
{
  return _dateTime.dayOfYear();
}


inline int LocalDateTime::hour() const
{
  return _dateTime.hour();
}


inline int LocalDateTime::hourAMPM() const
{
  return _dateTime.hourAMPM();
}


inline bool LocalDateTime::isAM() const
{
  return _dateTime.isAM();
}


inline bool LocalDateTime::isPM() const
{
  return _dateTime.isPM();
}


inline int LocalDateTime::minute() const
{
  return _dateTime.minute();
}


inline int LocalDateTime::second() const
{
  return _dateTime.second();
}


inline int LocalDateTime::millisecond() const
{
  return _dateTime.millisecond();
}


inline int LocalDateTime::microsecond() const
{
  return _dateTime.microsecond();
}


inline double LocalDateTime::julianDay() const
{
  return _dateTime.julianDay();
}


inline int LocalDateTime::tzd() const
{
  return _tzd;
}


inline Timestamp LocalDateTime::timestamp() const
{
  return Timestamp::fromUtcTime(_dateTime.utcTime());
}


inline Timestamp::UtcTimeVal LocalDateTime::utcTime() const
{
  return _dateTime.utcTime() - ((Timestamp::TimeDiff) _tzd)*10000000;
}


inline void LocalDateTime::adjustForTzd()
{
  _dateTime += Timespan(((Timestamp::TimeDiff) _tzd)*Timespan::SECONDS);
}


inline void swap(LocalDateTime& d1, LocalDateTime& d2) noexcept
{
  d1.swap(d2);
}


} // namespace Poco


#endif // Foundation_LocalDateTime_INCLUDED

Coverage Report

Created: 2023-10-14 06:19

Line	Count	Source (jump to first uncovered line)
1		//
2		// LocalDateTime.h
3		//
4		// Library: Foundation
5		// Package: DateTime
6		// Module: LocalDateTime
7		//
8		// Definition of the LocalDateTime class.
9		//
10		// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
11		// and Contributors.
12		//
13		// SPDX-License-Identifier: BSL-1.0
14		//
15
16
17		#ifndef Foundation_LocalDateTime_INCLUDED
18		#define Foundation_LocalDateTime_INCLUDED
19
20
21		#include "Poco/Foundation.h"
22		#include "Poco/DateTime.h"
23
24
25		namespace Poco {
26
27
28		class Foundation_API LocalDateTime
29		/// This class represents an instant in local time
30		/// (as opposed to UTC), expressed in years, months, days,
31		/// hours, minutes, seconds and milliseconds based on the
32		/// Gregorian calendar.
33		///
34		/// In addition to the date and time, the class also
35		/// maintains a time zone differential, which denotes
36		/// the difference in seconds from UTC to local time,
37		/// i.e. UTC = local time - time zone differential.
38		///
39		/// Although LocalDateTime supports relational and arithmetic
40		/// operators, all date/time comparisons and date/time arithmetic
41		/// should be done in UTC, using the DateTime or Timestamp
42		/// class for better performance. The relational operators
43		/// normalize the dates/times involved to UTC before carrying out
44		/// the comparison.
45		///
46		/// The time zone differential is based on the input date and
47		/// time and current time zone. A number of constructors accept
48		/// an explicit time zone differential parameter. These should
49		/// not be used since daylight savings time processing is impossible
50		/// since the time zone is unknown. Each of the constructors
51		/// accepting a tzd parameter have been marked as deprecated and
52		/// may be removed in a future revision.
53		{
54		public:
55		LocalDateTime();
56		/// Creates a LocalDateTime with the current date/time
57		/// for the current time zone.
58
59		LocalDateTime(int year, int month, int day, int hour = 0, int minute = 0, int second = 0, int millisecond = 0, int microsecond = 0);
60		/// Creates a LocalDateTime for the given Gregorian local date and time.
61		/// * year is from 0 to 9999.
62		/// * month is from 1 to 12.
63		/// * day is from 1 to 31.
64		/// * hour is from 0 to 23.
65		/// * minute is from 0 to 59.
66		/// * second is from 0 to 60 (allowing leap seconds).
67		/// * millisecond is from 0 to 999.
68		/// * microsecond is from 0 to 999.
69
70		//@ deprecated
71		LocalDateTime(int tzd, int year, int month, int day, int hour, int minute, int second, int millisecond, int microsecond);
72		/// Creates a LocalDateTime for the given Gregorian date and time in the
73		/// time zone denoted by the time zone differential in tzd.
74		/// * tzd is in seconds.
75		/// * year is from 0 to 9999.
76		/// * month is from 1 to 12.
77		/// * day is from 1 to 31.
78		/// * hour is from 0 to 23.
79		/// * minute is from 0 to 59.
80		/// * second is from 0 to 60 (allowing leap seconds).
81		/// * millisecond is from 0 to 999.
82		/// * microsecond is from 0 to 999.
83
84		LocalDateTime(const DateTime& dateTime);
85		/// Creates a LocalDateTime from the UTC time given in dateTime,
86		/// using the time zone differential of the current time zone.
87
88		//@ deprecated
89		LocalDateTime(int tzd, const DateTime& dateTime);
90		/// Creates a LocalDateTime from the UTC time given in dateTime,
91		/// using the given time zone differential. Adjusts dateTime
92		/// for the given time zone differential.
93
94		//@ deprecated
95		LocalDateTime(int tzd, const DateTime& dateTime, bool adjust);
96		/// Creates a LocalDateTime from the UTC time given in dateTime,
97		/// using the given time zone differential. If adjust is true,
98		/// adjusts dateTime for the given time zone differential.
99
100		LocalDateTime(double julianDay);
101		/// Creates a LocalDateTime for the given Julian day in the local time zone.
102
103		//@ deprecated
104		LocalDateTime(int tzd, double julianDay);
105		/// Creates a LocalDateTime for the given Julian day in the time zone
106		/// denoted by the time zone differential in tzd.
107
108		LocalDateTime(const LocalDateTime& dateTime);
109		/// Copy constructor. Creates the LocalDateTime from another one.
110
111		~LocalDateTime();
112		/// Destroys the LocalDateTime.
113
114		LocalDateTime& operator = (const LocalDateTime& dateTime);
115		/// Assigns another LocalDateTime.
116
117		LocalDateTime& operator = (const Timestamp& timestamp);
118		/// Assigns a timestamp
119
120		LocalDateTime& operator = (double julianDay);
121		/// Assigns a Julian day in the local time zone.
122
123		LocalDateTime& assign(int year, int month, int day, int hour = 0, int minute = 0, int second = 0, int millisecond = 0, int microseconds = 0);
124		/// Assigns a Gregorian local date and time.
125		/// * year is from 0 to 9999.
126		/// * month is from 1 to 12.
127		/// * day is from 1 to 31.
128		/// * hour is from 0 to 23.
129		/// * minute is from 0 to 59.
130		/// * second is from 0 to 60 (allowing leap seconds).
131		/// * millisecond is from 0 to 999.
132		/// * microsecond is from 0 to 999.
133
134		//@ deprecated
135		LocalDateTime& assign(int tzd, int year, int month, int day, int hour, int minute, int second, int millisecond, int microseconds);
136		/// Assigns a Gregorian local date and time in the time zone denoted by
137		/// the time zone differential in tzd.
138		/// * tzd is in seconds.
139		/// * year is from 0 to 9999.
140		/// * month is from 1 to 12.
141		/// * day is from 1 to 31.
142		/// * hour is from 0 to 23.
143		/// * minute is from 0 to 59.
144		/// * second is from 0 to 60 (allowing leap seconds).
145		/// * millisecond is from 0 to 999.
146		/// * microsecond is from 0 to 999.
147
148		//@ deprecated
149		LocalDateTime& assign(int tzd, double julianDay);
150		/// Assigns a Julian day in the time zone denoted by the
151		/// time zone differential in tzd.
152
153		void swap(LocalDateTime& dateTime);
154		/// Swaps the LocalDateTime with another one.
155
156		int year() const;
157		/// Returns the year.
158
159		int month() const;
160		/// Returns the month (1 to 12).
161
162		int week(int firstDayOfWeek = DateTime::MONDAY) const;
163		/// Returns the week number within the year.
164		/// FirstDayOfWeek should be either SUNDAY (0) or MONDAY (1).
165		/// The returned week number will be from 0 to 53. Week number 1 is the week
166		/// containing January 4. This is in accordance to ISO 8601.
167		///
168		/// The following example assumes that firstDayOfWeek is MONDAY. For 2005, which started
169		/// on a Saturday, week 1 will be the week starting on Monday, January 3.
170		/// January 1 and 2 will fall within week 0 (or the last week of the previous year).
171		///
172		/// For 2007, which starts on a Monday, week 1 will be the week starting on Monday, January 1.
173		/// There will be no week 0 in 2007.
174
175		int day() const;
176		/// Returns the day within the month (1 to 31).
177
178		int dayOfWeek() const;
179		/// Returns the weekday (0 to 6, where
180		/// 0 = Sunday, 1 = Monday, ..., 6 = Saturday).
181
182		int dayOfYear() const;
183		/// Returns the number of the day in the year.
184		/// January 1 is 1, February 1 is 32, etc.
185
186		int hour() const;
187		/// Returns the hour (0 to 23).
188
189		int hourAMPM() const;
190		/// Returns the hour (0 to 12).
191
192		bool isAM() const;
193		/// Returns true if hour < 12;
194
195		bool isPM() const;
196		/// Returns true if hour >= 12.
197
198		int minute() const;
199		/// Returns the minute (0 to 59).
200
201		int second() const;
202		/// Returns the second (0 to 59).
203
204		int millisecond() const;
205		/// Returns the millisecond (0 to 999)
206
207		int microsecond() const;
208		/// Returns the microsecond (0 to 999)
209
210		double julianDay() const;
211		/// Returns the Julian day for the date.
212
213		int tzd() const;
214		/// Returns the time zone differential.
215
216		DateTime utc() const;
217		/// Returns the UTC equivalent for the local date and time.
218
219		Timestamp timestamp() const;
220		/// Returns the date and time expressed as a Timestamp.
221
222		Timestamp::UtcTimeVal utcTime() const;
223		/// Returns the UTC equivalent for the local date and time.
224
225		bool operator == (const LocalDateTime& dateTime) const;
226		bool operator != (const LocalDateTime& dateTime) const;
227		bool operator < (const LocalDateTime& dateTime) const;
228		bool operator <= (const LocalDateTime& dateTime) const;
229		bool operator > (const LocalDateTime& dateTime) const;
230		bool operator >= (const LocalDateTime& dateTime) const;
231
232		LocalDateTime operator + (const Timespan& span) const;
233		LocalDateTime operator - (const Timespan& span) const;
234		Timespan operator - (const LocalDateTime& dateTime) const;
235		LocalDateTime& operator += (const Timespan& span);
236		LocalDateTime& operator -= (const Timespan& span);
237
238		protected:
239		LocalDateTime(Timestamp::UtcTimeVal utcTime, Timestamp::TimeDiff diff, int tzd);
240
241		void determineTzd(bool adjust = false);
242		/// Recalculate the tzd based on the _dateTime member based
243		/// on the current timezone using the Standard C runtime functions.
244		/// If adjust is true, then adjustForTzd() is called after the
245		/// differential is calculated.
246
247		void adjustForTzd();
248		/// Adjust the _dateTime member based on the _tzd member.
249
250		std::time_t dstOffset(int& dstOffset) const;
251		/// Determine the DST offset for the current date/time.
252
253		private:
254		DateTime _dateTime;
255		int _tzd;
256
257		friend class DateTimeFormatter;
258		friend class DateTimeParser;
259		};
260
261
262		//
263		// inlines
264		//
265		inline int LocalDateTime::year() const
266	0	{
267	0	return _dateTime.year();
268	0	}
269
270
271		inline int LocalDateTime::month() const
272	0	{
273	0	return _dateTime.month();
274	0	}
275
276
277		inline int LocalDateTime::week(int firstDayOfWeek) const
278	0	{
279	0	return _dateTime.week(firstDayOfWeek);
280	0	}
281
282
283		inline int LocalDateTime::day() const
284	0	{
285	0	return _dateTime.day();
286	0	}
287
288
289		inline int LocalDateTime::dayOfWeek() const
290	0	{
291	0	return _dateTime.dayOfWeek();
292	0	}
293
294
295		inline int LocalDateTime::dayOfYear() const
296	0	{
297	0	return _dateTime.dayOfYear();
298	0	}
299
300
301		inline int LocalDateTime::hour() const
302	0	{
303	0	return _dateTime.hour();
304	0	}
305
306
307		inline int LocalDateTime::hourAMPM() const
308	0	{
309	0	return _dateTime.hourAMPM();
310	0	}
311
312
313		inline bool LocalDateTime::isAM() const
314	0	{
315	0	return _dateTime.isAM();
316	0	}
317
318
319		inline bool LocalDateTime::isPM() const
320	0	{
321	0	return _dateTime.isPM();
322	0	}
323
324
325		inline int LocalDateTime::minute() const
326	0	{
327	0	return _dateTime.minute();
328	0	}
329
330
331		inline int LocalDateTime::second() const
332	0	{
333	0	return _dateTime.second();
334	0	}
335
336
337		inline int LocalDateTime::millisecond() const
338	0	{
339	0	return _dateTime.millisecond();
340	0	}
341
342
343		inline int LocalDateTime::microsecond() const
344	0	{
345	0	return _dateTime.microsecond();
346	0	}
347
348
349		inline double LocalDateTime::julianDay() const
350	0	{
351	0	return _dateTime.julianDay();
352	0	}
353
354
355		inline int LocalDateTime::tzd() const
356	0	{
357	0	return _tzd;
358	0	}
359
360
361		inline Timestamp LocalDateTime::timestamp() const
362	0	{
363	0	return Timestamp::fromUtcTime(_dateTime.utcTime());
364	0	}
365
366
367		inline Timestamp::UtcTimeVal LocalDateTime::utcTime() const
368	0	{
369	0	return _dateTime.utcTime() - ((Timestamp::TimeDiff) _tzd)*10000000;
370	0	}
371
372
373		inline void LocalDateTime::adjustForTzd()
374	0	{
375	0	_dateTime += Timespan(((Timestamp::TimeDiff) _tzd)*Timespan::SECONDS);
376	0	}
377
378
379		inline void swap(LocalDateTime& d1, LocalDateTime& d2) noexcept
380	0	{
381	0	d1.swap(d2);
382	0	}
383
384
385		} // namespace Poco
386
387
388		#endif // Foundation_LocalDateTime_INCLUDED