<!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"/> <title>ICU 52.1: icu::CurrencyUnit 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 style="padding-left: 0.5em;"> <div id="projectname">ICU 52.1  <span id="projectnumber">52.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.1.2 --> <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_1CurrencyUnit.html">CurrencyUnit</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::CurrencyUnit Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>A unit of currency, such as USD (U.S. <a href="classicu_1_1CurrencyUnit.html#details">More...</a></p> <p><code>#include <<a class="el" href="currunit_8h_source.html">currunit.h</a>></code></p> <div class="dynheader"> Inheritance diagram for icu::CurrencyUnit:</div> <div class="dyncontent"> <div class="center"> <img src="classicu_1_1CurrencyUnit.png" usemap="#icu::CurrencyUnit_map" alt=""/> <map id="icu::CurrencyUnit_map" name="icu::CurrencyUnit_map"> <area href="classicu_1_1MeasureUnit.html" title="A unit such as length, mass, volume, currency, etc." alt="icu::MeasureUnit" shape="rect" coords="0,112,110,136"/> <area href="classicu_1_1UObject.html" title="UObject is the common ICU "boilerplate" class." alt="icu::UObject" shape="rect" coords="0,56,110,80"/> <area href="classicu_1_1UMemory.html" title="UMemory is the common ICU base class." alt="icu::UMemory" shape="rect" coords="0,0,110,24"/> </map> </div></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a1d1518a55f16afa22e583ba9607a14bb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CurrencyUnit.html#a1d1518a55f16afa22e583ba9607a14bb">CurrencyUnit</a> (const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *isoCode, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &ec)</td></tr> <tr class="memdesc:a1d1518a55f16afa22e583ba9607a14bb"><td class="mdescLeft"> </td><td class="mdescRight">Construct an object with the given ISO currency code. <a href="#a1d1518a55f16afa22e583ba9607a14bb"></a><br/></td></tr> <tr class="memitem:a234570a2430624b71e26cdeeedae7fd2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CurrencyUnit.html#a234570a2430624b71e26cdeeedae7fd2">CurrencyUnit</a> (const <a class="el" href="classicu_1_1CurrencyUnit.html">CurrencyUnit</a> &other)</td></tr> <tr class="memdesc:a234570a2430624b71e26cdeeedae7fd2"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#a234570a2430624b71e26cdeeedae7fd2"></a><br/></td></tr> <tr class="memitem:abdb7908a19f5088c67389dc8a8def22a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1CurrencyUnit.html">CurrencyUnit</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CurrencyUnit.html#abdb7908a19f5088c67389dc8a8def22a">operator=</a> (const <a class="el" href="classicu_1_1CurrencyUnit.html">CurrencyUnit</a> &other)</td></tr> <tr class="memdesc:abdb7908a19f5088c67389dc8a8def22a"><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#abdb7908a19f5088c67389dc8a8def22a"></a><br/></td></tr> <tr class="memitem:a10a3a8948d448936f0681425768595d4"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classicu_1_1UObject.html">UObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CurrencyUnit.html#a10a3a8948d448936f0681425768595d4">clone</a> () const </td></tr> <tr class="memdesc:a10a3a8948d448936f0681425768595d4"><td class="mdescLeft"> </td><td class="mdescRight">Return a polymorphic clone of this object. <a href="#a10a3a8948d448936f0681425768595d4"></a><br/></td></tr> <tr class="memitem:a2389744b711b8c1388dde6933b8bee4c"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CurrencyUnit.html#a2389744b711b8c1388dde6933b8bee4c">~CurrencyUnit</a> ()</td></tr> <tr class="memdesc:a2389744b711b8c1388dde6933b8bee4c"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a2389744b711b8c1388dde6933b8bee4c"></a><br/></td></tr> <tr class="memitem:a9f90fb9b4bf3545ad966894dcc20f14b"><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_1CurrencyUnit.html#a9f90fb9b4bf3545ad966894dcc20f14b">operator==</a> (const <a class="el" href="classicu_1_1UObject.html">UObject</a> &other) const </td></tr> <tr class="memdesc:a9f90fb9b4bf3545ad966894dcc20f14b"><td class="mdescLeft"> </td><td class="mdescRight">Equality operator. <a href="#a9f90fb9b4bf3545ad966894dcc20f14b"></a><br/></td></tr> <tr class="memitem:a614f5746a2c225884c3d14f92bccf042"><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_1CurrencyUnit.html#a614f5746a2c225884c3d14f92bccf042">getDynamicClassID</a> () const </td></tr> <tr class="memdesc:a614f5746a2c225884c3d14f92bccf042"><td class="mdescLeft"> </td><td class="mdescRight">Returns a unique class ID for this object POLYMORPHICALLY. <a href="#a614f5746a2c225884c3d14f92bccf042"></a><br/></td></tr> <tr class="memitem:a6281013a1e35b2b6d937618caeb54fac"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CurrencyUnit.html#a6281013a1e35b2b6d937618caeb54fac">getISOCurrency</a> () const </td></tr> <tr class="memdesc:a6281013a1e35b2b6d937618caeb54fac"><td class="mdescLeft"> </td><td class="mdescRight">Return the ISO currency code of this object. <a href="#a6281013a1e35b2b6d937618caeb54fac"></a><br/></td></tr> <tr class="inherit_header pub_methods_classicu_1_1MeasureUnit"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classicu_1_1MeasureUnit')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classicu_1_1MeasureUnit.html">icu::MeasureUnit</a></td></tr> <tr class="memitem:ab1cbd9dbd3f2c4724b7e7a997d46353e inherit pub_methods_classicu_1_1MeasureUnit"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1MeasureUnit.html#ab1cbd9dbd3f2c4724b7e7a997d46353e">~MeasureUnit</a> ()</td></tr> <tr class="memdesc:ab1cbd9dbd3f2c4724b7e7a997d46353e inherit pub_methods_classicu_1_1MeasureUnit"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ab1cbd9dbd3f2c4724b7e7a997d46353e"></a><br/></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"></a><br/></td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr class="memitem:a9d58af711313e02db89ae353303b748c"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CurrencyUnit.html#a9d58af711313e02db89ae353303b748c">getStaticClassID</a> ()</td></tr> <tr class="memdesc:a9d58af711313e02db89ae353303b748c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the class ID for this class. <a href="#a9d58af711313e02db89ae353303b748c"></a><br/></td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2><a name="inherited"></a> Additional Inherited Members</h2></td></tr> <tr class="inherit_header pro_methods_classicu_1_1MeasureUnit"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classicu_1_1MeasureUnit')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classicu_1_1MeasureUnit.html">icu::MeasureUnit</a></td></tr> <tr class="memitem:a9d45101320b20019fc0960073dd10b77 inherit pro_methods_classicu_1_1MeasureUnit"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1MeasureUnit.html#a9d45101320b20019fc0960073dd10b77">MeasureUnit</a> ()</td></tr> <tr class="memdesc:a9d45101320b20019fc0960073dd10b77 inherit pro_methods_classicu_1_1MeasureUnit"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a9d45101320b20019fc0960073dd10b77"></a><br/></td></tr> </table> <a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>A unit of currency, such as USD (U.S. </p> <p>dollars) or JPY (Japanese yen). This class is a thin wrapper over a UChar string that subclasses <a class="el" href="classicu_1_1MeasureUnit.html" title="A unit such as length, mass, volume, currency, etc.">MeasureUnit</a>, for use with <a class="el" href="classicu_1_1Measure.html" title="An amount of a specified unit, consisting of a number and a Unit.">Measure</a> and <a class="el" href="classicu_1_1MeasureFormat.html" title="A formatter for measure objects.">MeasureFormat</a>.</p> <dl class="section author"><dt>Author</dt><dd>Alan Liu </dd></dl> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable003055">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl> <p>Definition at line <a class="el" href="currunit_8h_source.html#l00035">35</a> of file <a class="el" href="currunit_8h_source.html">currunit.h</a>.</p> </div><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a1d1518a55f16afa22e583ba9607a14bb"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">icu::CurrencyUnit::CurrencyUnit </td> <td>(</td> <td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td> <td class="paramname"><em>isoCode</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>ec</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Construct an object with the given ISO currency code. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">isoCode</td><td>the 3-letter ISO 4217 currency code; must not be NULL and must have length 3 </td></tr> <tr><td class="paramname">ec</td><td>input-output error code. If the isoCode is invalid, then this will be set to a failing value. </td></tr> </table> </dd> </dl> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable003056">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl> </div> </div> <a class="anchor" id="a234570a2430624b71e26cdeeedae7fd2"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">icu::CurrencyUnit::CurrencyUnit </td> <td>(</td> <td class="paramtype">const <a class="el" href="classicu_1_1CurrencyUnit.html">CurrencyUnit</a> & </td> <td class="paramname"><em>other</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Copy constructor. </p> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable003057">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl> </div> </div> <a class="anchor" id="a2389744b711b8c1388dde6933b8bee4c"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual icu::CurrencyUnit::~CurrencyUnit </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#_stable003060">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl> </div> </div> <h2>Member Function Documentation</h2> <a class="anchor" id="a10a3a8948d448936f0681425768595d4"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="classicu_1_1UObject.html">UObject</a>* icu::CurrencyUnit::clone </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</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>Return a polymorphic clone of this object. </p> <p>The result will have the same class as returned by <a class="el" href="classicu_1_1CurrencyUnit.html#a614f5746a2c225884c3d14f92bccf042" title="Returns a unique class ID for this object POLYMORPHICALLY.">getDynamicClassID()</a>. </p> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable003059">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl> <p>Implements <a class="el" href="classicu_1_1MeasureUnit.html#a5b3808ae866fd969a5bb88cc2fa855d4">icu::MeasureUnit</a>.</p> </div> </div> <a class="anchor" id="a614f5746a2c225884c3d14f92bccf042"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> icu::CurrencyUnit::getDynamicClassID </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</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>Returns a unique class ID for this object POLYMORPHICALLY. </p> <p>This method implements a simple form of RTTI used by ICU. </p> <dl class="section return"><dt>Returns</dt><dd>The class ID for this object. All objects of a given class have the same class ID. Objects of other classes have different class IDs. </dd></dl> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable003062">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl> <p>Reimplemented from <a class="el" href="classicu_1_1UObject.html#a1aa93096e880907080b503ff1fb0f8bc">icu::UObject</a>.</p> </div> </div> <a class="anchor" id="a6281013a1e35b2b6d937618caeb54fac"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * icu::CurrencyUnit::getISOCurrency </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Return the ISO currency code of this object. </p> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable003064">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl> <p>Definition at line <a class="el" href="currunit_8h_source.html#l00110">110</a> of file <a class="el" href="currunit_8h_source.html">currunit.h</a>.</p> </div> </div> <a class="anchor" id="a9d58af711313e02db89ae353303b748c"></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="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> icu::CurrencyUnit::getStaticClassID </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>Returns the class ID for this class. </p> <p>This is used to compare to the return value of <a class="el" href="classicu_1_1CurrencyUnit.html#a614f5746a2c225884c3d14f92bccf042" title="Returns a unique class ID for this object POLYMORPHICALLY.">getDynamicClassID()</a>. </p> <dl class="section return"><dt>Returns</dt><dd>The class ID for all objects of this class. </dd></dl> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable003063">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl> </div> </div> <a class="anchor" id="abdb7908a19f5088c67389dc8a8def22a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classicu_1_1CurrencyUnit.html">CurrencyUnit</a>& icu::CurrencyUnit::operator= </td> <td>(</td> <td class="paramtype">const <a class="el" href="classicu_1_1CurrencyUnit.html">CurrencyUnit</a> & </td> <td class="paramname"><em>other</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Assignment operator. </p> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable003058">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl> </div> </div> <a class="anchor" id="a9f90fb9b4bf3545ad966894dcc20f14b"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> icu::CurrencyUnit::operator== </td> <td>(</td> <td class="paramtype">const <a class="el" href="classicu_1_1UObject.html">UObject</a> & </td> <td class="paramname"><em>other</em></td><td>)</td> <td> const</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>Equality operator. </p> <p>Return true if this object is equal to the given object. </p> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable003061">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl> <p>Implements <a class="el" href="classicu_1_1MeasureUnit.html#a67807a00179beb27b4ab9dfe65e9d64b">icu::MeasureUnit</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="currunit_8h_source.html">currunit.h</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Fri Oct 4 2013 14:10:25 for ICU 52.1 by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.1.2 </small></address> </body> </html>