ICU 70.1  70.1
tznames.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 *******************************************************************************
5 * Copyright (C) 2011-2016, International Business Machines Corporation and
6 * others. All Rights Reserved.
7 *******************************************************************************
8 */
9 #ifndef __TZNAMES_H
10 #define __TZNAMES_H
11 
16 #include "unicode/utypes.h"
17 
18 #if U_SHOW_CPLUSPLUS_API
19 
20 #if !UCONFIG_NO_FORMATTING
21 
22 #include "unicode/uloc.h"
23 #include "unicode/unistr.h"
24 
26 
31 typedef enum UTimeZoneNameType {
36  UTZNM_UNKNOWN = 0x00,
73 
75 
76 U_NAMESPACE_BEGIN
77 
78 class UVector;
79 struct MatchInfo;
80 
132 public:
137  virtual ~TimeZoneNames();
138 
145  virtual bool operator==(const TimeZoneNames& other) const = 0;
146 
154  bool operator!=(const TimeZoneNames& other) const { return !operator==(other); }
155 
162  virtual TimeZoneNames* clone() const = 0;
163 
172  static TimeZoneNames* U_EXPORT2 createInstance(const Locale& locale, UErrorCode& status);
173 
184  static TimeZoneNames* U_EXPORT2 createTZDBInstance(const Locale& locale, UErrorCode& status);
185 
193 
201  virtual StringEnumeration* getAvailableMetaZoneIDs(const UnicodeString& tzID, UErrorCode& status) const = 0;
202 
213  virtual UnicodeString& getMetaZoneID(const UnicodeString& tzID, UDate date, UnicodeString& mzID) const = 0;
214 
231  virtual UnicodeString& getReferenceZoneID(const UnicodeString& mzID, const char* region, UnicodeString& tzID) const = 0;
232 
244 
256 
277 
293  virtual UnicodeString& getDisplayName(const UnicodeString& tzID, UTimeZoneNameType type, UDate date, UnicodeString& name) const;
294 
298  virtual void loadAllDisplayNames(UErrorCode& status);
299 
303  virtual void getDisplayNames(const UnicodeString& tzID, const UTimeZoneNameType types[], int32_t numTypes, UDate date, UnicodeString dest[], UErrorCode& status) const;
304 
311  public:
322 
323 #ifndef U_HIDE_INTERNAL_API
332  void addZone(UTimeZoneNameType nameType, int32_t matchLength,
333  const UnicodeString& tzID, UErrorCode& status);
334 
343  void addMetaZone(UTimeZoneNameType nameType, int32_t matchLength,
344  const UnicodeString& mzID, UErrorCode& status);
345 
351  int32_t size() const;
352 
361  UTimeZoneNameType getNameTypeAt(int32_t idx) const;
362 
370  int32_t getMatchLengthAt(int32_t idx) const;
371 
379  UBool getTimeZoneIDAt(int32_t idx, UnicodeString& tzID) const;
380 
388  UBool getMetaZoneIDAt(int32_t idx, UnicodeString& mzID) const;
389 #endif /* U_HIDE_INTERNAL_API */
390 
391  private:
392  UVector* fMatches; // vector of MatchEntry
393 
394  UVector* matches(UErrorCode& status);
395  };
396 
410  virtual MatchInfoCollection* find(const UnicodeString& text, int32_t start, uint32_t types, UErrorCode& status) const = 0;
411 };
412 
413 U_NAMESPACE_END
414 
415 #endif
416 
417 #endif /* U_SHOW_CPLUSPLUS_API */
418 
419 #endif
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:195
Base class for 'pure' C++ implementations of uenum api.
Definition: strenum.h:61
MatchInfoCollection represents a collection of time zone name matches used by TimeZoneNames#find.
Definition: tznames.h:310
void addMetaZone(UTimeZoneNameType nameType, int32_t matchLength, const UnicodeString &mzID, UErrorCode &status)
Adds a meata zone match.
void addZone(UTimeZoneNameType nameType, int32_t matchLength, const UnicodeString &tzID, UErrorCode &status)
Adds a zone match.
UTimeZoneNameType getNameTypeAt(int32_t idx) const
Returns the time zone name type of a match at the specified index.
virtual ~MatchInfoCollection()
Destructor.
int32_t getMatchLengthAt(int32_t idx) const
Returns the match length of a match at the specified index.
UBool getTimeZoneIDAt(int32_t idx, UnicodeString &tzID) const
Gets the zone ID of a match at the specified index.
UBool getMetaZoneIDAt(int32_t idx, UnicodeString &mzID) const
Gets the metazone ID of a match at the specified index.
int32_t size() const
Returns the number of entries available in this object.
TimeZoneNames is an abstract class representing the time zone display name data model defined by UTS#...
Definition: tznames.h:131
virtual TimeZoneNames * clone() const =0
Clone this object polymorphically.
virtual UnicodeString & getExemplarLocationName(const UnicodeString &tzID, UnicodeString &name) const
Returns the exemplar location name for the given time zone.
virtual UnicodeString & getMetaZoneID(const UnicodeString &tzID, UDate date, UnicodeString &mzID) const =0
Returns the meta zone ID for the given canonical time zone ID at the given date.
static TimeZoneNames * createTZDBInstance(const Locale &locale, UErrorCode &status)
Returns an instance of TimeZoneNames containing only short specific zone names (SHORT_STANDARD and SH...
virtual MatchInfoCollection * find(const UnicodeString &text, int32_t start, uint32_t types, UErrorCode &status) const =0
Finds time zone name prefix matches for the input text at the given offset and returns a collection o...
virtual void loadAllDisplayNames(UErrorCode &status)
virtual UnicodeString & getDisplayName(const UnicodeString &tzID, UTimeZoneNameType type, UDate date, UnicodeString &name) const
Returns the display name of the time zone at the given date.
virtual UnicodeString & getTimeZoneDisplayName(const UnicodeString &tzID, UTimeZoneNameType type, UnicodeString &name) const =0
Returns the display name of the time zone.
virtual void getDisplayNames(const UnicodeString &tzID, const UTimeZoneNameType types[], int32_t numTypes, UDate date, UnicodeString dest[], UErrorCode &status) const
virtual ~TimeZoneNames()
Destructor.
virtual StringEnumeration * getAvailableMetaZoneIDs(const UnicodeString &tzID, UErrorCode &status) const =0
Returns an enumeration of all available meta zone IDs used by the given time zone.
bool operator!=(const TimeZoneNames &other) const
Return true if the given TimeZoneNames objects are not semantically equal.
Definition: tznames.h:154
virtual UnicodeString & getReferenceZoneID(const UnicodeString &mzID, const char *region, UnicodeString &tzID) const =0
Returns the reference zone ID for the given meta zone ID for the region.
virtual UnicodeString & getMetaZoneDisplayName(const UnicodeString &mzID, UTimeZoneNameType type, UnicodeString &name) const =0
Returns the display name of the meta zone.
virtual bool operator==(const TimeZoneNames &other) const =0
Return true if the given TimeZoneNames objects are semantically equal.
virtual StringEnumeration * getAvailableMetaZoneIDs(UErrorCode &status) const =0
Returns an enumeration of all available meta zone IDs.
static TimeZoneNames * createInstance(const Locale &locale, UErrorCode &status)
Returns an instance of TimeZoneNames for the specified locale.
UMemory is the common ICU base class.
Definition: uobject.h:115
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:223
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:296
U_EXPORT UBool operator==(const StringPiece &x, const StringPiece &y)
Global operator == for StringPiece.
UTimeZoneNameType
Constants for time zone display name types.
Definition: tznames.h:31
@ UTZNM_SHORT_STANDARD
Short display name for standard time, such as "EST".
Definition: tznames.h:61
@ UTZNM_LONG_GENERIC
Long display name, such as "Eastern Time".
Definition: tznames.h:41
@ UTZNM_SHORT_DAYLIGHT
Short display name for daylight saving time, such as "EDT".
Definition: tznames.h:66
@ UTZNM_LONG_DAYLIGHT
Long display name for daylight saving time, such as "Eastern Daylight Time".
Definition: tznames.h:51
@ UTZNM_SHORT_GENERIC
Short display name, such as "ET".
Definition: tznames.h:56
@ UTZNM_EXEMPLAR_LOCATION
Exemplar location name, such as "Los Angeles".
Definition: tznames.h:71
@ UTZNM_LONG_STANDARD
Long display name for standard time, such as "Eastern Standard Time".
Definition: tznames.h:46
@ UTZNM_UNKNOWN
Unknown display name type.
Definition: tznames.h:36
C API: Locale.
#define U_CDECL_END
This is used to end a declaration of a library private ICU C API.
Definition: umachine.h:86
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition: umachine.h:269
#define U_CDECL_BEGIN
This is used to begin a declaration of a library private ICU C API.
Definition: umachine.h:85
C++ API: Unicode String.
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside.
Definition: utypes.h:301
double UDate
Date and Time data type.
Definition: utypes.h:203