ICU 54.1  54.1
tznames.h
Go to the documentation of this file.
1 /*
2 *******************************************************************************
3 * Copyright (C) 2011-2014, International Business Machines Corporation and
4 * others. All Rights Reserved.
5 *******************************************************************************
6 */
7 #ifndef __TZNAMES_H
8 #define __TZNAMES_H
9 
14 #include "unicode/utypes.h"
15 
16 #if !UCONFIG_NO_FORMATTING
17 
18 #include "unicode/uloc.h"
19 #include "unicode/unistr.h"
20 
22 
27 typedef enum UTimeZoneNameType {
32  UTZNM_UNKNOWN = 0x00,
69 
71 
73 
74 class UVector;
75 struct MatchInfo;
76 
128 public:
133  virtual ~TimeZoneNames();
134 
141  virtual UBool operator==(const TimeZoneNames& other) const = 0;
142 
150  UBool operator!=(const TimeZoneNames& other) const { return !operator==(other); }
151 
158  virtual TimeZoneNames* clone() const = 0;
159 
168  static TimeZoneNames* U_EXPORT2 createInstance(const Locale& locale, UErrorCode& status);
169 
170 #ifndef U_HIDE_DRAFT_API
171 
181  static TimeZoneNames* U_EXPORT2 createTZDBInstance(const Locale& locale, UErrorCode& status);
182 #endif /* U_HIDE_DRAFT_API */
183 
190  virtual StringEnumeration* getAvailableMetaZoneIDs(UErrorCode& status) const = 0;
191 
199  virtual StringEnumeration* getAvailableMetaZoneIDs(const UnicodeString& tzID, UErrorCode& status) const = 0;
200 
211  virtual UnicodeString& getMetaZoneID(const UnicodeString& tzID, UDate date, UnicodeString& mzID) const = 0;
212 
229  virtual UnicodeString& getReferenceZoneID(const UnicodeString& mzID, const char* region, UnicodeString& tzID) const = 0;
230 
241  virtual UnicodeString& getMetaZoneDisplayName(const UnicodeString& mzID, UTimeZoneNameType type, UnicodeString& name) const = 0;
242 
253  virtual UnicodeString& getTimeZoneDisplayName(const UnicodeString& tzID, UTimeZoneNameType type, UnicodeString& name) const = 0;
254 
274  virtual UnicodeString& getExemplarLocationName(const UnicodeString& tzID, UnicodeString& name) const;
275 
291  virtual UnicodeString& getDisplayName(const UnicodeString& tzID, UTimeZoneNameType type, UDate date, UnicodeString& name) const;
292 
299  public:
309  virtual ~MatchInfoCollection();
310 
311 #ifndef U_HIDE_INTERNAL_API
312 
320  void addZone(UTimeZoneNameType nameType, int32_t matchLength,
321  const UnicodeString& tzID, UErrorCode& status);
322 
331  void addMetaZone(UTimeZoneNameType nameType, int32_t matchLength,
332  const UnicodeString& mzID, UErrorCode& status);
333 
339  int32_t size() const;
340 
349  UTimeZoneNameType getNameTypeAt(int32_t idx) const;
350 
358  int32_t getMatchLengthAt(int32_t idx) const;
359 
367  UBool getTimeZoneIDAt(int32_t idx, UnicodeString& tzID) const;
368 
376  UBool getMetaZoneIDAt(int32_t idx, UnicodeString& mzID) const;
377 #endif /* U_HIDE_INTERNAL_API */
378 
379  private:
380  UVector* fMatches; // vector of MatchEntry
381 
382  UVector* matches(UErrorCode& status);
383  };
384 
398  virtual MatchInfoCollection* find(const UnicodeString& text, int32_t start, uint32_t types, UErrorCode& status) const = 0;
399 };
400 
402 
403 #endif
404 #endif
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.
Base class for 'pure' C++ implementations of uenum api.
Definition: strenum.h:55
Long display name, such as "Eastern Time".
Definition: tznames.h:37
#define U_CDECL_BEGIN
This is used to begin a declaration of a library private ICU C API.
Definition: umachine.h:82
Short display name, such as "ET".
Definition: tznames.h:52
#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
MatchInfoCollection represents a collection of time zone name matches used by TimeZoneNames#find.
Definition: tznames.h:298
Long display name for standard time, such as "Eastern Standard Time".
Definition: tznames.h:42
Short display name for standard time, such as "EST".
Definition: tznames.h:57
TimeZoneNames is an abstract class representing the time zone display name data model defined by UTS#...
Definition: tznames.h:127
UBool operator!=(const TimeZoneNames &other) const
Return true if the given TimeZoneNames objects are not semantically equal.
Definition: tznames.h:150
#define U_CDECL_END
This is used to end a declaration of a library private ICU C API.
Definition: umachine.h:83
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:130
Unknown display name type.
Definition: tznames.h:32
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:476
Exemplar location name, such as "Los Angeles".
Definition: tznames.h:67
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:245
Long display name for daylight saving time, such as "Eastern Daylight Time".
Definition: tznames.h:47
UTimeZoneNameType
Constants for time zone display name types.
Definition: tznames.h:27
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:221
UMemory is the common ICU base class.
Definition: uobject.h:110
int8_t UBool
The ICU boolean type.
Definition: umachine.h:234
C API: Locale.
Short display name for daylight saving time, such as "EDT".
Definition: tznames.h:62
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:185