ICU 57.1  57.1
timezone.h
Go to the documentation of this file.
1 /*************************************************************************
2 * Copyright (c) 1997-2016, International Business Machines Corporation
3 * and others. All Rights Reserved.
4 **************************************************************************
5 *
6 * File TIMEZONE.H
7 *
8 * Modification History:
9 *
10 * Date Name Description
11 * 04/21/97 aliu Overhauled header.
12 * 07/09/97 helena Changed createInstance to createDefault.
13 * 08/06/97 aliu Removed dependency on internal header for Hashtable.
14 * 08/10/98 stephen Changed getDisplayName() API conventions to match
15 * 08/19/98 stephen Changed createTimeZone() to never return 0
16 * 09/02/98 stephen Sync to JDK 1.2 8/31
17 * - Added getOffset(... monthlen ...)
18 * - Added hasSameRules()
19 * 09/15/98 stephen Added getStaticClassID
20 * 12/03/99 aliu Moved data out of static table into icudata.dll.
21 * Hashtable replaced by new static data structures.
22 * 12/14/99 aliu Made GMT public.
23 * 08/15/01 grhoten Made GMT private and added the getGMT() function
24 **************************************************************************
25 */
26 
27 #ifndef TIMEZONE_H
28 #define TIMEZONE_H
29 
30 #include "unicode/utypes.h"
31 
37 #if !UCONFIG_NO_FORMATTING
38 
39 #include "unicode/uobject.h"
40 #include "unicode/unistr.h"
41 #include "unicode/ures.h"
42 #include "unicode/ucal.h"
43 
45 
46 class StringEnumeration;
47 
129 class U_I18N_API TimeZone : public UObject {
130 public:
134  virtual ~TimeZone();
135 
148  static const TimeZone& U_EXPORT2 getUnknown();
149 
162  static const TimeZone* U_EXPORT2 getGMT(void);
163 
175  static TimeZone* U_EXPORT2 createTimeZone(const UnicodeString& ID);
176 
192  static StringEnumeration* U_EXPORT2 createTimeZoneIDEnumeration(
193  USystemTimeZoneType zoneType,
194  const char* region,
195  const int32_t* rawOffset,
196  UErrorCode& ec);
197 
205  static StringEnumeration* U_EXPORT2 createEnumeration();
206 
224  static StringEnumeration* U_EXPORT2 createEnumeration(int32_t rawOffset);
225 
236  static StringEnumeration* U_EXPORT2 createEnumeration(const char* country);
237 
252  static int32_t U_EXPORT2 countEquivalentIDs(const UnicodeString& id);
253 
273  static const UnicodeString U_EXPORT2 getEquivalentID(const UnicodeString& id,
274  int32_t index);
275 
289  static TimeZone* U_EXPORT2 detectHostTimeZone();
290 
303  static TimeZone* U_EXPORT2 createDefault(void);
304 
318  static void U_EXPORT2 adoptDefault(TimeZone* zone);
319 
320 #ifndef U_HIDE_SYSTEM_API
321 
331  static void U_EXPORT2 setDefault(const TimeZone& zone);
332 #endif /* U_HIDE_SYSTEM_API */
333 
340  static const char* U_EXPORT2 getTZDataVersion(UErrorCode& status);
341 
355  static UnicodeString& U_EXPORT2 getCanonicalID(const UnicodeString& id,
356  UnicodeString& canonicalID, UErrorCode& status);
357 
373  static UnicodeString& U_EXPORT2 getCanonicalID(const UnicodeString& id,
374  UnicodeString& canonicalID, UBool& isSystemID, UErrorCode& status);
375 
398  static UnicodeString& U_EXPORT2 getWindowsID(const UnicodeString& id,
399  UnicodeString& winid, UErrorCode& status);
400 
427  static UnicodeString& U_EXPORT2 getIDForWindowsID(const UnicodeString& winid, const char* region,
428  UnicodeString& id, UErrorCode& status);
429 
439  virtual UBool operator==(const TimeZone& that) const;
440 
450  UBool operator!=(const TimeZone& that) const {return !operator==(that);}
451 
476  virtual int32_t getOffset(uint8_t era, int32_t year, int32_t month, int32_t day,
477  uint8_t dayOfWeek, int32_t millis, UErrorCode& status) const = 0;
478 
499  virtual int32_t getOffset(uint8_t era, int32_t year, int32_t month, int32_t day,
500  uint8_t dayOfWeek, int32_t milliseconds,
501  int32_t monthLength, UErrorCode& status) const = 0;
502 
526  virtual void getOffset(UDate date, UBool local, int32_t& rawOffset,
527  int32_t& dstOffset, UErrorCode& ec) const;
528 
536  virtual void setRawOffset(int32_t offsetMillis) = 0;
537 
545  virtual int32_t getRawOffset(void) const = 0;
546 
554  UnicodeString& getID(UnicodeString& ID) const;
555 
569  void setID(const UnicodeString& ID);
570 
580  SHORT = 1,
619  GENERIC_LOCATION
620  };
621 
633  UnicodeString& getDisplayName(UnicodeString& result) const;
634 
648  UnicodeString& getDisplayName(const Locale& locale, UnicodeString& result) const;
649 
662  UnicodeString& getDisplayName(UBool daylight, EDisplayType style, UnicodeString& result) const;
663 
678  UnicodeString& getDisplayName(UBool daylight, EDisplayType style, const Locale& locale, UnicodeString& result) const;
679 
714  virtual UBool useDaylightTime(void) const = 0;
715 
729  virtual UBool inDaylightTime(UDate date, UErrorCode& status) const = 0;
730 
739  virtual UBool hasSameRules(const TimeZone& other) const;
740 
748  virtual TimeZone* clone(void) const = 0;
749 
756  static UClassID U_EXPORT2 getStaticClassID(void);
757 
769  virtual UClassID getDynamicClassID(void) const = 0;
770 
786  virtual int32_t getDSTSavings() const;
787 
805  static int32_t U_EXPORT2 getRegion(const UnicodeString& id,
806  char *region, int32_t capacity, UErrorCode& status);
807 
808 protected:
809 
814  TimeZone();
815 
821  TimeZone(const UnicodeString &id);
822 
828  TimeZone(const TimeZone& source);
829 
835  TimeZone& operator=(const TimeZone& right);
836 
837 #ifndef U_HIDE_INTERNAL_API
838 
847  static UResourceBundle* loadRule(const UResourceBundle* top, const UnicodeString& ruleid, UResourceBundle* oldbundle, UErrorCode&status);
848 #endif /* U_HIDE_INTERNAL_API */
849 
850 private:
851  friend class ZoneMeta;
852 
853 
854  static TimeZone* createCustomTimeZone(const UnicodeString&); // Creates a time zone based on the string.
855 
864  static const UChar* findID(const UnicodeString& id);
865 
874  static const UChar* dereferOlsonLink(const UnicodeString& id);
875 
882  static const UChar* getRegion(const UnicodeString& id);
883 
884  public:
885 #ifndef U_HIDE_INTERNAL_API
886 
894  static const UChar* getRegion(const UnicodeString& id, UErrorCode& status);
895 #endif /* U_HIDE_INTERNAL_API */
896 
897  private:
908  static UBool parseCustomID(const UnicodeString& id, int32_t& sign, int32_t& hour,
909  int32_t& minute, int32_t& second);
910 
921  static UnicodeString& getCustomID(const UnicodeString& id, UnicodeString& normalized,
922  UErrorCode& status);
923 
933  static UnicodeString& formatCustomID(int32_t hour, int32_t min, int32_t sec,
934  UBool negative, UnicodeString& id);
935 
936  UnicodeString fID; // this time zone's ID
937 
938  friend class TZEnumeration;
939 };
940 
941 
942 // -------------------------------------
943 
944 inline UnicodeString&
946 {
947  ID = fID;
948  return ID;
949 }
950 
951 // -------------------------------------
952 
953 inline void
955 {
956  fID = ID;
957 }
959 
960 #endif /* #if !UCONFIG_NO_FORMATTING */
961 
962 #endif //_TIMEZONE
963 //eof
void setID(const UnicodeString &ID)
Sets the TimeZone's ID to the specified value.
Definition: timezone.h:954
C API: Calendar.
UnicodeString & getID(UnicodeString &ID) const
Fills in "ID" with the TimeZone's ID.
Definition: timezone.h:945
double UDate
Date and Time data type.
Definition: utypes.h:201
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:91
Base class for 'pure' C++ implementations of uenum api.
Definition: strenum.h:55
EDisplayType
Enum for use with getDisplayName.
Definition: timezone.h:575
TimeZone represents a time zone offset, and also figures out daylight savings.
Definition: timezone.h:129
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside...
Definition: utypes.h:358
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:129
Selector for short display name derived from time zone offset.
Definition: timezone.h:601
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:590
Selector for long generic display name.
Definition: timezone.h:595
Selector for long display name.
Definition: timezone.h:585
C++ API: Common ICU base class UObject.
uint16_t UChar
Define UChar to be UCHAR_TYPE, if that is #defined (for example, to char16_t), or wchar_t if that is ...
Definition: umachine.h:312
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:130
Selector for short display name derived from the time zone's fallback name.
Definition: timezone.h:613
USystemTimeZoneType
System time zone type constants used by filtering zones in ucal_openTimeZoneIDEnumeration.
Definition: ucal.h:530
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:476
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:293
struct UResourceBundle UResourceBundle
Definition: ures.h:57
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:221
Selector for long display name derived from time zone offset.
Definition: timezone.h:607
UBool operator!=(const TimeZone &that) const
Returns true if the two TimeZones are NOT equal; that is, if operator==() returns false...
Definition: timezone.h:450
C API: Resource Bundle.
int8_t UBool
The ICU boolean type.
Definition: umachine.h:234
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:185