AceTime  1.7.3
Date and time classes for Arduino that support timezones from the TZ Database, and a system clock that can synchronize from an NTP server or an RTC chip.
ZonedDateTime.h
1 /*
2  * MIT License
3  * Copyright (c) 2018 Brian T. Park
4  */
5 
6 #ifndef ACE_TIME_ZONED_DATE_TIME_H
7 #define ACE_TIME_ZONED_DATE_TIME_H
8 
9 #include <stdint.h>
10 #include "common/compat.h"
11 #include "OffsetDateTime.h"
12 #include "TimeZone.h"
13 
14 class Print;
15 
16 namespace ace_time {
17 
33  public:
51  static ZonedDateTime forComponents(int16_t year, uint8_t month, uint8_t day,
52  uint8_t hour, uint8_t minute, uint8_t second,
53  const TimeZone& timeZone) {
56  auto odt = timeZone.getOffsetDateTime(ldt);
57  return ZonedDateTime(odt, timeZone);
58  }
59 
71  static ZonedDateTime forEpochSeconds(acetime_t epochSeconds,
72  const TimeZone& timeZone) {
73  OffsetDateTime odt;
74  if (epochSeconds == LocalDate::kInvalidEpochSeconds) {
76  } else {
78  odt = OffsetDateTime::forEpochSeconds(epochSeconds, timeOffset);
79  }
80  return ZonedDateTime(odt, timeZone);
81  }
82 
92  static ZonedDateTime forUnixSeconds(acetime_t unixSeconds,
93  const TimeZone& timeZone) {
94  acetime_t epochSeconds = (unixSeconds == LocalDate::kInvalidEpochSeconds)
95  ? unixSeconds
96  : unixSeconds - LocalDate::kSecondsSinceUnixEpoch;
97  return forEpochSeconds(epochSeconds, timeZone);
98  }
99 
113  static ZonedDateTime forDateString(const char* dateString) {
116  }
117 
122  static ZonedDateTime forDateString(const __FlashStringHelper* dateString) {
125  }
126 
130  }
131 
133  explicit ZonedDateTime() {}
134 
136  bool isError() const { return mOffsetDateTime.isError(); }
137 
139  int16_t year() const { return mOffsetDateTime.year(); }
140 
142  void year(int16_t year) { mOffsetDateTime.year(year); }
143 
149  int8_t yearTiny() const { return mOffsetDateTime.yearTiny(); }
150 
156  void yearTiny(int8_t yearTiny) { mOffsetDateTime.yearTiny(yearTiny); }
157 
159  uint8_t month() const { return mOffsetDateTime.month(); }
160 
162  void month(uint8_t month) { mOffsetDateTime.month(month); }
163 
165  uint8_t day() const { return mOffsetDateTime.day(); }
166 
168  void day(uint8_t day) { mOffsetDateTime.day(day); }
169 
171  uint8_t hour() const { return mOffsetDateTime.hour(); }
172 
174  void hour(uint8_t hour) { mOffsetDateTime.hour(hour); }
175 
177  uint8_t minute() const { return mOffsetDateTime.minute(); }
178 
180  void minute(uint8_t minute) { mOffsetDateTime.minute(minute); }
181 
183  uint8_t second() const { return mOffsetDateTime.second(); }
184 
186  void second(uint8_t second) { mOffsetDateTime.second(second); }
187 
192  uint8_t dayOfWeek() const { return mOffsetDateTime.dayOfWeek(); }
193 
195  const TimeZone& timeZone() const { return mTimeZone; }
196 
201  void timeZone(const TimeZone& timeZone) { mTimeZone = timeZone; }
202 
204  TimeOffset timeOffset() const { return mOffsetDateTime.timeOffset(); }
205 
207  const LocalDateTime& localDateTime() const {
208  return mOffsetDateTime.localDateTime();
209  }
210 
227  void normalize() {
228  mOffsetDateTime = mTimeZone.getOffsetDateTime(localDateTime());
229  }
230 
236  acetime_t epochSeconds = toEpochSeconds();
237  return ZonedDateTime::forEpochSeconds(epochSeconds, timeZone);
238  }
239 
244  acetime_t toEpochDays() const {
245  return mOffsetDateTime.toEpochDays();
246  }
247 
249  acetime_t toUnixDays() const {
252  }
253 
262  acetime_t toEpochSeconds() const {
263  return mOffsetDateTime.toEpochSeconds();
264  }
265 
273  acetime_t toUnixSeconds() const {
274  return mOffsetDateTime.toUnixSeconds();
275  }
276 
293  int8_t compareTo(const ZonedDateTime& that) const {
294  return mOffsetDateTime.compareTo(that.mOffsetDateTime);
295  }
296 
302  void printTo(Print& printer) const;
303 
304  // Use default copy constructor and assignment operator.
305  ZonedDateTime(const ZonedDateTime&) = default;
306  ZonedDateTime& operator=(const ZonedDateTime&) = default;
307 
308  private:
310  static const uint8_t kDateStringLength = 25;
311 
312  friend bool operator==(const ZonedDateTime& a, const ZonedDateTime& b);
313 
315  ZonedDateTime(const OffsetDateTime& offsetDateTime, const TimeZone& tz):
316  mOffsetDateTime(offsetDateTime),
317  mTimeZone(tz) {}
318 
319  OffsetDateTime mOffsetDateTime;
320  TimeZone mTimeZone;
321 };
322 
330 inline bool operator==(const ZonedDateTime& a, const ZonedDateTime& b) {
331  return a.mOffsetDateTime == b.mOffsetDateTime
332  && a.mTimeZone == b.mTimeZone;
333 }
334 
336 inline bool operator!=(const ZonedDateTime& a, const ZonedDateTime& b) {
337  return ! (a == b);
338 }
339 
340 }
341 
342 #endif
ace_time::ZonedDateTime::second
uint8_t second() const
Return the second.
Definition: ZonedDateTime.h:183
ace_time::LocalDate::kSecondsSinceUnixEpoch
static const acetime_t kSecondsSinceUnixEpoch
Number of seconds from Unix epoch (1970-01-01 00:00:00Z) to the AceTime epoch (2000-01-01 00:00:00Z).
Definition: LocalDate.h:69
ace_time::OffsetDateTime::toUnixSeconds
acetime_t toUnixSeconds() const
Return the number of seconds from Unix epoch 1970-01-01 00:00:00Z.
Definition: OffsetDateTime.h:275
ace_time::OffsetDateTime::forDateString
static OffsetDateTime forDateString(const char *dateString)
Factory method.
Definition: OffsetDateTime.cpp:24
ace_time::LocalDate::kInvalidEpochSeconds
static const acetime_t kInvalidEpochSeconds
Sentinel epochSeconds which indicates an error.
Definition: LocalDate.h:63
ace_time::LocalDateTime
Class that holds the date-time as the components (year, month, day, hour, minute, second) without reg...
Definition: LocalDateTime.h:30
ace_time::ZonedDateTime::operator==
friend bool operator==(const ZonedDateTime &a, const ZonedDateTime &b)
Return true if two ZonedDateTime objects are equal in all components.
Definition: ZonedDateTime.h:330
ace_time::LocalDate::kInvalidEpochDays
static const acetime_t kInvalidEpochDays
Sentinel epochDays which indicates an error.
Definition: LocalDate.h:60
ace_time::OffsetDateTime::toEpochSeconds
acetime_t toEpochSeconds() const
Return seconds since AceTime epoch (2000-01-01 00:00:00Z), taking into account the offset zone.
Definition: OffsetDateTime.h:263
ace_time::OffsetDateTime::month
uint8_t month() const
Return the month with January=1, December=12.
Definition: OffsetDateTime.h:180
ace_time::TimeOffset
A thin wrapper that represents a time offset from a reference point, usually 00:00 at UTC,...
Definition: TimeOffset.h:56
ace_time::ZonedDateTime::timeZone
void timeZone(const TimeZone &timeZone)
Set the time zone.
Definition: ZonedDateTime.h:201
ace_time::ZonedDateTime::localDateTime
const LocalDateTime & localDateTime() const
Return the LocalDateTime of the components.
Definition: ZonedDateTime.h:207
ace_time::OffsetDateTime::forEpochSeconds
static OffsetDateTime forEpochSeconds(acetime_t epochSeconds, TimeOffset timeOffset)
Factory method.
Definition: OffsetDateTime.h:71
ace_time::OffsetDateTime::yearTiny
int8_t yearTiny() const
Return the single-byte year offset from year 2000.
Definition: OffsetDateTime.h:170
ace_time::ZonedDateTime::hour
uint8_t hour() const
Return the hour.
Definition: ZonedDateTime.h:171
ace_time::TimeZone::getUtcOffset
TimeOffset getUtcOffset(acetime_t epochSeconds) const
Return the total UTC offset at epochSeconds, including DST offset.
Definition: TimeZone.h:268
ace_time::ZonedDateTime::forEpochSeconds
static ZonedDateTime forEpochSeconds(acetime_t epochSeconds, const TimeZone &timeZone)
Factory method.
Definition: ZonedDateTime.h:71
ace_time::ZonedDateTime::compareTo
int8_t compareTo(const ZonedDateTime &that) const
Compare 'this' ZonedDateTime with 'that' ZonedDateTime, and return (<0, 0, >0) according to whether t...
Definition: ZonedDateTime.h:293
ace_time::ZonedDateTime::minute
void minute(uint8_t minute)
Set the minute.
Definition: ZonedDateTime.h:180
ace_time::OffsetDateTime::dayOfWeek
uint8_t dayOfWeek() const
Return the day of the week, Monday=1, Sunday=7 (per ISO 8601).
Definition: OffsetDateTime.h:210
ace_time::ZonedDateTime::toUnixSeconds
acetime_t toUnixSeconds() const
Return the number of seconds from Unix epoch 1970-01-01 00:00:00Z.
Definition: ZonedDateTime.h:273
ace_time::TimeZone::getOffsetDateTime
OffsetDateTime getOffsetDateTime(const LocalDateTime &ldt) const
Return the best estimate of the OffsetDateTime at the given LocalDateTime for the current TimeZone.
Definition: TimeZone.h:344
ace_time::LocalDateTime::forComponents
static LocalDateTime forComponents(int16_t year, uint8_t month, uint8_t day, uint8_t hour, uint8_t minute, uint8_t second)
Factory method using separated date and time components.
Definition: LocalDateTime.h:43
ace_time::OffsetDateTime
The date (year, month, day), time (hour, minute, second) and offset from UTC (timeOffset).
Definition: OffsetDateTime.h:33
compat.h
ace_time::ZonedDateTime::timeZone
const TimeZone & timeZone() const
Return the time zone of the ZonedDateTime.
Definition: ZonedDateTime.h:195
ace_time::ZonedDateTime::second
void second(uint8_t second)
Set the second.
Definition: ZonedDateTime.h:186
ace_time::OffsetDateTime::forError
static OffsetDateTime forError()
Factory method that returns an instance whose isError() is true.
Definition: OffsetDateTime.h:146
ace_time::ZonedDateTime::year
int16_t year() const
Return the year.
Definition: ZonedDateTime.h:139
ace_time::OffsetDateTime::second
uint8_t second() const
Return the second.
Definition: OffsetDateTime.h:204
ace_time::ZonedDateTime::forDateString
static ZonedDateTime forDateString(const char *dateString)
Factory method.
Definition: ZonedDateTime.h:113
ace_time::ZonedDateTime::forUnixSeconds
static ZonedDateTime forUnixSeconds(acetime_t unixSeconds, const TimeZone &timeZone)
Factory method to create a ZonedDateTime using the number of seconds from Unix epoch.
Definition: ZonedDateTime.h:92
ace_time::ZonedDateTime::printTo
void printTo(Print &printer) const
Print ZonedDateTime to 'printer'.
Definition: ZonedDateTime.cpp:12
ace_time::OffsetDateTime::compareTo
int8_t compareTo(const OffsetDateTime &that) const
Compare 'this' OffsetDateTime with 'that' OffsetDateTime, and return (<0, 0, >0) according to whether...
Definition: OffsetDateTime.h:296
ace_time::ZonedDateTime::forComponents
static ZonedDateTime forComponents(int16_t year, uint8_t month, uint8_t day, uint8_t hour, uint8_t minute, uint8_t second, const TimeZone &timeZone)
Factory method using separated date, time, and time zone fields.
Definition: ZonedDateTime.h:51
ace_time::ZonedDateTime::month
uint8_t month() const
Return the month with January=1, December=12.
Definition: ZonedDateTime.h:159
ace_time::ZonedDateTime::isError
bool isError() const
Return true if any component indicates an error condition.
Definition: ZonedDateTime.h:136
ace_time::ZonedDateTime::minute
uint8_t minute() const
Return the minute.
Definition: ZonedDateTime.h:177
ace_time::ZonedDateTime::toEpochSeconds
acetime_t toEpochSeconds() const
Return seconds since AceTime epoch (2000-01-01 00:00:00Z), taking into account the time zone.
Definition: ZonedDateTime.h:262
ace_time::OffsetDateTime::timeOffset
TimeOffset timeOffset() const
Return the offset zone of the OffsetDateTime.
Definition: OffsetDateTime.h:213
ace_time::ZonedDateTime
The date (year, month, day), time (hour, minute, second), and a timeZone representing an instant in t...
Definition: ZonedDateTime.h:32
ace_time::OffsetDateTime::day
uint8_t day() const
Return the day of the month.
Definition: OffsetDateTime.h:186
ace_time::ZonedDateTime::timeOffset
TimeOffset timeOffset() const
Return the offset zone of the OffsetDateTime.
Definition: ZonedDateTime.h:204
ace_time::OffsetDateTime::minute
uint8_t minute() const
Return the minute.
Definition: OffsetDateTime.h:198
ace_time::ZonedDateTime::forError
static ZonedDateTime forError()
Return an instance whose isError() returns true.
Definition: ZonedDateTime.h:128
ace_time::ZonedDateTime::toUnixDays
acetime_t toUnixDays() const
Return the number of days since Unix epoch (1970-01-01 00:00:00).
Definition: ZonedDateTime.h:249
ace_time::ZonedDateTime::day
void day(uint8_t day)
Set the day of the month.
Definition: ZonedDateTime.h:168
ace_time::ZonedDateTime::month
void month(uint8_t month)
Set the month.
Definition: ZonedDateTime.h:162
ace_time::ZonedDateTime::yearTiny
void yearTiny(int8_t yearTiny)
Set the single-byte year offset from year 2000.
Definition: ZonedDateTime.h:156
ace_time::OffsetDateTime::isError
bool isError() const
Return true if any component indicates an error condition.
Definition: OffsetDateTime.h:154
ace_time::OffsetDateTime::hour
uint8_t hour() const
Return the hour.
Definition: OffsetDateTime.h:192
ace_time::TimeZone
Class that describes a time zone.
Definition: TimeZone.h:85
ace_time::ZonedDateTime::toEpochDays
acetime_t toEpochDays() const
Return number of whole days since AceTime epoch (2000-01-01 00:00:00Z), taking into account the time ...
Definition: ZonedDateTime.h:244
ace_time::ZonedDateTime::convertToTimeZone
ZonedDateTime convertToTimeZone(const TimeZone &timeZone) const
Create a ZonedDateTime in a different time zone (with the same epochSeconds).
Definition: ZonedDateTime.h:235
ace_time::TimeZone::forTimeOffset
static TimeZone forTimeOffset(TimeOffset stdOffset, TimeOffset dstOffset=TimeOffset())
Factory method to create from a UTC offset and an optional DST offset.
Definition: TimeZone.h:114
ace_time::ZonedDateTime::dayOfWeek
uint8_t dayOfWeek() const
Return the day of the week using ISO 8601 numbering where Monday=1 and Sunday=7.
Definition: ZonedDateTime.h:192
ace_time::LocalDate::kDaysSinceUnixEpoch
static const acetime_t kDaysSinceUnixEpoch
Number of days from Unix epoch (1970-01-01 00:00:00Z) to the AceTime epoch (2000-01-01 00:00:00Z).
Definition: LocalDate.h:75
ace_time::OffsetDateTime::localDateTime
const LocalDateTime & localDateTime() const
Return the LocalDateTime.
Definition: OffsetDateTime.h:219
ace_time::ZonedDateTime::normalize
void normalize()
Normalize the ZonedDateTime after mutation.
Definition: ZonedDateTime.h:227
ace_time::ZonedDateTime::day
uint8_t day() const
Return the day of the month.
Definition: ZonedDateTime.h:165
ace_time::ZonedDateTime::hour
void hour(uint8_t hour)
Set the hour.
Definition: ZonedDateTime.h:174
ace_time::ZonedDateTime::year
void year(int16_t year)
Set the year given the full year.
Definition: ZonedDateTime.h:142
ace_time::ZonedDateTime::ZonedDateTime
ZonedDateTime()
Default constructor.
Definition: ZonedDateTime.h:133
ace_time::OffsetDateTime::year
int16_t year() const
Return the year.
Definition: OffsetDateTime.h:160
ace_time::OffsetDateTime::toEpochDays
acetime_t toEpochDays() const
Return number of whole days since AceTime epoch (2000-01-01 00:00:00Z), taking into account the offse...
Definition: OffsetDateTime.h:240
ace_time::ZonedDateTime::forDateString
static ZonedDateTime forDateString(const __FlashStringHelper *dateString)
Factory method.
Definition: ZonedDateTime.h:122
ace_time::ZonedDateTime::yearTiny
int8_t yearTiny() const
Return the single-byte year offset from year 2000.
Definition: ZonedDateTime.h:149