Showing content from https://unicode-org.github.io/icu-docs/apidoc/released/icu4c/classicu_1_1VTimeZone.html below:
ICU 77.1: icu::VTimeZone Class Reference
VTimeZone (const VTimeZone &source) Copy constructor. More...
virtual ~VTimeZone () Destructor. More...
VTimeZone & operator= (const VTimeZone &right) Assignment operator. More...
virtual bool operator== (const TimeZone &that) const override Return true if the given TimeZone objects are semantically equal. More...
virtual bool operator!= (const TimeZone &that) const Return true if the given TimeZone objects are semantically unequal. More...
UBool getTZURL (UnicodeString &url) const Gets the RFC2445 TZURL property value. More...
void setTZURL (const UnicodeString &url) Sets the RFC2445 TZURL property value. More...
UBool getLastModified (UDate &lastModified) const Gets the RFC2445 LAST-MODIFIED property value. More...
void setLastModified (UDate lastModified) Sets the RFC2445 LAST-MODIFIED property value. More...
void write (UnicodeString &result, UErrorCode &status) const Writes RFC2445 VTIMEZONE data for this time zone. More...
void write (UDate start, UnicodeString &result, UErrorCode &status) const Writes RFC2445 VTIMEZONE data for this time zone applicable for dates after the specified start time. More...
void writeSimple (UDate time, UnicodeString &result, UErrorCode &status) const Writes RFC2445 VTIMEZONE data applicable for the specified date. More...
virtual VTimeZone * clone () const override Clones TimeZone objects polymorphically. More...
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. More...
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. More...
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. More...
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. More...
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). More...
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). More...
virtual UBool useDaylightTime () const override Queries if this time zone uses daylight savings time. More...
virtual UBool inDaylightTime (UDate date, UErrorCode &status) const override Queries if the given date is in daylight savings time in this time zone. More...
virtual UBool hasSameRules (const TimeZone &other) const override Returns true if this zone has the same rule and offset as another zone. More...
virtual UBool getNextTransition (UDate base, UBool inclusive, TimeZoneTransition &result) const override Gets the first time zone transition after the base time. More...
virtual UBool getPreviousTransition (UDate base, UBool inclusive, TimeZoneTransition &result) const override Gets the most recent time zone transition before the base time. More...
virtual int32_t countTransitionRules (UErrorCode &status) const override Returns the number of TimeZoneRules which represents time transitions, for this time zone, that is, all TimeZoneRules for this time zone except InitialTimeZoneRule. More...
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. More...
virtual UClassID getDynamicClassID () const override Returns a unique class ID POLYMORPHICALLY. More...
virtual ~BasicTimeZone () Destructor. More...
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. More...
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. More...
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. More...
virtual ~TimeZone () bool operator!= (const TimeZone &that) const Returns true if the two TimeZones are NOT equal; that is, if operator==() returns false. More...
UnicodeString & getID (UnicodeString &ID) const Fills in "ID" with the TimeZone's ID. More...
void setID (const UnicodeString &ID) Sets the TimeZone's ID to the specified value. More...
UnicodeString & getDisplayName (UnicodeString &result) const Returns a name of this time zone suitable for presentation to the user in the default locale. More...
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. More...
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. More...
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. More...
virtual int32_t getDSTSavings () const Returns the amount of time to be added to local standard time to get local wall clock time. More...
virtual ~UObject () Destructor. More...
static VTimeZone * createVTimeZoneByID (const UnicodeString &ID) Create a VTimeZone instance by the time zone ID. More...
static VTimeZone * createVTimeZoneFromBasicTimeZone (const BasicTimeZone &basicTZ, UErrorCode &status) Create a VTimeZone instance using a basic time zone. More...
static VTimeZone * createVTimeZone (const UnicodeString &vtzdata, UErrorCode &status) Create a VTimeZone instance by RFC2445 VTIMEZONE data. More...
static UClassID getStaticClassID () Return the class ID for this class. More...
static const TimeZone & getUnknown () Returns the "unknown" time zone. More...
static const TimeZone * getGMT () The GMT (=UTC) time zone has a raw offset of zero and does not use daylight savings time. More...
static TimeZone * createTimeZone (const UnicodeString &ID) Creates a TimeZone for the given ID. More...
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. More...
static StringEnumeration * createEnumeration () Returns an enumeration over all recognized time zone IDs. More...
static StringEnumeration * createEnumeration (UErrorCode &status) Returns an enumeration over all recognized time zone IDs. More...
static StringEnumeration * createEnumeration (int32_t rawOffset) Returns an enumeration over time zone IDs with a given raw offset from GMT. More...
static StringEnumeration * createEnumerationForRawOffset (int32_t rawOffset, UErrorCode &status) Returns an enumeration over time zone IDs with a given raw offset from GMT. More...
static StringEnumeration * createEnumeration (const char *region) Returns an enumeration over time zone IDs associated with the given region. More...
static StringEnumeration * createEnumerationForRegion (const char *region, UErrorCode &status) Returns an enumeration over time zone IDs associated with the given region. More...
static int32_t countEquivalentIDs (const UnicodeString &id) Returns the number of IDs in the equivalency group that includes the given ID. More...
static UnicodeString getEquivalentID (const UnicodeString &id, int32_t index) Returns an ID in the equivalency group that includes the given ID. More...
static TimeZone * detectHostTimeZone () Creates an instance of TimeZone detected from the current host system configuration. More...
static TimeZone * createDefault () Creates a new copy of the default TimeZone for this host. More...
static TimeZone * forLocaleOrDefault (const Locale &locale) If the locale contains the timezone keyword, creates a copy of that TimeZone. More...
static void adoptDefault (TimeZone *zone) Sets the default time zone (i.e., what's returned by createDefault()) to be the specified time zone. More...
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. More...
static const char * getTZDataVersion (UErrorCode &status) Returns the timezone data version currently used by ICU. More...
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. More...
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. More...
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. More...
static UnicodeString & getWindowsID (const UnicodeString &id, UnicodeString &winid, UErrorCode &status) Converts a system time zone ID to an equivalent Windows time zone ID. More...
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. More...
static UClassID getStaticClassID () Return the class ID for this class. More...
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. More...
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. More...
enum { kStandard = 0x01 , kDaylight = 0x03 , kFormer = 0x04 , kLatter = 0x0C } The time type option bit flags used by getOffsetFromLocal. More...
enum EDisplayType {
SHORT = 1 , LONG , SHORT_GENERIC , LONG_GENERIC ,
SHORT_GMT , LONG_GMT , SHORT_COMMONLY_USED , GENERIC_LOCATION
} Enum for use with getDisplayName. More...
BasicTimeZone () Default constructor. More...
BasicTimeZone (const UnicodeString &id) Construct a timezone with a given ID. More...
BasicTimeZone (const BasicTimeZone &source) Copy constructor. More...
BasicTimeZone & operator= (const BasicTimeZone &)=default Copy assignment. More...
void getTimeZoneRulesAfter (UDate start, InitialTimeZoneRule *&initial, UVector *&transitionRules, UErrorCode &status) const Gets the set of TimeZoneRule instances applicable to the specified time and after. More...
TimeZone () Default constructor. More...
TimeZone (const UnicodeString &id) Construct a TimeZone with a given ID. More...
TimeZone (const TimeZone &source) Copy constructor. More...
TimeZone & operator= (const TimeZone &right) Default assignment operator. More...
static UResourceBundle * loadRule (const UResourceBundle *top, const UnicodeString &ruleid, UResourceBundle *oldbundle, UErrorCode &status) Utility function. More...
static constexpr int32_t kStdDstMask = kDaylight A time type option bit mask used by getOffsetFromLocal. More...
static constexpr int32_t kFormerLatterMask = kLatter A time type option bit mask used by getOffsetFromLocal. More...
VTimeZone is a class implementing RFC2445 VTIMEZONE.
You can create a VTimeZone instance from a time zone ID supported by TimeZone. With the VTimeZone instance created from the ID, you can write out the rule in RFC2445 VTIMEZONE format. Also, you can create a VTimeZone instance from RFC2445 VTIMEZONE data stream, which allows you to calculate time zone offset by the rules defined by the data. Or, you can create a VTimeZone from any other ICU BasicTimeZone.
Note: The consumer of this class reading or writing VTIMEZONE data is responsible to decode or encode Non-ASCII text. Methods reading/writing VTIMEZONE data in this class do nothing with MIME encoding.
-
Stable:
-
ICU 3.8
Definition at line 45 of file vtzone.h.
virtual int32_t icu::VTimeZone::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 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.
-
Parameters
-
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.
-
Returns
-
The offset in milliseconds to add to GMT to get local time.
-
Stable:
-
ICU 3.8
Implements icu::TimeZone.
virtual int32_t icu::VTimeZone::getOffset ( uint8_t era, int32_t year, int32_t month, int32_t day, uint8_t dayOfWeek, int32_t millis, UErrorCode & status ) const 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.
-
Parameters
-
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.
-
Returns
-
The offset in milliseconds to add to GMT to get local time.
-
Stable:
-
ICU 3.8
Implements icu::TimeZone.
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.
-
Parameters
-
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.
-
Stable:
-
ICU 3.8
Implements icu::BasicTimeZone.
RetroSearch is an open source project built by @garambo
| Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4