AceTime
1.11.2
Date and time classes for Arduino that support timezones from the TZ Database.
|
Represents an interval of time where the time zone obeyed a certain UTC offset and DST delta. More...
#include <ExtendedZoneProcessor.h>
Public Member Functions | |
const char * | format () const |
const char * | letter () const |
Return the letter string. More... | |
void | log () const |
Used only for debugging. | |
Static Public Member Functions | |
static void | logHourMinute (int16_t minutes) |
Print minutes as [+/-]hh:mm. | |
Public Attributes | |
const MatchingEraTemplate< ZEB > * | match |
The match which generated this Transition. | |
ZRB | rule |
The Zone transition rule that matched for the the given year. More... | |
DateTuple | transitionTime |
The original transition time, usually 'w' but sometimes 's' or 'u'. More... | |
union { | |
DateTuple transitionTimeS | |
Version of transitionTime in 's' mode, using the UTC offset of the previous Transition. More... | |
DateTuple startDateTime | |
Start time expressed using the UTC offset of the current Transition. More... | |
}; | |
union { | |
DateTuple transitionTimeU | |
Version of transitionTime in 'u' mode, using the UTC offset of the previous transition. More... | |
DateTuple untilDateTime | |
Until time expressed using the UTC offset of the current Transition. More... | |
}; | |
acetime_t | startEpochSeconds |
The calculated transition time of the given rule. | |
int16_t | offsetMinutes |
The base offset minutes, not the total effective UTC offset. More... | |
int16_t | deltaMinutes |
The DST delta minutes. | |
char | abbrev [internal::kAbbrevSize] |
The calculated effective time zone abbreviation, e.g. More... | |
char | letterBuf [2] |
Storage for the single letter 'letter' field if 'rule' is not null. | |
union { | |
bool isValidPrior | |
During findCandidateTransitions(), this flag indicates whether the current transition is a valid "prior" transition that occurs before other transitions. More... | |
MatchStatus matchStatus | |
During processTransitionMatchStatus(), this flag indicates how the transition falls within the time interval of the MatchingEra. | |
}; | |
Represents an interval of time where the time zone obeyed a certain UTC offset and DST delta.
The start of the interval is given by 'transitionTime' which comes from the TZ Database file. The actual start and until time of the interval (in the local time zone) is given by 'startDateTime' and 'untilDateTime'.
There are 2 types of Transition instances: 1) Simple, indicated by 'rule' == nullptr. The base UTC offsetMinutes is given by match->offsetMinutes. The additional DST delta is given by match->deltaMinutes. 2) Named, indicated by 'rule' != nullptr. The base UTC offsetMinutes is given by match->offsetMinutes. The additional DST delta is given by rule->deltaMinutes.
Some of the instance variables (e.g. 'isValidPrior', 'matchStatus', 'transitionTime', 'transitionTimeS', 'transitionTimeU', 'letter()' and 'format()') are transient parameters which are in the implementation of the TransitionStorage::init() method.
Other variables (e.g. 'startDateTime', 'startEpochSeconds', 'offsetMinutes', 'deltaMinutes', 'abbrev', 'letterBuf') are essential parameters which are required to find a matching Transition and construct the corresponding ZonedDateTime.
Ordering of fields are optimized along 4-byte boundaries to help 32-bit processors without making the program size bigger for 8-bit processors.
ZEB | type of ZoneEraBroker |
ZPB | type of ZonePolicyBroker |
ZRB | type of ZoneRuleBroker |
Definition at line 271 of file ExtendedZoneProcessor.h.
|
inline |
Return the letter string.
Returns nullptr if the RULES column is empty since that means that the ZoneRule is not used, which means LETTER does not exist. A LETTER of '-' is returned as an empty string "".
Definition at line 377 of file ExtendedZoneProcessor.h.
char ace_time::extended::TransitionTemplate< ZEB, ZPB, ZRB >::abbrev[internal::kAbbrevSize] |
The calculated effective time zone abbreviation, e.g.
"PST" or "PDT".
Definition at line 345 of file ExtendedZoneProcessor.h.
bool ace_time::extended::TransitionTemplate< ZEB, ZPB, ZRB >::isValidPrior |
During findCandidateTransitions(), this flag indicates whether the current transition is a valid "prior" transition that occurs before other transitions.
It is set by setFreeAgentAsPriorIfValid() if the transition is a prior transition.
Definition at line 357 of file ExtendedZoneProcessor.h.
int16_t ace_time::extended::TransitionTemplate< ZEB, ZPB, ZRB >::offsetMinutes |
The base offset minutes, not the total effective UTC offset.
Note that this is different than basic::Transition::offsetMinutes used by BasicZoneProcessor which is the total effective offsetMinutes. (It may be possible to make this into an effective offsetMinutes (i.e. offsetMinutes
Definition at line 339 of file ExtendedZoneProcessor.h.
ZRB ace_time::extended::TransitionTemplate< ZEB, ZPB, ZRB >::rule |
The Zone transition rule that matched for the the given year.
Set to nullptr if the RULES column is '-', indicating that the MatchingEra was a "simple" ZoneEra.
Definition at line 281 of file ExtendedZoneProcessor.h.
DateTuple ace_time::extended::TransitionTemplate< ZEB, ZPB, ZRB >::startDateTime |
Start time expressed using the UTC offset of the current Transition.
Valid after ExtendedZoneProcessor::generateStartUntilTimes() is called.
Definition at line 303 of file ExtendedZoneProcessor.h.
DateTuple ace_time::extended::TransitionTemplate< ZEB, ZPB, ZRB >::transitionTime |
The original transition time, usually 'w' but sometimes 's' or 'u'.
After expandDateTuple() is called, this field will definitely be a 'w'. We must remember that the transitionTime* fields are expressed using the UTC offset of the previous Transition.
Definition at line 289 of file ExtendedZoneProcessor.h.
DateTuple ace_time::extended::TransitionTemplate< ZEB, ZPB, ZRB >::transitionTimeS |
Version of transitionTime in 's' mode, using the UTC offset of the previous Transition.
Valid before ExtendedZoneProcessor::generateStartUntilTimes() is called.
Definition at line 297 of file ExtendedZoneProcessor.h.
DateTuple ace_time::extended::TransitionTemplate< ZEB, ZPB, ZRB >::transitionTimeU |
Version of transitionTime in 'u' mode, using the UTC offset of the previous transition.
Valid before ExtendedZoneProcessor::generateStartUntilTimes() is called.
Definition at line 312 of file ExtendedZoneProcessor.h.
DateTuple ace_time::extended::TransitionTemplate< ZEB, ZPB, ZRB >::untilDateTime |
Until time expressed using the UTC offset of the current Transition.
Valid after ExtendedZoneProcessor::generateStartUntilTimes() is called.
Definition at line 318 of file ExtendedZoneProcessor.h.