<!-- 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: Measure 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>Measure Class Reference</h1><!-- doxytag: class="Measure" --><!-- doxytag: inherits="UObject" -->
<p>An amount of a specified unit, consisting of a number and a Unit.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="measure_8h_source.html">measure.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Measure:</div>
<div class="dynsection">
<div class="center">
<img src="classMeasure.gif" usemap="#Measure_map" alt=""/>
<map id="Measure_map" name="Measure_map">
<area href="classUObject.html" alt="UObject" shape="rect" coords="59,56,167,80"/>
<area href="classUMemory.html" alt="UMemory" shape="rect" coords="59,0,167,24"/>
<area href="classCurrencyAmount.html" alt="CurrencyAmount" shape="rect" coords="0,168,108,192"/>
<area href="classTimeUnitAmount.html" alt="TimeUnitAmount" shape="rect" coords="118,168,226,192"/>
</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="classMeasure.html#a46a388e186c1f6f60ad39202ad2ac2ef">Measure</a> (const <a class="el" href="classFormattable.html">Formattable</a> &number, <a class="el" href="classMeasureUnit.html">MeasureUnit</a> *adoptedUnit, <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 numeric amount and the given unit. <a href="#a46a388e186c1f6f60ad39202ad2ac2ef"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMeasure.html#a6860501b4d4b500d019877473ff0ad61">Measure</a> (const <a class="el" href="classMeasure.html">Measure</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#a6860501b4d4b500d019877473ff0ad61"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classMeasure.html">Measure</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classMeasure.html#a94221e3ffde5706e1f28e0a558f34981">operator=</a> (const <a class="el" href="classMeasure.html">Measure</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#a94221e3ffde5706e1f28e0a558f34981"></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="classMeasure.html#abc87db8d55945660b2ea2cd3d0713b89">clone</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a polymorphic clone of this object. <a href="#abc87db8d55945660b2ea2cd3d0713b89"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classMeasure.html#a6af10081ceb2f0850e74aec7202669a2">~Measure</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a6af10081ceb2f0850e74aec7202669a2"></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="classMeasure.html#a43d8a81cfbbda7c050b7c4c38732c94d">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="#a43d8a81cfbbda7c050b7c4c38732c94d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classFormattable.html">Formattable</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classMeasure.html#a2935701319d4d7b2219d22130849e3b7">getNumber</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a reference to the numeric value of this object. <a href="#a2935701319d4d7b2219d22130849e3b7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classMeasureUnit.html">MeasureUnit</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classMeasure.html#aca10f62e4a418373e4b1e58e39637d0a">getUnit</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a reference to the unit of this object. <a href="#aca10f62e4a418373e4b1e58e39637d0a"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMeasure.html#ab55c93d6121f43c91a337fb7bcd26825">Measure</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#ab55c93d6121f43c91a337fb7bcd26825"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>An amount of a specified unit, consisting of a number and a Unit. </p>
<p>For example, a length measure consists of a number and a length unit, such as feet or meters. This is an abstract class. Subclasses specify a concrete Unit type.</p>
<p><a class="el" href="classMeasure.html" title="An amount of a specified unit, consisting of a number and a Unit.">Measure</a> objects are parsed and formatted by subclasses of <a class="el" href="classMeasureFormat.html" title="A formatter for measure objects.">MeasureFormat</a>.</p>
<p><a class="el" href="classMeasure.html" title="An amount of a specified unit, consisting of a number and a Unit.">Measure</a> objects are immutable.</p>
<p>This is an abstract class.</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#_stable002751">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
<p>Definition at line <a class="el" href="measure_8h_source.html#l00045">45</a> of file <a class="el" href="measure_8h_source.html">measure.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a46a388e186c1f6f60ad39202ad2ac2ef"></a><!-- doxytag: member="Measure::Measure" ref="a46a388e186c1f6f60ad39202ad2ac2ef" args="(const Formattable &number, MeasureUnit *adoptedUnit, UErrorCode &ec)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Measure::Measure </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFormattable.html">Formattable</a> & </td>
<td class="paramname"> <em>number</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classMeasureUnit.html">MeasureUnit</a> * </td>
<td class="paramname"> <em>adoptedUnit</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 numeric amount and the given unit. </p>
<p>After this call, the caller must not delete the given unit object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>number</em> </td><td>a numeric object; amount.isNumeric() must be TRUE </td></tr>
<tr><td valign="top"></td><td valign="top"><em>adoptedUnit</em> </td><td>the unit object, which must not be NULL </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ec</em> </td><td>input-output error code. If the amount or the unit 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#_stable002752">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a6860501b4d4b500d019877473ff0ad61"></a><!-- doxytag: member="Measure::Measure" ref="a6860501b4d4b500d019877473ff0ad61" args="(const Measure &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Measure::Measure </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classMeasure.html">Measure</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#_stable002753">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a6af10081ceb2f0850e74aec7202669a2"></a><!-- doxytag: member="Measure::~Measure" ref="a6af10081ceb2f0850e74aec7202669a2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Measure::~Measure </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#_stable002756">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ab55c93d6121f43c91a337fb7bcd26825"></a><!-- doxytag: member="Measure::Measure" ref="ab55c93d6121f43c91a337fb7bcd26825" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Measure::Measure </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002760">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="abc87db8d55945660b2ea2cd3d0713b89"></a><!-- doxytag: member="Measure::clone" ref="abc87db8d55945660b2ea2cd3d0713b89" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classUObject.html">UObject</a>* Measure::clone </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure 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="classUObject.html#a9b1acc95efd89cb86ec31f2dc947a262" title="ICU4C "poor man's RTTI", returns a UClassID for the actual ICU class...">getDynamicClassID()</a>. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002755">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
<p>Implemented in <a class="el" href="classCurrencyAmount.html#a324129012688a7d6213669f062b74b76">CurrencyAmount</a>, and <a class="el" href="classTimeUnitAmount.html#ad7513ffc783177dce007b5bfe8a9a47d">TimeUnitAmount</a>.</p>
</div>
</div>
<a class="anchor" id="a2935701319d4d7b2219d22130849e3b7"></a><!-- doxytag: member="Measure::getNumber" ref="a2935701319d4d7b2219d22130849e3b7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classFormattable.html">Formattable</a> & Measure::getNumber </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a reference to the numeric value of this object. </p>
<p>The numeric value may be of any numeric type supported by <a class="el" href="classFormattable.html" title="Formattable objects can be passed to the Format class or its subclasses for formatting...">Formattable</a>. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002758">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
<p>Definition at line <a class="el" href="measure_8h_source.html#l00126">126</a> of file <a class="el" href="measure_8h_source.html">measure.h</a>.</p>
</div>
</div>
<a class="anchor" id="aca10f62e4a418373e4b1e58e39637d0a"></a><!-- doxytag: member="Measure::getUnit" ref="aca10f62e4a418373e4b1e58e39637d0a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classMeasureUnit.html">MeasureUnit</a> & Measure::getUnit </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a reference to the unit of this object. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002759">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
<p>Definition at line <a class="el" href="measure_8h_source.html#l00130">130</a> of file <a class="el" href="measure_8h_source.html">measure.h</a>.</p>
<p>Referenced by <a class="el" href="curramt_8h_source.html#l00119">CurrencyAmount::getCurrency()</a>.</p>
</div>
</div>
<a class="anchor" id="a94221e3ffde5706e1f28e0a558f34981"></a><!-- doxytag: member="Measure::operator=" ref="a94221e3ffde5706e1f28e0a558f34981" args="(const Measure &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classMeasure.html">Measure</a>& Measure::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classMeasure.html">Measure</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#_stable002754">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
<p>Reimplemented in <a class="el" href="classCurrencyAmount.html#a715828f7d013aa777e091730ac2d33b7">CurrencyAmount</a>, and <a class="el" href="classTimeUnitAmount.html#a5fdb0e061c56daa1fc96726754dc6007">TimeUnitAmount</a>.</p>
</div>
</div>
<a class="anchor" id="a43d8a81cfbbda7c050b7c4c38732c94d"></a><!-- doxytag: member="Measure::operator==" ref="a43d8a81cfbbda7c050b7c4c38732c94d" 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> Measure::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</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#_stable002757">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
<p>Reimplemented in <a class="el" href="classTimeUnitAmount.html#a84c5fe992d837b3741c0eedd5d0d022f">TimeUnitAmount</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="measure_8h_source.html">measure.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
>
130
