ICU 62.1  62.1
timezone.h
Go to the documentation of this file.
1 // © 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /*************************************************************************
4 * Copyright (c) 1997-2016, International Business Machines Corporation
5 * and others. All Rights Reserved.
6 **************************************************************************
7 *
8 * File TIMEZONE.H
9 *
10 * Modification History:
11 *
12 * Date Name Description
13 * 04/21/97 aliu Overhauled header.
14 * 07/09/97 helena Changed createInstance to createDefault.
15 * 08/06/97 aliu Removed dependency on internal header for Hashtable.
16 * 08/10/98 stephen Changed getDisplayName() API conventions to match
17 * 08/19/98 stephen Changed createTimeZone() to never return 0
18 * 09/02/98 stephen Sync to JDK 1.2 8/31
19 * - Added getOffset(... monthlen ...)
20 * - Added hasSameRules()
21 * 09/15/98 stephen Added getStaticClassID
22 * 12/03/99 aliu Moved data out of static table into icudata.dll.
23 * Hashtable replaced by new static data structures.
24 * 12/14/99 aliu Made GMT public.
25 * 08/15/01 grhoten Made GMT private and added the getGMT() function
26 **************************************************************************
27 */
28 
29 #ifndef TIMEZONE_H
30 #define TIMEZONE_H
31 
32 #include "unicode/utypes.h"
33 
39 #if !UCONFIG_NO_FORMATTING
40 
41 #include "unicode/uobject.h"
42 #include "unicode/unistr.h"
43 #include "unicode/ures.h"
44 #include "unicode/ucal.h"
45 
47 
48 class StringEnumeration;
49 
131 class U_I18N_API TimeZone : public UObject {
132 public:
136  virtual ~TimeZone();
137 
150  static const TimeZone& U_EXPORT2 getUnknown();
151 
164  static const TimeZone* U_EXPORT2 getGMT(void);
165 
177  static TimeZone* U_EXPORT2 createTimeZone(const UnicodeString& ID);
178 
194  static StringEnumeration* U_EXPORT2 createTimeZoneIDEnumeration(
195  USystemTimeZoneType zoneType,
196  const char* region,
197  const int32_t* rawOffset,
198  UErrorCode& ec);
199 
207  static StringEnumeration* U_EXPORT2 createEnumeration();
208 
226  static StringEnumeration* U_EXPORT2 createEnumeration(int32_t rawOffset);
227 
238  static StringEnumeration* U_EXPORT2 createEnumeration(const char* country);
239 
254  static int32_t U_EXPORT2 countEquivalentIDs(const UnicodeString& id);
255 
275  static const UnicodeString U_EXPORT2 getEquivalentID(const UnicodeString& id,
276  int32_t index);
277 
293  static TimeZone* U_EXPORT2 detectHostTimeZone();
294 
307  static TimeZone* U_EXPORT2 createDefault(void);
308 
322  static void U_EXPORT2 adoptDefault(TimeZone* zone);
323 
324 #ifndef U_HIDE_SYSTEM_API
325 
335  static void U_EXPORT2 setDefault(const TimeZone& zone);
336 #endif /* U_HIDE_SYSTEM_API */
337 
344  static const char* U_EXPORT2 getTZDataVersion(UErrorCode& status);
345 
359  static UnicodeString& U_EXPORT2 getCanonicalID(const UnicodeString& id,
360  UnicodeString& canonicalID, UErrorCode& status);
361 
377  static UnicodeString& U_EXPORT2 getCanonicalID(const UnicodeString& id,
378  UnicodeString& canonicalID, UBool& isSystemID, UErrorCode& status);
379 
402  static UnicodeString& U_EXPORT2 getWindowsID(const UnicodeString& id,
403  UnicodeString& winid, UErrorCode& status);
404 
431  static UnicodeString& U_EXPORT2 getIDForWindowsID(const UnicodeString& winid, const char* region,
432  UnicodeString& id, UErrorCode& status);
433 
443  virtual UBool operator==(const TimeZone& that) const;
444 
454  UBool operator!=(const TimeZone& that) const {return !operator==(that);}
455 
480  virtual int32_t getOffset(uint8_t era, int32_t year, int32_t month, int32_t day,
481  uint8_t dayOfWeek, int32_t millis, UErrorCode& status) const = 0;
482 
503  virtual int32_t getOffset(uint8_t era, int32_t year, int32_t month, int32_t day,
504  uint8_t dayOfWeek, int32_t milliseconds,
505  int32_t monthLength, UErrorCode& status) const = 0;
506 
530  virtual void getOffset(UDate date, UBool local, int32_t& rawOffset,
531  int32_t& dstOffset, UErrorCode& ec) const;
532 
540  virtual void setRawOffset(int32_t offsetMillis) = 0;
541 
549  virtual int32_t getRawOffset(void) const = 0;
550 
558  UnicodeString& getID(UnicodeString& ID) const;
559 
573  void setID(const UnicodeString& ID);
574 
584  SHORT = 1,
623  GENERIC_LOCATION
624  };
625 
637  UnicodeString& getDisplayName(UnicodeString& result) const;
638 
652  UnicodeString& getDisplayName(const Locale& locale, UnicodeString& result) const;
653 
666  UnicodeString& getDisplayName(UBool daylight, EDisplayType style, UnicodeString& result) const;
667 
682  UnicodeString& getDisplayName(UBool daylight, EDisplayType style, const Locale& locale, UnicodeString& result) const;
683 
718  virtual UBool useDaylightTime(void) const = 0;
719 
733  virtual UBool inDaylightTime(UDate date, UErrorCode& status) const = 0;
734 
743  virtual UBool hasSameRules(const TimeZone& other) const;
744 
752  virtual TimeZone* clone(void) const = 0;
753 
760  static UClassID U_EXPORT2 getStaticClassID(void);
761 
773  virtual UClassID getDynamicClassID(void) const = 0;
774 
790  virtual int32_t getDSTSavings() const;
791 
809  static int32_t U_EXPORT2 getRegion(const UnicodeString& id,
810  char *region, int32_t capacity, UErrorCode& status);
811 
812 protected:
813 
818  TimeZone();
819 
825  TimeZone(const UnicodeString &id);
826 
832  TimeZone(const TimeZone& source);
833 
839  TimeZone& operator=(const TimeZone& right);
840 
841 #ifndef U_HIDE_INTERNAL_API
842 
851  static UResourceBundle* loadRule(const UResourceBundle* top, const UnicodeString& ruleid, UResourceBundle* oldbundle, UErrorCode&status);
852 #endif /* U_HIDE_INTERNAL_API */
853 
854 private:
855  friend class ZoneMeta;
856 
857 
858  static TimeZone* createCustomTimeZone(const UnicodeString&); // Creates a time zone based on the string.
859 
868  static const char16_t* findID(const UnicodeString& id);
869 
878  static const char16_t* dereferOlsonLink(const UnicodeString& id);
879 
886  static const char16_t* getRegion(const UnicodeString& id);
887 
888  public:
889 #ifndef U_HIDE_INTERNAL_API
890 
898  static const char16_t* getRegion(const UnicodeString& id, UErrorCode& status);
899 #endif /* U_HIDE_INTERNAL_API */
900 
901  private:
912  static UBool parseCustomID(const UnicodeString& id, int32_t& sign, int32_t& hour,
913  int32_t& minute, int32_t& second);
914 
925  static UnicodeString& getCustomID(const UnicodeString& id, UnicodeString& normalized,
926  UErrorCode& status);
927 
937  static UnicodeString& formatCustomID(int32_t hour, int32_t min, int32_t sec,
938  UBool negative, UnicodeString& id);
939 
940  UnicodeString fID; // this time zone's ID
941 
942  friend class TZEnumeration;
943 };
944 
945 
946 // -------------------------------------
947 
948 inline UnicodeString&
950 {
951  ID = fID;
952  return ID;
953 }
954 
955 // -------------------------------------
956 
957 inline void
959 {
960  fID = ID;
961 }
963 
964 #endif /* #if !UCONFIG_NO_FORMATTING */
965 
966 #endif //_TIMEZONE
967 //eof
void setID(const UnicodeString &ID)
Sets the TimeZone's ID to the specified value.
Definition: timezone.h:958
C API: Calendar.
UnicodeString & getID(UnicodeString &ID) const
Fills in "ID" with the TimeZone's ID.
Definition: timezone.h:949
double UDate
Date and Time data type.
Definition: utypes.h:203
C++ API: Unicode String.
U_EXPORT UBool operator==(const StringPiece &x, const StringPiece &y)
Global operator == for StringPiece.
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition: uobject.h:93
Base class for 'pure' C++ implementations of uenum api.
Definition: strenum.h:57
EDisplayType
Enum for use with getDisplayName.
Definition: timezone.h:579
TimeZone represents a time zone offset, and also figures out daylight savings.
Definition: timezone.h:131
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside...
Definition: utypes.h:360
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:137
Selector for short display name derived from time zone offset.
Definition: timezone.h:605
virtual UClassID getDynamicClassID() const
ICU4C "poor man's RTTI", returns a UClassID for the actual ICU class.
Selector for short generic display name.
Definition: timezone.h:594
Selector for long generic display name.
Definition: timezone.h:599
Selector for long display name.
Definition: timezone.h:589
C++ API: Common ICU base class UObject.
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:138
Selector for short display name derived from the time zone's fallback name.
Definition: timezone.h:617
USystemTimeZoneType
System time zone type constants used by filtering zones in ucal_openTimeZoneIDEnumeration.
Definition: ucal.h:534
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:396
Basic definitions for ICU, for both C and C++ APIs.
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:286
struct UResourceBundle UResourceBundle
Definition: ures.h:59
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:223
Selector for long display name derived from time zone offset.
Definition: timezone.h:611
UBool operator!=(const TimeZone &that) const
Returns true if the two TimeZones are NOT equal; that is, if operator==() returns false...
Definition: timezone.h:454
C API: Resource Bundle.
int8_t UBool
The ICU boolean type.
Definition: umachine.h:236
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:188