<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>ICU 58.2: icu::Region Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ICU 58.2
 <span id="projectnumber">58.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceicu.html">icu</a></li><li class="navelem"><a class="el" href="classicu_1_1Region.html">Region</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">icu::Region Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code><a class="el" href="classicu_1_1Region.html" title="Region is the class representing a Unicode Region Code, also known as a Unicode Region Subtag...">Region</a></code> is the class representing a Unicode <a class="el" href="classicu_1_1Region.html" title="Region is the class representing a Unicode Region Code, also known as a Unicode Region Subtag...">Region</a> Code, also known as a Unicode <a class="el" href="classicu_1_1Region.html" title="Region is the class representing a Unicode Region Code, also known as a Unicode Region Subtag...">Region</a> Subtag, which is defined based upon the BCP 47 standard.
<a href="classicu_1_1Region.html#details">More...</a></p>
<p><code>#include <<a class="el" href="region_8h_source.html">region.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for icu::Region:</div>
<div class="dyncontent">
<div class="center">
<img src="classicu_1_1Region.png" usemap="#icu::Region_map" alt=""/>
<map id="icu::Region_map" name="icu::Region_map">
<area href="classicu_1_1UObject.html" title="UObject is the common ICU "boilerplate" class. " alt="icu::UObject" shape="rect" coords="0,56,89,80"/>
<area href="classicu_1_1UMemory.html" title="UMemory is the common ICU base class. " alt="icu::UMemory" shape="rect" coords="0,0,89,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8353f1a875636cb733f687bbd836c9f3"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Region.html#a8353f1a875636cb733f687bbd836c9f3">~Region</a> ()</td></tr>
<tr class="memdesc:a8353f1a875636cb733f687bbd836c9f3"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a8353f1a875636cb733f687bbd836c9f3">More...</a><br /></td></tr>
<tr class="separator:a8353f1a875636cb733f687bbd836c9f3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a53af01d1ae646bd4f463f63b58d0b3da"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Region.html#a53af01d1ae646bd4f463f63b58d0b3da">operator==</a> (const <a class="el" href="classicu_1_1Region.html">Region</a> &that) const </td></tr>
<tr class="memdesc:a53af01d1ae646bd4f463f63b58d0b3da"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the two regions are equal. <a href="#a53af01d1ae646bd4f463f63b58d0b3da">More...</a><br /></td></tr>
<tr class="separator:a53af01d1ae646bd4f463f63b58d0b3da"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af10eb0e5d7659c7286cbaa577e0fad9a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Region.html#af10eb0e5d7659c7286cbaa577e0fad9a">operator!=</a> (const <a class="el" href="classicu_1_1Region.html">Region</a> &that) const </td></tr>
<tr class="memdesc:af10eb0e5d7659c7286cbaa577e0fad9a"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the two regions are NOT equal; that is, if <a class="el" href="classicu_1_1Region.html#a53af01d1ae646bd4f463f63b58d0b3da" title="Returns true if the two regions are equal. ">operator ==()</a> returns false. <a href="#af10eb0e5d7659c7286cbaa577e0fad9a">More...</a><br /></td></tr>
<tr class="separator:af10eb0e5d7659c7286cbaa577e0fad9a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a42f82d20fea45188649a897e699b2afc"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classicu_1_1Region.html">Region</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Region.html#a42f82d20fea45188649a897e699b2afc">getContainingRegion</a> () const </td></tr>
<tr class="memdesc:a42f82d20fea45188649a897e699b2afc"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the region that contains this region. <a href="#a42f82d20fea45188649a897e699b2afc">More...</a><br /></td></tr>
<tr class="separator:a42f82d20fea45188649a897e699b2afc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9078495d91362835908a692eac3ea4d8"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classicu_1_1Region.html">Region</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Region.html#a9078495d91362835908a692eac3ea4d8">getContainingRegion</a> (<a class="el" href="uregion_8h.html#a75fa1508ee8a1321e62b254008acf0d5">URegionType</a> type) const </td></tr>
<tr class="memdesc:a9078495d91362835908a692eac3ea4d8"><td class="mdescLeft"> </td><td class="mdescRight">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. <a href="#a9078495d91362835908a692eac3ea4d8">More...</a><br /></td></tr>
<tr class="separator:a9078495d91362835908a692eac3ea4d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad2c473605e2b86a3657b8135cdfdad89"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1StringEnumeration.html">StringEnumeration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Region.html#ad2c473605e2b86a3657b8135cdfdad89">getContainedRegions</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const </td></tr>
<tr class="memdesc:ad2c473605e2b86a3657b8135cdfdad89"><td class="mdescLeft"> </td><td class="mdescRight">Return an enumeration over the IDs of all the regions that are immediate children of this region in the region hierarchy. <a href="#ad2c473605e2b86a3657b8135cdfdad89">More...</a><br /></td></tr>
<tr class="separator:ad2c473605e2b86a3657b8135cdfdad89"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab39452a86678162007a72a60b4d2d5b1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1StringEnumeration.html">StringEnumeration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Region.html#ab39452a86678162007a72a60b4d2d5b1">getContainedRegions</a> (<a class="el" href="uregion_8h.html#a75fa1508ee8a1321e62b254008acf0d5">URegionType</a> type, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const </td></tr>
<tr class="memdesc:ab39452a86678162007a72a60b4d2d5b1"><td class="mdescLeft"> </td><td class="mdescRight">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. <a href="#ab39452a86678162007a72a60b4d2d5b1">More...</a><br /></td></tr>
<tr class="separator:ab39452a86678162007a72a60b4d2d5b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a815492812ba1f7712133941a03d3001d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Region.html#a815492812ba1f7712133941a03d3001d">contains</a> (const <a class="el" href="classicu_1_1Region.html">Region</a> &other) const </td></tr>
<tr class="memdesc:a815492812ba1f7712133941a03d3001d"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this region contains the supplied other region anywhere in the region hierarchy. <a href="#a815492812ba1f7712133941a03d3001d">More...</a><br /></td></tr>
<tr class="separator:a815492812ba1f7712133941a03d3001d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a571ff927d90121689e3c63aa90bfa942"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1StringEnumeration.html">StringEnumeration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Region.html#a571ff927d90121689e3c63aa90bfa942">getPreferredValues</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const </td></tr>
<tr class="memdesc:a571ff927d90121689e3c63aa90bfa942"><td class="mdescLeft"> </td><td class="mdescRight">For deprecated regions, return an enumeration over the IDs of the regions that are the preferred replacement regions for this region. <a href="#a571ff927d90121689e3c63aa90bfa942">More...</a><br /></td></tr>
<tr class="separator:a571ff927d90121689e3c63aa90bfa942"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af1393fe807e326967d29bdcc65b21146"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Region.html#af1393fe807e326967d29bdcc65b21146">getRegionCode</a> () const </td></tr>
<tr class="memdesc:af1393fe807e326967d29bdcc65b21146"><td class="mdescLeft"> </td><td class="mdescRight">Return this region's canonical region code. <a href="#af1393fe807e326967d29bdcc65b21146">More...</a><br /></td></tr>
<tr class="separator:af1393fe807e326967d29bdcc65b21146"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4616ee9dbcea36dca5c15a83a8575daa"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Region.html#a4616ee9dbcea36dca5c15a83a8575daa">getNumericCode</a> () const </td></tr>
<tr class="memdesc:a4616ee9dbcea36dca5c15a83a8575daa"><td class="mdescLeft"> </td><td class="mdescRight">Return this region's numeric code. <a href="#a4616ee9dbcea36dca5c15a83a8575daa">More...</a><br /></td></tr>
<tr class="separator:a4616ee9dbcea36dca5c15a83a8575daa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3da78ed873a182dccf7edce4ca4876ed"><td class="memItemLeft" align="right" valign="top"><a class="el" href="uregion_8h.html#a75fa1508ee8a1321e62b254008acf0d5">URegionType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Region.html#a3da78ed873a182dccf7edce4ca4876ed">getType</a> () const </td></tr>
<tr class="memdesc:a3da78ed873a182dccf7edce4ca4876ed"><td class="mdescLeft"> </td><td class="mdescRight">Returns the region type of this region. <a href="#a3da78ed873a182dccf7edce4ca4876ed">More...</a><br /></td></tr>
<tr class="separator:a3da78ed873a182dccf7edce4ca4876ed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classicu_1_1UObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classicu_1_1UObject')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classicu_1_1UObject.html">icu::UObject</a></td></tr>
<tr class="memitem:af10026497704f510d3d1f2eff50acb18 inherit pub_methods_classicu_1_1UObject"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1UObject.html#af10026497704f510d3d1f2eff50acb18">~UObject</a> ()</td></tr>
<tr class="memdesc:af10026497704f510d3d1f2eff50acb18 inherit pub_methods_classicu_1_1UObject"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#af10026497704f510d3d1f2eff50acb18">More...</a><br /></td></tr>
<tr class="separator:af10026497704f510d3d1f2eff50acb18 inherit pub_methods_classicu_1_1UObject"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1aa93096e880907080b503ff1fb0f8bc inherit pub_methods_classicu_1_1UObject"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1UObject.html#a1aa93096e880907080b503ff1fb0f8bc">getDynamicClassID</a> () const </td></tr>
<tr class="memdesc:a1aa93096e880907080b503ff1fb0f8bc inherit pub_methods_classicu_1_1UObject"><td class="mdescLeft"> </td><td class="mdescRight">ICU4C "poor man's RTTI", returns a UClassID for the actual ICU class. <a href="#a1aa93096e880907080b503ff1fb0f8bc">More...</a><br /></td></tr>
<tr class="separator:a1aa93096e880907080b503ff1fb0f8bc inherit pub_methods_classicu_1_1UObject"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a0783cdcf3727a9152a36be2c1c8044d9"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classicu_1_1Region.html">Region</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Region.html#a0783cdcf3727a9152a36be2c1c8044d9">getInstance</a> (const char *region_code, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:a0783cdcf3727a9152a36be2c1c8044d9"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to a <a class="el" href="classicu_1_1Region.html" title="Region is the class representing a Unicode Region Code, also known as a Unicode Region Subtag...">Region</a> using the given region code. <a href="#a0783cdcf3727a9152a36be2c1c8044d9">More...</a><br /></td></tr>
<tr class="separator:a0783cdcf3727a9152a36be2c1c8044d9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8a51bf0d9360042795edfa8233248225"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classicu_1_1Region.html">Region</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Region.html#a8a51bf0d9360042795edfa8233248225">getInstance</a> (int32_t code, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:a8a51bf0d9360042795edfa8233248225"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to a <a class="el" href="classicu_1_1Region.html" title="Region is the class representing a Unicode Region Code, also known as a Unicode Region Subtag...">Region</a> using the given numeric region code. <a href="#a8a51bf0d9360042795edfa8233248225">More...</a><br /></td></tr>
<tr class="separator:a8a51bf0d9360042795edfa8233248225"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9ffb9d9b5599421c66ae416c981ce3e9"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1StringEnumeration.html">StringEnumeration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Region.html#a9ffb9d9b5599421c66ae416c981ce3e9">getAvailable</a> (<a class="el" href="uregion_8h.html#a75fa1508ee8a1321e62b254008acf0d5">URegionType</a> type, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:a9ffb9d9b5599421c66ae416c981ce3e9"><td class="mdescLeft"> </td><td class="mdescRight">Returns an enumeration over the IDs of all known regions that match the given type. <a href="#a9ffb9d9b5599421c66ae416c981ce3e9">More...</a><br /></td></tr>
<tr class="separator:a9ffb9d9b5599421c66ae416c981ce3e9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6efd9ebb08753a87bf6bb5286935835e"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1Region.html#a6efd9ebb08753a87bf6bb5286935835e">cleanupRegionData</a> ()</td></tr>
<tr class="memdesc:a6efd9ebb08753a87bf6bb5286935835e"><td class="mdescLeft"> </td><td class="mdescRight">Cleans up statically allocated memory. <a href="#a6efd9ebb08753a87bf6bb5286935835e">More...</a><br /></td></tr>
<tr class="separator:a6efd9ebb08753a87bf6bb5286935835e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><code><a class="el" href="classicu_1_1Region.html" title="Region is the class representing a Unicode Region Code, also known as a Unicode Region Subtag...">Region</a></code> is the class representing a Unicode <a class="el" href="classicu_1_1Region.html" title="Region is the class representing a Unicode Region Code, also known as a Unicode Region Subtag...">Region</a> Code, also known as a Unicode <a class="el" href="classicu_1_1Region.html" title="Region is the class representing a Unicode Region Code, also known as a Unicode Region Subtag...">Region</a> Subtag, which is defined based upon the BCP 47 standard. </p>
<p>We often think of "regions" as "countries" when defining the characteristics of a locale. <a class="el" href="classicu_1_1Region.html" title="Region is the class representing a Unicode Region Code, also known as a Unicode Region Subtag...">Region</a> codes There are different types of region codes that are important to distinguish. </p>
<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 (<a href="http://unstats.un.org/unsd/methods/m49/m49regin.htm">http://unstats.un.org/unsd/methods/m49/m49regin.htm</a>). 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>
<p>TERRITORY - A <a class="el" href="classicu_1_1Region.html" title="Region is the class representing a Unicode Region Code, also known as a Unicode Region Subtag...">Region</a> 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>
<p>UNKNOWN - The code ZZ is defined by Unicode LDML for use to indicate that the <a class="el" href="classicu_1_1Region.html" title="Region is the class representing a Unicode Region Code, also known as a Unicode Region Subtag...">Region</a> is unknown, or that the value supplied as a region was invalid. </p>
<p>DEPRECATED - <a class="el" href="classicu_1_1Region.html" title="Region is the class representing a Unicode Region Code, also known as a Unicode Region Subtag...">Region</a> 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>
<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. <a class="el" href="classicu_1_1Region.html" title="Region is the class representing a Unicode Region Code, also known as a Unicode Region Subtag...">Region</a> "EU" (European Union) is one such region code that is a grouping. Groupings will never be returned by the <a class="el" href="classicu_1_1Region.html#a42f82d20fea45188649a897e699b2afc" title="Returns a pointer to the region that contains this region. ">getContainingRegion()</a> API, since a different type of region ( WORLD, CONTINENT, or SUBCONTINENT ) will always be the containing region instead.</p>
<p>The <a class="el" href="classicu_1_1Region.html" title="Region is the class representing a Unicode Region Code, also known as a Unicode Region Subtag...">Region</a> class is not intended for public subclassing.</p>
<dl class="section author"><dt>Author</dt><dd>John Emmons </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004221">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
<p>Definition at line <a class="el" href="region_8h_source.html#l00070">70</a> of file <a class="el" href="region_8h_source.html">region.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a8353f1a875636cb733f687bbd836c9f3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual icu::Region::~Region </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004222">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a6efd9ebb08753a87bf6bb5286935835e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void icu::Region::cleanupRegionData </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Cleans up statically allocated memory. </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000418">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
</div>
</div>
<a class="anchor" id="a815492812ba1f7712133941a03d3001d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> icu::Region::contains </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1Region.html">Region</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if this region contains the supplied other region anywhere in the region hierarchy. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004232">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
</div>
</div>
<a class="anchor" id="a9ffb9d9b5599421c66ae416c981ce3e9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classicu_1_1StringEnumeration.html">StringEnumeration</a>* icu::Region::getAvailable </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uregion_8h.html#a75fa1508ee8a1321e62b254008acf0d5">URegionType</a> </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an enumeration over the IDs of all known regions that match the given type. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004227">Stable:</a></b></dt><dd>ICU 55 </dd></dl>
</div>
</div>
<a class="anchor" id="ad2c473605e2b86a3657b8135cdfdad89"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1StringEnumeration.html">StringEnumeration</a>* icu::Region::getContainedRegions </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return an enumeration over the IDs of all the regions that are immediate children of this region in the region hierarchy. </p>
<p>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). </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable004230">Stable:</a></b></dt><dd>ICU 55 </dd></dl>
</div>
</div>
<a class="anchor" id="ab39452a86678162007a72a60b4d2d5b1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1StringEnumeration.html">StringEnumeration</a>* icu::Region::getContainedRegions </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uregion_8h.html#a75fa1508ee8a1321e62b254008acf0d5">URegionType</a> </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>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. </p>
<p>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. ) </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable004231">Stable:</a></b></dt><dd>ICU 55 </dd></dl>
</div>
</div>
<a class="anchor" id="a42f82d20fea45188649a897e699b2afc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classicu_1_1Region.html">Region</a>* icu::Region::getContainingRegion </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a pointer to the region that contains this region. </p>
<p>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). </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable004228">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
</div>
</div>
<a class="anchor" id="a9078495d91362835908a692eac3ea4d8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classicu_1_1Region.html">Region</a>* icu::Region::getContainingRegion </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uregion_8h.html#a75fa1508ee8a1321e62b254008acf0d5">URegionType</a> </td>
<td class="paramname"><em>type</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>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. </p>
<p>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 ). </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable004229">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
</div>
</div>
<a class="anchor" id="a0783cdcf3727a9152a36be2c1c8044d9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classicu_1_1Region.html">Region</a>* icu::Region::getInstance </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>region_code</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a pointer to a <a class="el" href="classicu_1_1Region.html" title="Region is the class representing a Unicode Region Code, also known as a Unicode Region Subtag...">Region</a> using the given region code. </p>
<p>The region code can be either 2-letter ISO code, 3-letter ISO code, UNM.49 numeric code, or other valid Unicode <a class="el" href="classicu_1_1Region.html" title="Region is the class representing a Unicode Region Code, also known as a Unicode Region Subtag...">Region</a> 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 ) </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable004225">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
</div>
</div>
<a class="anchor" id="a8a51bf0d9360042795edfa8233248225"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classicu_1_1Region.html">Region</a>* icu::Region::getInstance </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>code</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a pointer to a <a class="el" href="classicu_1_1Region.html" title="Region is the class representing a Unicode Region Code, also known as a Unicode Region Subtag...">Region</a> using the given numeric region code. </p>
<p>If the numeric region code is not recognized, the appropriate error code will be set ( U_ILLEGAL_ARGUMENT_ERROR ). </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable004226">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
</div>
</div>
<a class="anchor" id="a4616ee9dbcea36dca5c15a83a8575daa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t icu::Region::getNumericCode </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return this region's numeric code. </p>
<p>Returns a negative value if the given region does not have a numeric code assigned to it. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable004235">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
</div>
</div>
<a class="anchor" id="a571ff927d90121689e3c63aa90bfa942"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1StringEnumeration.html">StringEnumeration</a>* icu::Region::getPreferredValues </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>For deprecated regions, return an enumeration over the IDs of the regions that are the preferred replacement regions for this region. </p>
<p>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... </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable004233">Stable:</a></b></dt><dd>ICU 55 </dd></dl>
</div>
</div>
<a class="anchor" id="af1393fe807e326967d29bdcc65b21146"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* icu::Region::getRegionCode </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return this region's canonical region code. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004234">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
</div>
</div>
<a class="anchor" id="a3da78ed873a182dccf7edce4ca4876ed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uregion_8h.html#a75fa1508ee8a1321e62b254008acf0d5">URegionType</a> icu::Region::getType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the region type of this region. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004236">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
</div>
</div>
<a class="anchor" id="af10eb0e5d7659c7286cbaa577e0fad9a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> icu::Region::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1Region.html">Region</a> & </td>
<td class="paramname"><em>that</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the two regions are NOT equal; that is, if <a class="el" href="classicu_1_1Region.html#a53af01d1ae646bd4f463f63b58d0b3da" title="Returns true if the two regions are equal. ">operator ==()</a> returns false. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004224">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
</div>
</div>
<a class="anchor" id="a53af01d1ae646bd4f463f63b58d0b3da"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> icu::Region::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1Region.html">Region</a> & </td>
<td class="paramname"><em>that</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the two regions are equal. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004223">Stable:</a></b></dt><dd>ICU 51 </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="region_8h_source.html">region.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
distrib
>
Mageia
>
6
>
armv5tl
>
media
>
core-release
>
by-pkgid
>
3a4e91bde08970529a0aa07935652fe8
>
files
>
494
