<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>ICU 3.6: CurrencyUnit Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li id="current"><a href="classes.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label> <u>S</u>earch for </label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Data Structures</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>
<h1>CurrencyUnit Class Reference</h1><!-- doxytag: class="CurrencyUnit" --><!-- doxytag: inherits="MeasureUnit" -->A unit of currency, such as USD (U.S.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="currunit_8h-source.html">currunit.h</a>></code>
<p>
<p>Inheritance diagram for CurrencyUnit:
<p><center><img src="classCurrencyUnit.png" usemap="#CurrencyUnit_map" border="0" alt=""></center>
<map name="CurrencyUnit_map">
<area href="classMeasureUnit.html" alt="MeasureUnit" shape="rect" coords="0,112,87,136">
<area href="classUObject.html" alt="UObject" shape="rect" coords="0,56,87,80">
<area href="classUMemory.html" alt="UMemory" shape="rect" coords="0,0,87,24">
</map>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCurrencyUnit.html#b3ef8698447012cfa0658a3a8695602d">CurrencyUnit</a> (const UChar *isoCode, <a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> &ec)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct an object with the given ISO currency code. <a href="#b3ef8698447012cfa0658a3a8695602d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCurrencyUnit.html#dccc860f5702aaeefc5b117af1a3e6f3">CurrencyUnit</a> (const <a class="el" href="classCurrencyUnit.html">CurrencyUnit</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#dccc860f5702aaeefc5b117af1a3e6f3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classCurrencyUnit.html">CurrencyUnit</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCurrencyUnit.html#14222cb9ef7a8d8379df8ed6a6777014">operator=</a> (const <a class="el" href="classCurrencyUnit.html">CurrencyUnit</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#14222cb9ef7a8d8379df8ed6a6777014"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classUObject.html">UObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCurrencyUnit.html#d5519201d1fc9ca341249506694c2dea">clone</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a polymorphic clone of this object. <a href="#d5519201d1fc9ca341249506694c2dea"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCurrencyUnit.html#c0621f05b9ff82a68d5c7d6556311985">~CurrencyUnit</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#c0621f05b9ff82a68d5c7d6556311985"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCurrencyUnit.html#ddadcc2b6ad71748067d35440d92d8e0">operator==</a> (const <a class="el" href="classUObject.html">UObject</a> &other) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Equality operator. <a href="#ddadcc2b6ad71748067d35440d92d8e0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="utypes_8h.html#452dc3c7d14eb1a1837ae1aa0b2d6724">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCurrencyUnit.html#6fd570968dfe68d992287691d3b50330">getDynamicClassID</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a unique class ID for this object POLYMORPHICALLY. <a href="#6fd570968dfe68d992287691d3b50330"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const UChar * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCurrencyUnit.html#595082a403c628ccf4c2d3c04e3b6bc8">getISOCurrency</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the ISO currency code of this object. <a href="#595082a403c628ccf4c2d3c04e3b6bc8"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="utypes_8h.html#452dc3c7d14eb1a1837ae1aa0b2d6724">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCurrencyUnit.html#46416a48354714a6704c037801123375">getStaticClassID</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the class ID for this class. <a href="#46416a48354714a6704c037801123375"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A unit of currency, such as USD (U.S.
<p>
dollars) or JPY (Japanese yen). This class is a thin wrapper over a UChar string that subclasses <a class="el" href="classMeasureUnit.html">MeasureUnit</a>, for use with <a class="el" href="classMeasure.html">Measure</a> and <a class="el" href="classMeasureFormat.html">MeasureFormat</a>.<p>
<dl compact><dt><b>Author:</b></dt><dd>Alan Liu </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001988">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
<p>
<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>.<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="b3ef8698447012cfa0658a3a8695602d"></a><!-- doxytag: member="CurrencyUnit::CurrencyUnit" ref="b3ef8698447012cfa0658a3a8695602d" args="(const UChar *isoCode, UErrorCode &ec)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CurrencyUnit::CurrencyUnit </td>
<td>(</td>
<td class="paramtype">const UChar * </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#863c11989634c998849cc946d04dfabe">UErrorCode</a> & </td>
<td class="paramname"> <em>ec</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Construct an object with the given ISO currency code.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>isoCode</em> </td><td>the 3-letter ISO 4217 currency code; must not be NULL and must have length 3 </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ec</em> </td><td>input-output error code. If the isoCode is invalid, then this will be set to a failing value. </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001989">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="dccc860f5702aaeefc5b117af1a3e6f3"></a><!-- doxytag: member="CurrencyUnit::CurrencyUnit" ref="dccc860f5702aaeefc5b117af1a3e6f3" args="(const CurrencyUnit &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CurrencyUnit::CurrencyUnit </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCurrencyUnit.html">CurrencyUnit</a> & </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copy constructor.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable001990">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="c0621f05b9ff82a68d5c7d6556311985"></a><!-- doxytag: member="CurrencyUnit::~CurrencyUnit" ref="c0621f05b9ff82a68d5c7d6556311985" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual CurrencyUnit::~CurrencyUnit </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable001993">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d5519201d1fc9ca341249506694c2dea"></a><!-- doxytag: member="CurrencyUnit::clone" ref="d5519201d1fc9ca341249506694c2dea" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classUObject.html">UObject</a>* CurrencyUnit::clone </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a polymorphic clone of this object.
<p>
The result will have the same class as returned by <a class="el" href="classCurrencyUnit.html#6fd570968dfe68d992287691d3b50330">getDynamicClassID()</a>. <dl compact><dt><b><a class="el" href="stable.html#_stable001992">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
<p>
Implements <a class="el" href="classMeasureUnit.html#1bcb7ef3a2a0d9d12b89d30a47726b9a">MeasureUnit</a>.
</div>
</div><p>
<a class="anchor" name="6fd570968dfe68d992287691d3b50330"></a><!-- doxytag: member="CurrencyUnit::getDynamicClassID" ref="6fd570968dfe68d992287691d3b50330" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="utypes_8h.html#452dc3c7d14eb1a1837ae1aa0b2d6724">UClassID</a> CurrencyUnit::getDynamicClassID </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns a unique class ID for this object POLYMORPHICALLY.
<p>
This method implements a simple form of RTTI used by ICU. <dl compact><dt><b>Returns:</b></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 compact><dt><b><a class="el" href="stable.html#_stable001995">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
<p>
Implements <a class="el" href="classUObject.html#60f3fba82b9d7edfe3d3f9d423ab826d">UObject</a>.
</div>
</div><p>
<a class="anchor" name="595082a403c628ccf4c2d3c04e3b6bc8"></a><!-- doxytag: member="CurrencyUnit::getISOCurrency" ref="595082a403c628ccf4c2d3c04e3b6bc8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const UChar * CurrencyUnit::getISOCurrency </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the ISO currency code of this object.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable001997">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>
Referenced by <a class="el" href="curramt_8h-source.html#l00123">CurrencyAmount::getISOCurrency()</a>.
</div>
</div><p>
<a class="anchor" name="46416a48354714a6704c037801123375"></a><!-- doxytag: member="CurrencyUnit::getStaticClassID" ref="46416a48354714a6704c037801123375" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="utypes_8h.html#452dc3c7d14eb1a1837ae1aa0b2d6724">UClassID</a> CurrencyUnit::getStaticClassID </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the class ID for this class.
<p>
This is used to compare to the return value of <a class="el" href="classCurrencyUnit.html#6fd570968dfe68d992287691d3b50330">getDynamicClassID()</a>. <dl compact><dt><b>Returns:</b></dt><dd>The class ID for all objects of this class. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001996">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="14222cb9ef7a8d8379df8ed6a6777014"></a><!-- doxytag: member="CurrencyUnit::operator=" ref="14222cb9ef7a8d8379df8ed6a6777014" args="(const CurrencyUnit &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCurrencyUnit.html">CurrencyUnit</a>& CurrencyUnit::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCurrencyUnit.html">CurrencyUnit</a> & </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Assignment operator.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable001991">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="ddadcc2b6ad71748067d35440d92d8e0"></a><!-- doxytag: member="CurrencyUnit::operator==" ref="ddadcc2b6ad71748067d35440d92d8e0" args="(const UObject &other) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a> CurrencyUnit::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUObject.html">UObject</a> & </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Equality operator.
<p>
Return true if this object is equal to the given object. <dl compact><dt><b><a class="el" href="stable.html#_stable001994">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
<p>
Implements <a class="el" href="classMeasureUnit.html#0cdf7fc131e97547cbe93531cea1f05f">MeasureUnit</a>.
</div>
</div><p>
<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></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Dec 13 17:29:54 2011 for ICU 3.6 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>
