ICU 62.1 62.1
region.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) 2014-2016, International Business Machines Corporation and others.
6 * All Rights Reserved.
7 *******************************************************************************
8 */
9
10#ifndef REGION_H
11#define REGION_H
12
18#include "unicode/utypes.h"
19#include "unicode/uregion.h"
20
21#if !UCONFIG_NO_FORMATTING
22
23#include "unicode/uobject.h"
24#include "unicode/uniset.h"
25#include "unicode/unistr.h"
26#include "unicode/strenum.h"
27
29
70class U_I18N_API Region : public UObject {
71public:
76 virtual ~Region();
77
82 UBool operator==(const Region &that) const;
83
88 UBool operator!=(const Region &that) const;
89
98
104 static const Region* U_EXPORT2 getInstance (int32_t code, UErrorCode &status);
105
111
119
129
140
149
154 UBool contains(const Region &other) const;
155
163
168 const char* getRegionCode() const;
169
175 int32_t getNumericCode() const;
176
182
183#ifndef U_HIDE_INTERNAL_API
188 static void cleanupRegionData();
189#endif /* U_HIDE_INTERNAL_API */
190
191private:
192 char id[4];
193 UnicodeString idStr;
194 int32_t code;
195 URegionType type;
196 Region *containingRegion;
197 UVector *containedRegions;
198 UVector *preferredValues;
199
203 Region();
204
205
206 /*
207 * Initializes the region data from the ICU resource bundles. The region data
208 * contains the basic relationships such as which regions are known, what the numeric
209 * codes are, any known aliases, and the territory containment data.
210 *
211 * If the region data has already loaded, then this method simply returns without doing
212 * anything meaningful.
213 */
214
215 static void U_CALLCONV loadRegionData(UErrorCode &status);
216
217};
218
220
221#endif /* #if !UCONFIG_NO_FORMATTING */
222#endif // REGION_H
223
224//eof
"Smart pointer" base class; do not use directly: use LocalPointer etc.
Region is the class representing a Unicode Region Code, also known as a Unicode Region Subtag,...
Definition region.h:70
StringEnumeration * getContainedRegions(URegionType type, UErrorCode &status) const
Returns an enumeration over the IDs of all the regions that are children of this region anywhere in t...
static const Region * getInstance(int32_t code, UErrorCode &status)
Returns a pointer to a Region using the given numeric region code.
const Region * getContainingRegion() const
Returns a pointer to the region that contains this region.
static const Region * getInstance(const char *region_code, UErrorCode &status)
Returns a pointer to a Region using the given region code.
UBool operator==(const Region &that) const
Returns true if the two regions are equal.
static void cleanupRegionData()
Cleans up statically allocated memory.
const Region * getContainingRegion(URegionType type) const
Return a pointer to the region that geographically contains this region and matches the given type,...
StringEnumeration * getContainedRegions(UErrorCode &status) const
Return an enumeration over the IDs of all the regions that are immediate children of this region in t...
virtual ~Region()
Destructor.
URegionType getType() const
Returns the region type of this region.
const char * getRegionCode() const
Return this region's canonical region code.
UBool contains(const Region &other) const
Returns true if this region contains the supplied other region anywhere in the region hierarchy.
UBool operator!=(const Region &that) const
Returns true if the two regions are NOT equal; that is, if operator ==() returns false.
StringEnumeration * getPreferredValues(UErrorCode &status) const
For deprecated regions, return an enumeration over the IDs of the regions that are the preferred repl...
static StringEnumeration * getAvailable(URegionType type, UErrorCode &status)
Returns an enumeration over the IDs of all known regions that match the given type.
int32_t getNumericCode() const
Return this region's numeric code.
Base class for 'pure' C++ implementations of uenum api.
Definition strenum.h:57
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:287
#define U_CALLCONV
Similar to U_CDECL_BEGIN/U_CDECL_END, this qualifier is necessary in callback function typedefs to ma...
Definition platform.h:835
C++ API: String Enumeration.
int8_t UBool
The ICU boolean type.
Definition umachine.h:236
C++ API: Unicode Set.
C++ API: Unicode String.
C++ API: Common ICU base class UObject.
C API: URegion (territory containment and mapping)
URegionType
URegionType is an enumeration defining the different types of regions.
Definition uregion.h:65
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers,...
Definition utypes.h:396
#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_END
This is used to end a declaration of a public ICU C++ API.
Definition uversion.h:138
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition uversion.h:137