ICU 50.1.2  50.1.2
tznames.h
Go to the documentation of this file.
1 /*
2 *******************************************************************************
3 * Copyright (C) 2011-2012, 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 #ifndef U_HIDE_INTERNAL_API
18 
19 #include "unicode/uloc.h"
20 #include "unicode/unistr.h"
21 
23 
28 typedef enum UTimeZoneNameType {
33  UTZNM_UNKNOWN = 0x00,
65 
67 
69 
70 class UVector;
71 struct MatchInfo;
72 
117 public:
122  virtual ~TimeZoneNames();
123 
130  virtual UBool operator==(const TimeZoneNames& other) const = 0;
131 
139  UBool operator!=(const TimeZoneNames& other) const { return !operator==(other); }
140 
147  virtual TimeZoneNames* clone() const = 0;
148 
157  static TimeZoneNames* U_EXPORT2 createInstance(const Locale& locale, UErrorCode& status);
158 
165  virtual StringEnumeration* getAvailableMetaZoneIDs(UErrorCode& status) const = 0;
166 
174  virtual StringEnumeration* getAvailableMetaZoneIDs(const UnicodeString& tzID, UErrorCode& status) const = 0;
175 
186  virtual UnicodeString& getMetaZoneID(const UnicodeString& tzID, UDate date, UnicodeString& mzID) const = 0;
187 
198  virtual UnicodeString& getReferenceZoneID(const UnicodeString& mzID, const char* region, UnicodeString& tzID) const = 0;
199 
210  virtual UnicodeString& getMetaZoneDisplayName(const UnicodeString& mzID, UTimeZoneNameType type, UnicodeString& name) const = 0;
211 
222  virtual UnicodeString& getTimeZoneDisplayName(const UnicodeString& tzID, UTimeZoneNameType type, UnicodeString& name) const = 0;
223 
243  virtual UnicodeString& getExemplarLocationName(const UnicodeString& tzID, UnicodeString& name) const;
244 
260  virtual UnicodeString& getDisplayName(const UnicodeString& tzID, UTimeZoneNameType type, UDate date, UnicodeString& name) const;
261 
268  public:
278  virtual ~MatchInfoCollection();
279 
288  void addZone(UTimeZoneNameType nameType, int32_t matchLength,
289  const UnicodeString& tzID, UErrorCode& status);
290 
299  void addMetaZone(UTimeZoneNameType nameType, int32_t matchLength,
300  const UnicodeString& mzID, UErrorCode& status);
301 
307  int32_t size() const;
308 
317  UTimeZoneNameType getNameTypeAt(int32_t idx) const;
318 
326  int32_t getMatchLengthAt(int32_t idx) const;
327 
335  UBool getTimeZoneIDAt(int32_t idx, UnicodeString& tzID) const;
336 
344  UBool getMetaZoneIDAt(int32_t idx, UnicodeString& mzID) const;
345 
346  private:
347  UVector* fMatches; // vector of MatchEntry
348 
349  UVector* matches(UErrorCode& status);
350  };
351 
365  virtual MatchInfoCollection* find(const UnicodeString& text, int32_t start, uint32_t types, UErrorCode& status) const = 0;
366 
367 private:
368  // No ICU "poor man's RTTI" for this class nor its subclasses.
369  virtual UClassID getDynamicClassID() const;
370 };
371 
373 
374 #endif /* U_HIDE_INTERNAL_API */
375 #endif
376 #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.
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition: uobject.h:96
Base class for 'pure' C++ implementations of uenum api.
Definition: strenum.h:55
Long display name, such as "Eastern Time".
Definition: tznames.h:38
#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:53
#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:267
Long display name for standard time, such as "Eastern Standard Time".
Definition: tznames.h:43
Short display name for standard time, such as "EST".
Definition: tznames.h:58
TimeZoneNames is an abstract class representing the time zone display name data model defined by UTS#...
Definition: tznames.h:116
UBool operator!=(const TimeZoneNames &other) const
Return true if the given TimeZoneNames objects are not semantically equal.
Definition: tznames.h:139
#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:33
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:246
Long display name for daylight saving time, such as "Eastern Daylight Time".
Definition: tznames.h:48
UTimeZoneNameType
Constants for time zone display name types.
Definition: tznames.h:28
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:229
UMemory is the common ICU base class.
Definition: uobject.h:115
int8_t UBool
The ICU boolean type.
Definition: umachine.h:200
C API: Locale.
Short display name for daylight saving time, such as "EDT".
Definition: tznames.h:63
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:182