ICU 75.1 75.1
|
a BasicTimeZone subclass implemented in terms of InitialTimeZoneRule and TimeZoneRule instances More...
#include <rbtz.h>
Public Member Functions | |
RuleBasedTimeZone (const UnicodeString &id, InitialTimeZoneRule *initialRule) | |
Constructs a RuleBasedTimeZone object with the ID and the InitialTimeZoneRule . | |
RuleBasedTimeZone (const RuleBasedTimeZone &source) | |
Copy constructor. | |
virtual | ~RuleBasedTimeZone () |
Destructor. | |
RuleBasedTimeZone & | operator= (const RuleBasedTimeZone &right) |
Assignment operator. | |
virtual bool | operator== (const TimeZone &that) const override |
Return true if the given TimeZone objects are semantically equal. | |
virtual bool | operator!= (const TimeZone &that) const |
Return true if the given TimeZone objects are semantically unequal. | |
void | addTransitionRule (TimeZoneRule *rule, UErrorCode &status) |
Adds the TimeZoneRule which represents time transitions. | |
void | complete (UErrorCode &status) |
Makes the TimeZoneRule ready to handle actual timezone calculation APIs. | |
virtual RuleBasedTimeZone * | clone () const override |
Clones TimeZone objects polymorphically. | |
virtual int32_t | getOffset (uint8_t era, int32_t year, int32_t month, int32_t day, uint8_t dayOfWeek, int32_t millis, UErrorCode &status) const override |
Returns the TimeZone's adjusted GMT offset (i.e., the number of milliseconds to add to GMT to get local time in this time zone, taking daylight savings time into account) as of a particular reference date. | |
virtual int32_t | getOffset (uint8_t era, int32_t year, int32_t month, int32_t day, uint8_t dayOfWeek, int32_t millis, int32_t monthLength, UErrorCode &status) const override |
Gets the time zone offset, for current date, modified in case of daylight savings. | |
virtual void | getOffset (UDate date, UBool local, int32_t &rawOffset, int32_t &dstOffset, UErrorCode &ec) const override |
Returns the time zone raw and GMT offset for the given moment in time. | |
virtual void | setRawOffset (int32_t offsetMillis) override |
Sets the TimeZone's raw GMT offset (i.e., the number of milliseconds to add to GMT to get local time, before taking daylight savings time into account). | |
virtual int32_t | getRawOffset () const override |
Returns the TimeZone's raw GMT offset (i.e., the number of milliseconds to add to GMT to get local time, before taking daylight savings time into account). | |
virtual UBool | useDaylightTime () const override |
Queries if this time zone uses daylight savings time. | |
virtual UBool | inDaylightTime (UDate date, UErrorCode &status) const override |
Queries if the given date is in daylight savings time in this time zone. | |
virtual UBool | hasSameRules (const TimeZone &other) const override |
Returns true if this zone has the same rule and offset as another zone. | |
virtual UBool | getNextTransition (UDate base, UBool inclusive, TimeZoneTransition &result) const override |
Gets the first time zone transition after the base time. | |
virtual UBool | getPreviousTransition (UDate base, UBool inclusive, TimeZoneTransition &result) const override |
Gets the most recent time zone transition before the base time. | |
virtual int32_t | countTransitionRules (UErrorCode &status) const override |
Returns the number of TimeZoneRule s which represents time transitions, for this time zone, that is, all TimeZoneRule s for this time zone except InitialTimeZoneRule . | |
virtual void | getTimeZoneRules (const InitialTimeZoneRule *&initial, const TimeZoneRule *trsrules[], int32_t &trscount, UErrorCode &status) const override |
Gets the InitialTimeZoneRule and the set of TimeZoneRule which represent time transitions for this time zone. | |
virtual void | getOffsetFromLocal (UDate date, UTimeZoneLocalOption nonExistingTimeOpt, UTimeZoneLocalOption duplicatedTimeOpt, int32_t &rawOffset, int32_t &dstOffset, UErrorCode &status) const override |
Get time zone offsets from local wall time. | |
virtual UClassID | getDynamicClassID () const override |
Returns a unique class ID POLYMORPHICALLY. | |
Public Member Functions inherited from icu::BasicTimeZone | |
virtual | ~BasicTimeZone () |
Destructor. | |
virtual UBool | hasEquivalentTransitions (const BasicTimeZone &tz, UDate start, UDate end, UBool ignoreDstAmount, UErrorCode &ec) const |
Checks if the time zone has equivalent transitions in the time range. | |
virtual void | getSimpleRulesNear (UDate date, InitialTimeZoneRule *&initial, AnnualTimeZoneRule *&std, AnnualTimeZoneRule *&dst, UErrorCode &status) const |
Gets the set of time zone rules valid at the specified time. | |
void | getOffsetFromLocal (UDate date, int32_t nonExistingTimeOpt, int32_t duplicatedTimeOpt, int32_t &rawOffset, int32_t &dstOffset, UErrorCode &status) const |
Get time zone offsets from local wall time. | |
Public Member Functions inherited from icu::TimeZone | |
virtual | ~TimeZone () |
bool | operator!= (const TimeZone &that) const |
Returns true if the two TimeZones are NOT equal; that is, if operator==() returns false. | |
UnicodeString & | getID (UnicodeString &ID) const |
Fills in "ID" with the TimeZone's ID. | |
void | setID (const UnicodeString &ID) |
Sets the TimeZone's ID to the specified value. | |
UnicodeString & | getDisplayName (UnicodeString &result) const |
Returns a name of this time zone suitable for presentation to the user in the default locale. | |
UnicodeString & | getDisplayName (const Locale &locale, UnicodeString &result) const |
Returns a name of this time zone suitable for presentation to the user in the specified locale. | |
UnicodeString & | getDisplayName (UBool inDaylight, EDisplayType style, UnicodeString &result) const |
Returns a name of this time zone suitable for presentation to the user in the default locale. | |
UnicodeString & | getDisplayName (UBool inDaylight, EDisplayType style, const Locale &locale, UnicodeString &result) const |
Returns a name of this time zone suitable for presentation to the user in the specified locale. | |
virtual int32_t | getDSTSavings () const |
Returns the amount of time to be added to local standard time to get local wall clock time. | |
Public Member Functions inherited from icu::UObject | |
virtual | ~UObject () |
Destructor. | |
Static Public Member Functions | |
static UClassID | getStaticClassID () |
Return the class ID for this class. | |
Static Public Member Functions inherited from icu::TimeZone | |
static const TimeZone & | getUnknown () |
Returns the "unknown" time zone. | |
static const TimeZone * | getGMT () |
The GMT (=UTC) time zone has a raw offset of zero and does not use daylight savings time. | |
static TimeZone * | createTimeZone (const UnicodeString &ID) |
Creates a TimeZone for the given ID. | |
static StringEnumeration * | createTimeZoneIDEnumeration (USystemTimeZoneType zoneType, const char *region, const int32_t *rawOffset, UErrorCode &ec) |
Returns an enumeration over system time zone IDs with the given filter conditions. | |
static StringEnumeration * | createEnumeration () |
Returns an enumeration over all recognized time zone IDs. | |
static StringEnumeration * | createEnumeration (UErrorCode &status) |
Returns an enumeration over all recognized time zone IDs. | |
static StringEnumeration * | createEnumeration (int32_t rawOffset) |
Returns an enumeration over time zone IDs with a given raw offset from GMT. | |
static StringEnumeration * | createEnumerationForRawOffset (int32_t rawOffset, UErrorCode &status) |
Returns an enumeration over time zone IDs with a given raw offset from GMT. | |
static StringEnumeration * | createEnumeration (const char *region) |
Returns an enumeration over time zone IDs associated with the given region. | |
static StringEnumeration * | createEnumerationForRegion (const char *region, UErrorCode &status) |
Returns an enumeration over time zone IDs associated with the given region. | |
static int32_t | countEquivalentIDs (const UnicodeString &id) |
Returns the number of IDs in the equivalency group that includes the given ID. | |
static const UnicodeString | getEquivalentID (const UnicodeString &id, int32_t index) |
Returns an ID in the equivalency group that includes the given ID. | |
static TimeZone * | detectHostTimeZone () |
Creates an instance of TimeZone detected from the current host system configuration. | |
static TimeZone * | createDefault () |
Creates a new copy of the default TimeZone for this host. | |
static TimeZone * | forLocaleOrDefault (const Locale &locale) |
If the locale contains the timezone keyword, creates a copy of that TimeZone. | |
static void | adoptDefault (TimeZone *zone) |
Sets the default time zone (i.e., what's returned by createDefault()) to be the specified time zone. | |
static void | setDefault (const TimeZone &zone) |
Same as adoptDefault(), except that the TimeZone object passed in is NOT adopted; the caller remains responsible for deleting it. | |
static const char * | getTZDataVersion (UErrorCode &status) |
Returns the timezone data version currently used by ICU. | |
static UnicodeString & | getCanonicalID (const UnicodeString &id, UnicodeString &canonicalID, UErrorCode &status) |
Returns the canonical system timezone ID or the normalized custom time zone ID for the given time zone ID. | |
static UnicodeString & | getCanonicalID (const UnicodeString &id, UnicodeString &canonicalID, UBool &isSystemID, UErrorCode &status) |
Returns the canonical system time zone ID or the normalized custom time zone ID for the given time zone ID. | |
static UnicodeString & | getIanaID (const UnicodeString &id, UnicodeString &ianaID, UErrorCode &status) |
Returns the preferred time zone ID in the IANA time zone database for the given time zone ID. | |
static UnicodeString & | getWindowsID (const UnicodeString &id, UnicodeString &winid, UErrorCode &status) |
Converts a system time zone ID to an equivalent Windows time zone ID. | |
static UnicodeString & | getIDForWindowsID (const UnicodeString &winid, const char *region, UnicodeString &id, UErrorCode &status) |
Converts a Windows time zone ID to an equivalent system time zone ID for a region. | |
static UClassID | getStaticClassID () |
Return the class ID for this class. | |
static int32_t | getRegion (const UnicodeString &id, char *region, int32_t capacity, UErrorCode &status) |
Gets the region code associated with the given system time zone ID. | |
static const char16_t * | getRegion (const UnicodeString &id, UErrorCode &status) |
Returns the region code associated with the given zone, or nullptr if the zone is not known. | |
Additional Inherited Members | |
Public Types inherited from icu::BasicTimeZone | |
enum | { kStandard = 0x01 , kDaylight = 0x03 , kFormer = 0x04 , kLatter = 0x0C } |
The time type option bit flags used by getOffsetFromLocal. More... | |
Public Types inherited from icu::TimeZone | |
enum | EDisplayType { SHORT = 1 , LONG , SHORT_GENERIC , LONG_GENERIC , SHORT_GMT , LONG_GMT , SHORT_COMMONLY_USED , GENERIC_LOCATION } |
Enum for use with getDisplayName. More... | |
Protected Member Functions inherited from icu::BasicTimeZone | |
BasicTimeZone () | |
Default constructor. | |
BasicTimeZone (const UnicodeString &id) | |
Construct a timezone with a given ID. | |
BasicTimeZone (const BasicTimeZone &source) | |
Copy constructor. | |
BasicTimeZone & | operator= (const BasicTimeZone &)=default |
Copy assignment. | |
void | getTimeZoneRulesAfter (UDate start, InitialTimeZoneRule *&initial, UVector *&transitionRules, UErrorCode &status) const |
Gets the set of TimeZoneRule instances applicable to the specified time and after. | |
Protected Member Functions inherited from icu::TimeZone | |
TimeZone () | |
Default constructor. | |
TimeZone (const UnicodeString &id) | |
Construct a TimeZone with a given ID. | |
TimeZone (const TimeZone &source) | |
Copy constructor. | |
TimeZone & | operator= (const TimeZone &right) |
Default assignment operator. | |
Static Protected Member Functions inherited from icu::TimeZone | |
static UResourceBundle * | loadRule (const UResourceBundle *top, const UnicodeString &ruleid, UResourceBundle *oldbundle, UErrorCode &status) |
Utility function. | |
Static Protected Attributes inherited from icu::BasicTimeZone | |
static constexpr int32_t | kStdDstMask = kDaylight |
A time type option bit mask used by getOffsetFromLocal. | |
static constexpr int32_t | kFormerLatterMask = kLatter |
A time type option bit mask used by getOffsetFromLocal. | |
a BasicTimeZone subclass implemented in terms of InitialTimeZoneRule and TimeZoneRule instances
icu::RuleBasedTimeZone::RuleBasedTimeZone | ( | const UnicodeString & | id, |
InitialTimeZoneRule * | initialRule | ||
) |
Constructs a RuleBasedTimeZone
object with the ID and the InitialTimeZoneRule
.
The input InitialTimeZoneRule
is adopted by this RuleBasedTimeZone
, thus the caller must not delete it.
id | The time zone ID. |
initialRule | The initial time zone rule. |
icu::RuleBasedTimeZone::RuleBasedTimeZone | ( | const RuleBasedTimeZone & | source | ) |
void icu::RuleBasedTimeZone::addTransitionRule | ( | TimeZoneRule * | rule, |
UErrorCode & | status | ||
) |
Adds the TimeZoneRule
which represents time transitions.
The TimeZoneRule
must have start times, that is, the result of isTransitionRule()
must be true. Otherwise, U_ILLEGAL_ARGUMENT_ERROR is set to the error code. The input TimeZoneRule
is adopted by this RuleBasedTimeZone
; the caller must not delete it. Should an error condition prevent the successful adoption of the rule, this function will delete it.
After all rules are added, the caller must call complete()
method to make this RuleBasedTimeZone
ready to handle common time zone functions.
rule | The TimeZoneRule . |
status | Output param to filled in with a success or an error. |
|
overridevirtual |
Clones TimeZone objects polymorphically.
Clients are responsible for deleting the TimeZone object cloned.
Implements icu::BasicTimeZone.
void icu::RuleBasedTimeZone::complete | ( | UErrorCode & | status | ) |
Makes the TimeZoneRule
ready to handle actual timezone calculation APIs.
This method collects time zone rules specified by the caller via the constructor and addTransitionRule() and builds internal structure for making the object ready to support time zone APIs such as getOffset(), getNextTransition() and others.
status | Output param to filled in with a success or an error. |
|
overridevirtual |
Returns the number of TimeZoneRule
s which represents time transitions, for this time zone, that is, all TimeZoneRule
s for this time zone except InitialTimeZoneRule
.
The return value range is 0 or any positive value.
status | Receives error status code. |
TimeZoneRule
s representing time transitions. Implements icu::BasicTimeZone.
Returns a unique class ID POLYMORPHICALLY.
Pure virtual override. This method is to implement a simple version of RTTI, since not all C++ compilers support genuine RTTI. Polymorphic operator==() and clone() methods call this method.
Implements icu::TimeZone.
|
overridevirtual |
Gets the first time zone transition after the base time.
base | The base time. |
inclusive | Whether the base time is inclusive or not. |
result | Receives the first transition after the base time. |
Implements icu::BasicTimeZone.
|
overridevirtual |
Returns the time zone raw and GMT offset for the given moment in time.
Upon return, local-millis = GMT-millis + rawOffset + dstOffset. All computations are performed in the proleptic Gregorian calendar. The default implementation in the TimeZone class delegates to the 8-argument getOffset().
date | moment in time for which to return offsets, in units of milliseconds from January 1, 1970 0:00 GMT, either GMT time or local wall time, depending on ‘local’. |
local | if true, ‘date’ is local wall time; otherwise it is in GMT time. |
rawOffset | output parameter to receive the raw offset, that is, the offset not including DST adjustments |
dstOffset | output parameter to receive the DST offset, that is, the offset to be added to ‘rawOffset’ to obtain the total offset between local and GMT time. If DST is not in effect, this value is zero; otherwise it is a positive value, typically one hour. |
ec | input-output error code |
Reimplemented from icu::TimeZone.
|
overridevirtual |
Gets the time zone offset, for current date, modified in case of daylight savings.
This is the offset to add to UTC to get local time.
Note: Don't call this method. Instead, call the getOffset(UDate...) overload, which returns both the raw and the DST offset for a given time. This method is retained only for backward compatibility.
era | The reference date's era |
year | The reference date's year |
month | The reference date's month (0-based; 0 is January) |
day | The reference date's day-in-month (1-based) |
dayOfWeek | The reference date's day-of-week (1-based; 1 is Sunday) |
millis | The reference date's milliseconds in day, local standard time |
monthLength | The length of the given month in days. |
status | Output param to filled in with a success or an error. |
Implements icu::TimeZone.
|
overridevirtual |
Returns the TimeZone's adjusted GMT offset (i.e., the number of milliseconds to add to GMT to get local time in this time zone, taking daylight savings time into account) as of a particular reference date.
The reference date is used to determine whether daylight savings time is in effect and needs to be figured into the offset that is returned (in other words, what is the adjusted GMT offset in this time zone at this particular date and time?). For the time zones produced by createTimeZone(), the reference data is specified according to the Gregorian calendar, and the date and time fields are local standard time.
Note: Don't call this method. Instead, call the getOffset(UDate...) overload, which returns both the raw and the DST offset for a given time. This method is retained only for backward compatibility.
era | The reference date's era |
year | The reference date's year |
month | The reference date's month (0-based; 0 is January) |
day | The reference date's day-in-month (1-based) |
dayOfWeek | The reference date's day-of-week (1-based; 1 is Sunday) |
millis | The reference date's milliseconds in day, local standard time |
status | Output param to filled in with a success or an error. |
Implements icu::TimeZone.
|
overridevirtual |
|
overridevirtual |
Gets the most recent time zone transition before the base time.
base | The base time. |
inclusive | Whether the base time is inclusive or not. |
result | Receives the most recent transition before the base time. |
Implements icu::BasicTimeZone.
Returns the TimeZone's raw GMT offset (i.e., the number of milliseconds to add to GMT to get local time, before taking daylight savings time into account).
Implements icu::TimeZone.
Return the class ID for this class.
This is useful only for comparing to a return value from getDynamicClassID(). For example:
. Base* polymorphic_pointer = createPolymorphicObject(); . if (polymorphic_pointer->getDynamicClassID() == . erived::getStaticClassID()) ...
|
overridevirtual |
Gets the InitialTimeZoneRule
and the set of TimeZoneRule
which represent time transitions for this time zone.
On successful return, the argument initial points to non-nullptr InitialTimeZoneRule
and the array trsrules is filled with 0 or multiple TimeZoneRule
instances up to the size specified by trscount. The results are referencing the rule instance held by this time zone instance. Therefore, after this time zone is destructed, they are no longer available.
initial | Receives the initial timezone rule |
trsrules | Receives the timezone transition rules |
trscount | On input, specify the size of the array 'transitions' receiving the timezone transition rules. On output, actual number of rules filled in the array will be set. |
status | Receives error status code. |
Implements icu::BasicTimeZone.
Returns true if this zone has the same rule and offset as another zone.
That is, if this zone differs only in ID, if at all.
other | the TimeZone object to be compared with |
Reimplemented from icu::TimeZone.
|
overridevirtual |
Queries if the given date is in daylight savings time in this time zone.
This method is wasteful since it creates a new GregorianCalendar and deletes it each time it is called. This is a deprecated method and provided only for Java compatibility.
date | the given UDate. |
status | Output param filled in with success/error code. |
Implements icu::TimeZone.
RuleBasedTimeZone & icu::RuleBasedTimeZone::operator= | ( | const RuleBasedTimeZone & | right | ) |
Return true if the given TimeZone
objects are semantically equal.
Objects of different subclasses are considered unequal.
that | The object to be compared with. |
TimeZone
objects are semantically equal. Reimplemented from icu::TimeZone.
Sets the TimeZone's raw GMT offset (i.e., the number of milliseconds to add to GMT to get local time, before taking daylight savings time into account).
offsetMillis | The new raw GMT offset for this time zone. |
Implements icu::TimeZone.
Queries if this time zone uses daylight savings time.
Implements icu::TimeZone.