// © 2016 and later: Unicode, Inc. and others. // License & terms of use: http://www.unicode.org/copyright.html /* ******************************************************************************* * Copyright (C) 2014-2016, International Business Machines Corporation and others. * All Rights Reserved. ******************************************************************************* */ #ifndef REGION_H #define REGION_H /** * \file * \brief C++ API: Region classes (territory containment) */ #include "unicode/utypes.h" #if U_SHOW_CPLUSPLUS_API #if !UCONFIG_NO_FORMATTING #include "unicode/uregion.h" #include "unicode/uobject.h" #include "unicode/uniset.h" #include "unicode/unistr.h" #include "unicode/strenum.h" U_NAMESPACE_BEGIN /** * <code>Region</code> is the class representing a Unicode Region Code, also known as a * Unicode Region Subtag, which is defined based upon the BCP 47 standard. We often think of * "regions" as "countries" when defining the characteristics of a locale. Region codes There are different * types of region codes that are important to distinguish. * <p> * Macroregion - A code for a "macro geographical (continental) region, geographical sub-region, or * selected economic and other grouping" as defined in * UN M.49 (http://unstats.un.org/unsd/methods/m49/m49regin.htm). * These are typically 3-digit codes, but contain some 2-letter codes, such as the LDML code QO * added for Outlying Oceania. Not all UNM.49 codes are defined in LDML, but most of them are. * Macroregions are represented in ICU by one of three region types: WORLD ( region code 001 ), * CONTINENTS ( regions contained directly by WORLD ), and SUBCONTINENTS ( things contained directly * by a continent ). * <p> * TERRITORY - A Region that is not a Macroregion. These are typically codes for countries, but also * include areas that are not separate countries, such as the code "AQ" for Antarctica or the code * "HK" for Hong Kong (SAR China). Overseas dependencies of countries may or may not have separate * codes. The codes are typically 2-letter codes aligned with the ISO 3166 standard, but BCP47 allows * for the use of 3-digit codes in the future. * <p> * UNKNOWN - The code ZZ is defined by Unicode LDML for use to indicate that the Region is unknown, * or that the value supplied as a region was invalid. * <p> * DEPRECATED - Region codes that have been defined in the past but are no longer in modern usage, * usually due to a country splitting into multiple territories or changing its name. * <p> * GROUPING - A widely understood grouping of territories that has a well defined membership such * that a region code has been assigned for it. Some of these are UNM.49 codes that do't fall into * the world/continent/sub-continent hierarchy, while others are just well known groupings that have * their own region code. Region "EU" (European Union) is one such region code that is a grouping. * Groupings will never be returned by the getContainingRegion() API, since a different type of region * ( WORLD, CONTINENT, or SUBCONTINENT ) will always be the containing region instead. * * The Region class is not intended for public subclassing. * * @author John Emmons * @stable ICU 51 */ class U_I18N_API Region : public UObject { public: /** * Destructor. * @stable ICU 51 */ virtual ~Region(); /** * Returns true if the two regions are equal. * @stable ICU 51 */ UBool operator==(const Region &that) const; /** * Returns true if the two regions are NOT equal; that is, if operator ==() returns false. * @stable ICU 51 */ UBool operator!=(const Region &that) const; /** * Returns a pointer to a Region using the given region code. The region code can be either 2-letter ISO code, * 3-letter ISO code, UNM.49 numeric code, or other valid Unicode Region Code as defined by the LDML specification. * The identifier will be canonicalized internally using the supplemental metadata as defined in the CLDR. * If the region code is NULL or not recognized, the appropriate error code will be set ( U_ILLEGAL_ARGUMENT_ERROR ) * @stable ICU 51 */ static const Region* U_EXPORT2 getInstance(const char *region_code, UErrorCode &status); /** * Returns a pointer to a Region using the given numeric region code. If the numeric region code is not recognized, * the appropriate error code will be set ( U_ILLEGAL_ARGUMENT_ERROR ). * @stable ICU 51 */ static const Region* U_EXPORT2 getInstance (int32_t code, UErrorCode &status); /** * Returns an enumeration over the IDs of all known regions that match the given type. * @stable ICU 55 */ static StringEnumeration* U_EXPORT2 getAvailable(URegionType type, UErrorCode &status); /** * Returns a pointer to the region that contains this region. Returns NULL if this region is code "001" (World) * or "ZZ" (Unknown region). For example, calling this method with region "IT" (Italy) returns the * region "039" (Southern Europe). * @stable ICU 51 */ const Region* getContainingRegion() const; /** * Return a pointer to the region that geographically contains this region and matches the given type, * moving multiple steps up the containment chain if necessary. Returns NULL if no containing region can be found * that matches the given type. Note: The URegionTypes = "URGN_GROUPING", "URGN_DEPRECATED", or "URGN_UNKNOWN" * are not appropriate for use in this API. NULL will be returned in this case. For example, calling this method * with region "IT" (Italy) for type "URGN_CONTINENT" returns the region "150" ( Europe ). * @stable ICU 51 */ const Region* getContainingRegion(URegionType type) const; /** * Return an enumeration over the IDs of all the regions that are immediate children of this region in the * region hierarchy. These returned regions could be either macro regions, territories, or a mixture of the two, * depending on the containment data as defined in CLDR. This API may return NULL if this region doesn't have * any sub-regions. For example, calling this method with region "150" (Europe) returns an enumeration containing * the various sub regions of Europe - "039" (Southern Europe) - "151" (Eastern Europe) - "154" (Northern Europe) * and "155" (Western Europe). * @stable ICU 55 */ StringEnumeration* getContainedRegions(UErrorCode &status) const; /** * Returns an enumeration over the IDs of all the regions that are children of this region anywhere in the region * hierarchy and match the given type. This API may return an empty enumeration if this region doesn't have any * sub-regions that match the given type. For example, calling this method with region "150" (Europe) and type * "URGN_TERRITORY" returns a set containing all the territories in Europe ( "FR" (France) - "IT" (Italy) - "DE" (Germany) etc. ) * @stable ICU 55 */ StringEnumeration* getContainedRegions( URegionType type, UErrorCode &status ) const; /** * Returns true if this region contains the supplied other region anywhere in the region hierarchy. * @stable ICU 51 */ UBool contains(const Region &other) const; /** * For deprecated regions, return an enumeration over the IDs of the regions that are the preferred replacement * regions for this region. Returns null for a non-deprecated region. For example, calling this method with region * "SU" (Soviet Union) would return a list of the regions containing "RU" (Russia), "AM" (Armenia), "AZ" (Azerbaijan), etc... * @stable ICU 55 */ StringEnumeration* getPreferredValues(UErrorCode &status) const; /** * Return this region's canonical region code. * @stable ICU 51 */ const char* getRegionCode() const; /** * Return this region's numeric code. * Returns a negative value if the given region does not have a numeric code assigned to it. * @stable ICU 51 */ int32_t getNumericCode() const; /** * Returns the region type of this region. * @stable ICU 51 */ URegionType getType() const; #ifndef U_HIDE_INTERNAL_API /** * Cleans up statically allocated memory. * @internal */ static void cleanupRegionData(); #endif /* U_HIDE_INTERNAL_API */ private: char id[4]; UnicodeString idStr; int32_t code; URegionType fType; Region *containingRegion; UVector *containedRegions; UVector *preferredValues; /** * Default Constructor. Internal - use factory methods only. */ Region(); /* * Initializes the region data from the ICU resource bundles. The region data * contains the basic relationships such as which regions are known, what the numeric * codes are, any known aliases, and the territory containment data. * * If the region data has already loaded, then this method simply returns without doing * anything meaningful. */ static void U_CALLCONV loadRegionData(UErrorCode &status); }; U_NAMESPACE_END #endif /* #if !UCONFIG_NO_FORMATTING */ #endif /* U_SHOW_CPLUSPLUS_API */ #endif // REGION_H //eof
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
alphaindex.h | File | 26.48 KB | 0644 |
|
appendable.h | File | 8.49 KB | 0644 |
|
basictz.h | File | 9.15 KB | 0644 |
|
brkiter.h | File | 27.8 KB | 0644 |
|
bytestream.h | File | 9.6 KB | 0644 |
|
bytestrie.h | File | 20.77 KB | 0644 |
|
bytestriebuilder.h | File | 7.08 KB | 0644 |
|
calendar.h | File | 105.74 KB | 0644 |
|
caniter.h | File | 7.43 KB | 0644 |
|
casemap.h | File | 25.33 KB | 0644 |
|
char16ptr.h | File | 7.22 KB | 0644 |
|
chariter.h | File | 24.05 KB | 0644 |
|
choicfmt.h | File | 23.91 KB | 0644 |
|
coleitr.h | File | 13.76 KB | 0644 |
|
coll.h | File | 56.23 KB | 0644 |
|
compactdecimalformat.h | File | 6.88 KB | 0644 |
|
curramt.h | File | 3.76 KB | 0644 |
|
currpinf.h | File | 7.3 KB | 0644 |
|
currunit.h | File | 4.05 KB | 0644 |
|
datefmt.h | File | 40.67 KB | 0644 |
|
dbbi.h | File | 1.19 KB | 0644 |
|
dcfmtsym.h | File | 20.13 KB | 0644 |
|
decimfmt.h | File | 87.38 KB | 0644 |
|
docmain.h | File | 6.97 KB | 0644 |
|
dtfmtsym.h | File | 37.7 KB | 0644 |
|
dtintrv.h | File | 3.84 KB | 0644 |
|
dtitvfmt.h | File | 46.63 KB | 0644 |
|
dtitvinf.h | File | 18.51 KB | 0644 |
|
dtptngen.h | File | 25.08 KB | 0644 |
|
dtrule.h | File | 8.68 KB | 0644 |
|
edits.h | File | 20.74 KB | 0644 |
|
enumset.h | File | 2.08 KB | 0644 |
|
errorcode.h | File | 4.84 KB | 0644 |
|
fieldpos.h | File | 8.69 KB | 0644 |
|
filteredbrk.h | File | 5.37 KB | 0644 |
|
fmtable.h | File | 24.42 KB | 0644 |
|
format.h | File | 12.5 KB | 0644 |
|
formattedvalue.h | File | 10.27 KB | 0644 |
|
fpositer.h | File | 3.04 KB | 0644 |
|
gender.h | File | 3.33 KB | 0644 |
|
gregocal.h | File | 31.71 KB | 0644 |
|
icudataver.h | File | 1.03 KB | 0644 |
|
icuplug.h | File | 11.88 KB | 0644 |
|
idna.h | File | 12.7 KB | 0644 |
|
listformatter.h | File | 9.47 KB | 0644 |
|
localebuilder.h | File | 11.27 KB | 0644 |
|
localematcher.h | File | 22.5 KB | 0644 |
|
localpointer.h | File | 19.69 KB | 0644 |
|
locdspnm.h | File | 7.12 KB | 0644 |
|
locid.h | File | 47.4 KB | 0644 |
|
measfmt.h | File | 11.33 KB | 0644 |
|
measunit.h | File | 93.31 KB | 0644 |
|
measure.h | File | 4.32 KB | 0644 |
|
messagepattern.h | File | 33.71 KB | 0644 |
|
msgfmt.h | File | 44.11 KB | 0644 |
|
normalizer2.h | File | 34.03 KB | 0644 |
|
normlzr.h | File | 30.94 KB | 0644 |
|
nounit.h | File | 2.69 KB | 0644 |
|
numberformatter.h | File | 86.31 KB | 0644 |
|
numberrangeformatter.h | File | 30.14 KB | 0644 |
|
numfmt.h | File | 49.81 KB | 0644 |
|
numsys.h | File | 7.19 KB | 0644 |
|
parseerr.h | File | 3.08 KB | 0644 |
|
parsepos.h | File | 5.56 KB | 0644 |
|
platform.h | File | 28.08 KB | 0644 |
|
plurfmt.h | File | 25.2 KB | 0644 |
|
plurrule.h | File | 18.39 KB | 0644 |
|
ptypes.h | File | 3.49 KB | 0644 |
|
putil.h | File | 6.33 KB | 0644 |
|
rbbi.h | File | 26.58 KB | 0644 |
|
rbnf.h | File | 48.73 KB | 0644 |
|
rbtz.h | File | 15.6 KB | 0644 |
|
regex.h | File | 84.36 KB | 0644 |
|
region.h | File | 9.18 KB | 0644 |
|
reldatefmt.h | File | 22.62 KB | 0644 |
|
rep.h | File | 9.37 KB | 0644 |
|
resbund.h | File | 18.07 KB | 0644 |
|
schriter.h | File | 6.32 KB | 0644 |
|
scientificnumberformatter.h | File | 6.4 KB | 0644 |
|
search.h | File | 22.22 KB | 0644 |
|
selfmt.h | File | 14.3 KB | 0644 |
|
simpleformatter.h | File | 12.59 KB | 0644 |
|
simpletz.h | File | 45.44 KB | 0644 |
|
smpdtfmt.h | File | 70.97 KB | 0644 |
|
sortkey.h | File | 11.18 KB | 0644 |
|
std_string.h | File | 1.05 KB | 0644 |
|
strenum.h | File | 9.92 KB | 0644 |
|
stringoptions.h | File | 5.79 KB | 0644 |
|
stringpiece.h | File | 7.38 KB | 0644 |
|
stringtriebuilder.h | File | 15.33 KB | 0644 |
|
stsearch.h | File | 21.3 KB | 0644 |
|
symtable.h | File | 4.27 KB | 0644 |
|
tblcoll.h | File | 36.61 KB | 0644 |
|
timezone.h | File | 41.02 KB | 0644 |
|
tmunit.h | File | 3.38 KB | 0644 |
|
tmutamt.h | File | 4.9 KB | 0644 |
|
tmutfmt.h | File | 7.85 KB | 0644 |
|
translit.h | File | 65.82 KB | 0644 |
|
tzfmt.h | File | 42.89 KB | 0644 |
|
tznames.h | File | 16.85 KB | 0644 |
|
tzrule.h | File | 35.37 KB | 0644 |
|
tztrans.h | File | 6.12 KB | 0644 |
|
ubidi.h | File | 89.56 KB | 0644 |
|
ubiditransform.h | File | 12.65 KB | 0644 |
|
ubrk.h | File | 23.97 KB | 0644 |
|
ucal.h | File | 56.9 KB | 0644 |
|
ucasemap.h | File | 15.18 KB | 0644 |
|
ucat.h | File | 5.36 KB | 0644 |
|
uchar.h | File | 140.56 KB | 0644 |
|
ucharstrie.h | File | 22.58 KB | 0644 |
|
ucharstriebuilder.h | File | 7.21 KB | 0644 |
|
uchriter.h | File | 13.2 KB | 0644 |
|
uclean.h | File | 11.21 KB | 0644 |
|
ucnv.h | File | 83.09 KB | 0644 |
|
ucnv_cb.h | File | 6.59 KB | 0644 |
|
ucnv_err.h | File | 20.99 KB | 0644 |
|
ucnvsel.h | File | 6.14 KB | 0644 |
|
ucol.h | File | 61.46 KB | 0644 |
|
ucoleitr.h | File | 9.46 KB | 0644 |
|
uconfig.h | File | 12.07 KB | 0644 |
|
ucpmap.h | File | 5.53 KB | 0644 |
|
ucptrie.h | File | 22.46 KB | 0644 |
|
ucsdet.h | File | 14.67 KB | 0644 |
|
ucurr.h | File | 16.12 KB | 0644 |
|
udat.h | File | 60.88 KB | 0644 |
|
udata.h | File | 15.56 KB | 0644 |
|
udateintervalformat.h | File | 10.03 KB | 0644 |
|
udatpg.h | File | 26.01 KB | 0644 |
|
udisplaycontext.h | File | 5.89 KB | 0644 |
|
uenum.h | File | 7.78 KB | 0644 |
|
ufieldpositer.h | File | 4.36 KB | 0644 |
|
uformattable.h | File | 10.94 KB | 0644 |
|
uformattedvalue.h | File | 12.14 KB | 0644 |
|
ugender.h | File | 2 KB | 0644 |
|
uidna.h | File | 33.37 KB | 0644 |
|
uiter.h | File | 22.77 KB | 0644 |
|
uldnames.h | File | 10.45 KB | 0644 |
|
ulistformatter.h | File | 8.83 KB | 0644 |
|
uloc.h | File | 52.54 KB | 0644 |
|
ulocdata.h | File | 11.26 KB | 0644 |
|
umachine.h | File | 14.53 KB | 0644 |
|
umisc.h | File | 1.33 KB | 0644 |
|
umsg.h | File | 24.23 KB | 0644 |
|
umutablecptrie.h | File | 8.24 KB | 0644 |
|
unifilt.h | File | 3.96 KB | 0644 |
|
unifunct.h | File | 4.04 KB | 0644 |
|
unimatch.h | File | 6.1 KB | 0644 |
|
unirepl.h | File | 3.38 KB | 0644 |
|
uniset.h | File | 64.9 KB | 0644 |
|
unistr.h | File | 170.43 KB | 0644 |
|
unorm.h | File | 20.52 KB | 0644 |
|
unorm2.h | File | 24.66 KB | 0644 |
|
unum.h | File | 53.62 KB | 0644 |
|
unumberformatter.h | File | 25.36 KB | 0644 |
|
unumsys.h | File | 7.21 KB | 0644 |
|
uobject.h | File | 10.68 KB | 0644 |
|
upluralrules.h | File | 7.88 KB | 0644 |
|
uregex.h | File | 72.05 KB | 0644 |
|
uregion.h | File | 9.84 KB | 0644 |
|
ureldatefmt.h | File | 17.26 KB | 0644 |
|
urename.h | File | 130.97 KB | 0644 |
|
urep.h | File | 5.38 KB | 0644 |
|
ures.h | File | 36.54 KB | 0644 |
|
uscript.h | File | 26.87 KB | 0644 |
|
usearch.h | File | 38.12 KB | 0644 |
|
uset.h | File | 40 KB | 0644 |
|
usetiter.h | File | 9.55 KB | 0644 |
|
ushape.h | File | 18 KB | 0644 |
|
uspoof.h | File | 65.9 KB | 0644 |
|
usprep.h | File | 8.14 KB | 0644 |
|
ustdio.h | File | 38.54 KB | 0644 |
|
ustream.h | File | 1.89 KB | 0644 |
|
ustring.h | File | 72.47 KB | 0644 |
|
ustringtrie.h | File | 3.15 KB | 0644 |
|
utext.h | File | 58.13 KB | 0644 |
|
utf.h | File | 7.86 KB | 0644 |
|
utf16.h | File | 23.32 KB | 0644 |
|
utf32.h | File | 763 B | 0644 |
|
utf8.h | File | 30.96 KB | 0644 |
|
utf_old.h | File | 45.83 KB | 0644 |
|
utmscale.h | File | 13.78 KB | 0644 |
|
utrace.h | File | 15.73 KB | 0644 |
|
utrans.h | File | 25.52 KB | 0644 |
|
utypes.h | File | 30.74 KB | 0644 |
|
uvernum.h | File | 6.67 KB | 0644 |
|
uversion.h | File | 6 KB | 0644 |
|
vtzone.h | File | 20.3 KB | 0644 |
|