AceTime
1.7.5
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.
|
A heap manager which is specialized and tuned to manage a collection of Transitions, keeping track of unused, used, and active states, using a fixed array of Transitions. More...
#include <ExtendedZoneProcessor.h>
Public Types | |
typedef TransitionTemplate< ZEB, ZPB, ZRB > | Transition |
Template instantiation of TransitionTemplate used by this class. More... | |
Public Member Functions | |
TransitionStorageTemplate () | |
Constructor. | |
void | init () |
Initialize all pools. | |
Transition * | getPrior () |
Return the current prior transition. | |
void | resetCandidatePool () |
Empty the Candidate pool by resetting the various indexes. More... | |
Transition ** | getCandidatePoolBegin () |
Transition ** | getCandidatePoolEnd () |
Transition ** | getActivePoolBegin () |
Transition ** | getActivePoolEnd () |
Transition * | getFreeAgent () |
Return a pointer to the first Transition in the free pool. More... | |
void | addFreeAgentToActivePool () |
Immediately add the free agent Transition at index mIndexFree to the Active pool. More... | |
Transition ** | reservePrior () |
Allocate one Transition just after the Active pool, but before the Candidate pool, to keep the most recent prior Transition. More... | |
void | setFreeAgentAsPriorIfValid () |
Set the free agent transition as the most recent prior. | |
void | addPriorToCandidatePool () |
Add the current prior into the Candidates pool. More... | |
void | addFreeAgentToCandidatePool () |
Add the free agent Transition at index mIndexFree to the Candidate pool, sorted by transitionTime. More... | |
Transition * | addActiveCandidatesToActivePool () |
Add active candidates into the Active pool, and collapse the Candidate pool. More... | |
const Transition * | findTransition (acetime_t epochSeconds) const |
Return the Transition matching the given epochSeconds. More... | |
const Transition * | findTransitionForDateTime (const LocalDateTime &ldt) const |
Return the Transition matching the given dateTime. More... | |
void | log () const |
Verify that the indexes are valid. More... | |
void | resetHighWater () |
Reset the high water mark. More... | |
uint8_t | getHighWater () const |
Return the high water mark. More... | |
A heap manager which is specialized and tuned to manage a collection of Transitions, keeping track of unused, used, and active states, using a fixed array of Transitions.
Its main purpose is to provide some illusion of dynamic memory allocation without actually performing any dynamic memory allocation.
We create a fixed sized array for the total pool, determined by the template parameter SIZE, then manage the various sub-pools of Transition objects. The allocation of the various sub-pools is intricately tied to the precise pattern of creation and release of the various Transition objects within the ExtendedZoneProcessor class.
There are 4 pools indicated by the following half-open (exclusive) index ranges:
1) Active pool: [0, mIndexPrior) 2) Prior pool: [mIndexPrior, mIndexCandidates), either 0 or 1 element 3) Candidate pool: [mIndexCandidates, mIndexFree) 4) Free pool: [mIndexFree, SIZE)
At the completion of the ExtendedZoneProcessor::init(LocalDate& ld) method, the Active pool will contain the active Transitions relevant to the 'year' defined by the LocalDate. The Prior and Candidate pools will be empty, with the Free pool taking up the remaining space.
SIZE | size of internal cache |
ZEB | type of ZoneEraBroker |
ZPB | type of ZonePolicyBroker |
ZRB | type of ZoneRuleBroker |
Definition at line 431 of file ExtendedZoneProcessor.h.
typedef TransitionTemplate<ZEB, ZPB, ZRB> ace_time::extended::TransitionStorageTemplate< SIZE, ZEB, ZPB, ZRB >::Transition |
Template instantiation of TransitionTemplate used by this class.
This should be treated as a private, it is exposed only for testing purposes.
Definition at line 437 of file ExtendedZoneProcessor.h.
|
inline |
Add active candidates into the Active pool, and collapse the Candidate pool.
Every MatchingEra will have at least one Transition.
Definition at line 583 of file ExtendedZoneProcessor.h.
|
inline |
Immediately add the free agent Transition at index mIndexFree to the Active pool.
Then increment mIndexFree to remove the free agent from the Free pool. This assumes that the Pending and Candidate pool are empty, which makes the Active pool come immediately before the Free pool.
Definition at line 510 of file ExtendedZoneProcessor.h.
|
inline |
Add the free agent Transition at index mIndexFree to the Candidate pool, sorted by transitionTime.
Then increment mIndexFree by one to remove the free agent from the Free pool. Essentially this is an Insertion Sort keyed by the 'transitionTime' (ignoring the DateTuple.suffix).
Definition at line 557 of file ExtendedZoneProcessor.h.
|
inline |
Add the current prior into the Candidates pool.
Prior is always just before the start of the Candidate pool, so we just need to shift back the start index of the Candidate pool.
Definition at line 547 of file ExtendedZoneProcessor.h.
|
inline |
Return the Transition matching the given epochSeconds.
Return nullptr if no matching Transition found. If a zone does not have any transition according to TZ Database, the AceTimeTools/transformer.py script adds an "anchor" transition at the "beginning of time" which happens to be the year 1872 (because the year is stored as an int8_t). Therefore, this method should never return a nullptr for a well-formed ZoneInfo file.
Definition at line 617 of file ExtendedZoneProcessor.h.
|
inline |
Return the Transition matching the given dateTime.
Return nullptr if no matching Transition found. During DST changes, a particlar LocalDateTime may correspond to 2 Transitions or 0 Transitions, and there are potentially multiple ways to handle this. This method implements the following algorithm:
1) If the localDateTime falls in the DST transition gap where 0 Transitions ought to be found, e.g. between 02:00 and 03:00 in America/Los_Angeles when standard time switches to DST time), the immediate prior Transition is returned (in effect extending the UTC offset of the prior Transition through the gap. For example, when DST starts, 02:00 becomes 03:00, so a time of 02:30 does not exist, but the Transition returned will be the one valid at 01:59. When it is converted to epoch_seconds and converted back to a LocalDateTime, the 02:30 time will become 03:30, since the later UTC offset will be used.
2) If the localDateTime falls in a time period where there are 2 Transitions, hence 2 valid UTC offsets, the later Transition is returned. For example, when DST ends in America/Los_Angeles, 02:00 becomes 01:00, so a time of 01:30 could belong to the earlier or later Transition. This method returns the later Transition.
Definition at line 654 of file ExtendedZoneProcessor.h.
|
inline |
Return a pointer to the first Transition in the free pool.
If this transition is not used, then it's ok to just drop it. The next time getFreeAgent() is called, the same Transition will be returned.
Definition at line 489 of file ExtendedZoneProcessor.h.
|
inline |
Return the high water mark.
This is the largest value of mIndexFree that was used. If this returns SIZE, it indicates that the Transition mPool overflowed. For debugging.
Definition at line 721 of file ExtendedZoneProcessor.h.
|
inline |
Verify that the indexes are valid.
Used only for debugging.
Definition at line 681 of file ExtendedZoneProcessor.h.
|
inline |
Allocate one Transition just after the Active pool, but before the Candidate pool, to keep the most recent prior Transition.
Shift the Candidate pool and Free pool up by one.
Definition at line 522 of file ExtendedZoneProcessor.h.
|
inline |
Empty the Candidate pool by resetting the various indexes.
If every iteration of createTransitionsForMatch() finishes with addFreeAgentToActivePool() or addActiveCandidatesToActivePool(), it may be possible to remove this. But it's safer to reset the indexes upon each iteration.
Definition at line 465 of file ExtendedZoneProcessor.h.
|
inline |