<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!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"/>
<title>ICU 4.4: CurrencyUnit Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.1 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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 class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<img id="MSearchSelect" src="search/search.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<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>
<div class="contents">
<h1>CurrencyUnit Class Reference</h1><!-- doxytag: class="CurrencyUnit" --><!-- doxytag: inherits="MeasureUnit" -->
<p>A unit of currency, such as USD (U.S.
<a href="#_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 CurrencyUnit:</div>
<div class="dynsection">
<div class="center">
<img src="classCurrencyUnit.gif" usemap="#CurrencyUnit_map" alt=""/>
<map id="CurrencyUnit_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>
</div>
</div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCurrencyUnit.html#a730fd929c8fba95407996401a37fa9c2">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><td class="mdescLeft"> </td><td class="mdescRight">Construct an object with the given ISO currency code. <a href="#a730fd929c8fba95407996401a37fa9c2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCurrencyUnit.html#a206e26b3939378044aa9e9bc33f02e4f">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="#a206e26b3939378044aa9e9bc33f02e4f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCurrencyUnit.html">CurrencyUnit</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCurrencyUnit.html#a652ca28074ddeb812337a30237a86723">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="#a652ca28074ddeb812337a30237a86723"></a><br/></td></tr>
<tr><td class="memItemLeft" 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#a28a559d844290aec11e25ef20c4bbaa6">clone</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a polymorphic clone of this object. <a href="#a28a559d844290aec11e25ef20c4bbaa6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCurrencyUnit.html#ace5ca87b4dcd3ba93f58f0b8edff189a">~CurrencyUnit</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ace5ca87b4dcd3ba93f58f0b8edff189a"></a><br/></td></tr>
<tr><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="classCurrencyUnit.html#a701050ee514770f7383a55df5a0abe71">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="#a701050ee514770f7383a55df5a0abe71"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCurrencyUnit.html#aca7e85865e301276d2dacb6e3799478f">getDynamicClassID</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a unique class ID for this object POLYMORPHICALLY. <a href="#aca7e85865e301276d2dacb6e3799478f"></a><br/></td></tr>
<tr><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="classCurrencyUnit.html#a23a93a872b11b8315f05894247ef7360">getISOCurrency</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the ISO currency code of this object. <a href="#a23a93a872b11b8315f05894247ef7360"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCurrencyUnit.html#a45f3040e2094a74ad8caeed529d040cb">getStaticClassID</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the class ID for this class. <a href="#a45f3040e2094a74ad8caeed529d040cb"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<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="classMeasureUnit.html" title="A unit such as length, mass, volume, currency, etc.">MeasureUnit</a>, for use with <a class="el" href="classMeasure.html" title="An amount of a specified unit, consisting of a number and a Unit.">Measure</a> and <a class="el" href="classMeasureFormat.html" title="A formatter for measure objects.">MeasureFormat</a>.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>Alan Liu </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002365">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>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a730fd929c8fba95407996401a37fa9c2"></a><!-- doxytag: member="CurrencyUnit::CurrencyUnit" ref="a730fd929c8fba95407996401a37fa9c2" 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 <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><td> </td>
</tr>
<tr>
<td></td>
<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><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>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002366">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a206e26b3939378044aa9e9bc33f02e4f"></a><!-- doxytag: member="CurrencyUnit::CurrencyUnit" ref="a206e26b3939378044aa9e9bc33f02e4f" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copy constructor. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002367">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ace5ca87b4dcd3ba93f58f0b8edff189a"></a><!-- doxytag: member="CurrencyUnit::~CurrencyUnit" ref="ace5ca87b4dcd3ba93f58f0b8edff189a" 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><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002370">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a28a559d844290aec11e25ef20c4bbaa6"></a><!-- doxytag: member="CurrencyUnit::clone" ref="a28a559d844290aec11e25ef20c4bbaa6" 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> const<code> [virtual]</code></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="classCurrencyUnit.html#aca7e85865e301276d2dacb6e3799478f" title="Returns a unique class ID for this object POLYMORPHICALLY.">getDynamicClassID()</a>. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002369">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
<p>Implements <a class="el" href="classMeasureUnit.html#aa1c4cd664e1d12efa53fa3c3c861e49b">MeasureUnit</a>.</p>
</div>
</div>
<a class="anchor" id="aca7e85865e301276d2dacb6e3799478f"></a><!-- doxytag: member="CurrencyUnit::getDynamicClassID" ref="aca7e85865e301276d2dacb6e3799478f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> CurrencyUnit::getDynamicClassID </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual]</code></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="return"><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 class="stable"><dt><b><a class="el" href="stable.html#_stable002372">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
<p>Implements <a class="el" href="classUObject.html#a9b1acc95efd89cb86ec31f2dc947a262">UObject</a>.</p>
</div>
</div>
<a class="anchor" id="a23a93a872b11b8315f05894247ef7360"></a><!-- doxytag: member="CurrencyUnit::getISOCurrency" ref="a23a93a872b11b8315f05894247ef7360" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * CurrencyUnit::getISOCurrency </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></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#_stable002374">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>
<p>Referenced by <a class="el" href="curramt_8h_source.html#l00123">CurrencyAmount::getISOCurrency()</a>.</p>
</div>
</div>
<a class="anchor" id="a45f3040e2094a74ad8caeed529d040cb"></a><!-- doxytag: member="CurrencyUnit::getStaticClassID" ref="a45f3040e2094a74ad8caeed529d040cb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> CurrencyUnit::getStaticClassID </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></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="classCurrencyUnit.html#aca7e85865e301276d2dacb6e3799478f" title="Returns a unique class ID for this object POLYMORPHICALLY.">getDynamicClassID()</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The class ID for all objects of this class. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002373">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a652ca28074ddeb812337a30237a86723"></a><!-- doxytag: member="CurrencyUnit::operator=" ref="a652ca28074ddeb812337a30237a86723" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assignment operator. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002368">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a701050ee514770f7383a55df5a0abe71"></a><!-- doxytag: member="CurrencyUnit::operator==" ref="a701050ee514770f7383a55df5a0abe71" 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#a349ef00011f20ccd1d3b424445681aa5">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> const<code> [virtual]</code></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#_stable002371">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
<p>Implements <a class="el" href="classMeasureUnit.html#a27a18f5d47424baa33927256d788d6bd">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>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 16 Mar 2010 for ICU 4.4 by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
f51238514e2abe817779ad2fe01b0759
>
files
>
76
