JezK
Edit File: classnumber_1_1FormattedNumber.html
<!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.14"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>ICU 60.1: icu::number::FormattedNumber 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 60.1  <span id="projectnumber">60.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.14 --> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',false,false,'search.php','Search'); }); /* @license-end */</script> <div id="main-nav"></div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceicu.html">icu</a></li><li class="navelem"><b>number</b></li><li class="navelem"><a class="el" href="classicu_1_1number_1_1FormattedNumber.html">FormattedNumber</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#friends">Friends</a> </div> <div class="headertitle"> <div class="title">icu::number::FormattedNumber Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>The result of a number formatting operation. <a href="classicu_1_1number_1_1FormattedNumber.html#details">More...</a></p> <p><code>#include <<a class="el" href="numberformatter_8h_source.html">numberformatter.h</a>></code></p> <div class="dynheader"> Inheritance diagram for icu::number::FormattedNumber:</div> <div class="dyncontent"> <div class="center"> <img src="classicu_1_1number_1_1FormattedNumber.png" usemap="#icu::number::FormattedNumber_map" alt=""/> <map id="icu::number::FormattedNumber_map" name="icu::number::FormattedNumber_map"> <area href="classicu_1_1UMemory.html" title="UMemory is the common ICU base class. " alt="icu::UMemory" shape="rect" coords="0,0,183,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:a90879163568aaa20b23d0df36171d69c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1number_1_1FormattedNumber.html#a90879163568aaa20b23d0df36171d69c">toString</a> () const</td></tr> <tr class="memdesc:a90879163568aaa20b23d0df36171d69c"><td class="mdescLeft"> </td><td class="mdescRight">Returns a <a class="el" href="classicu_1_1UnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a> representation of the formatted number. <a href="#a90879163568aaa20b23d0df36171d69c">More...</a><br /></td></tr> <tr class="separator:a90879163568aaa20b23d0df36171d69c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5e2eb957ee505291eeed7346844f55b8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1Appendable.html">Appendable</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1number_1_1FormattedNumber.html#a5e2eb957ee505291eeed7346844f55b8">appendTo</a> (<a class="el" href="classicu_1_1Appendable.html">Appendable</a> &appendable)</td></tr> <tr class="memdesc:a5e2eb957ee505291eeed7346844f55b8"><td class="mdescLeft"> </td><td class="mdescRight">Appends the formatted number to an <a class="el" href="classicu_1_1Appendable.html" title="Base class for objects to which Unicode characters and strings can be appended. ">Appendable</a>. <a href="#a5e2eb957ee505291eeed7346844f55b8">More...</a><br /></td></tr> <tr class="separator:a5e2eb957ee505291eeed7346844f55b8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8d619ad6fd81da5191b1f6a001cf55aa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1number_1_1FormattedNumber.html#a8d619ad6fd81da5191b1f6a001cf55aa">populateFieldPosition</a> (<a class="el" href="classicu_1_1FieldPosition.html">FieldPosition</a> &fieldPosition, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr> <tr class="memdesc:a8d619ad6fd81da5191b1f6a001cf55aa"><td class="mdescLeft"> </td><td class="mdescRight">Determine the start and end indices of the first occurrence of the given <em>field</em> in the output string. <a href="#a8d619ad6fd81da5191b1f6a001cf55aa">More...</a><br /></td></tr> <tr class="separator:a8d619ad6fd81da5191b1f6a001cf55aa"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae11233f56123263098464e81a1c11e86"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1number_1_1FormattedNumber.html#ae11233f56123263098464e81a1c11e86">populateFieldPositionIterator</a> (<a class="el" href="classicu_1_1FieldPositionIterator.html">FieldPositionIterator</a> &iterator, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr> <tr class="memdesc:ae11233f56123263098464e81a1c11e86"><td class="mdescLeft"> </td><td class="mdescRight">Export the formatted number to a <a class="el" href="classicu_1_1FieldPositionIterator.html" title="FieldPositionIterator returns the field ids and their start/limit positions generated by a call to Fo...">FieldPositionIterator</a>. <a href="#ae11233f56123263098464e81a1c11e86">More...</a><br /></td></tr> <tr class="separator:ae11233f56123263098464e81a1c11e86"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac4d706a0a9881bd88c4d233bcd83cb51"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1number_1_1FormattedNumber.html#ac4d706a0a9881bd88c4d233bcd83cb51">~FormattedNumber</a> ()</td></tr> <tr class="memdesc:ac4d706a0a9881bd88c4d233bcd83cb51"><td class="mdescLeft"> </td><td class="mdescRight">Destruct an instance of <a class="el" href="classicu_1_1number_1_1FormattedNumber.html" title="The result of a number formatting operation. ">FormattedNumber</a>, cleaning up any memory it might own. <a href="#ac4d706a0a9881bd88c4d233bcd83cb51">More...</a><br /></td></tr> <tr class="separator:ac4d706a0a9881bd88c4d233bcd83cb51"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> Friends</h2></td></tr> <tr class="memitem:a467d78050c95e8f4fafef2d416818f95"><td class="memItemLeft" align="right" valign="top"><a id="a467d78050c95e8f4fafef2d416818f95"></a> class </td><td class="memItemRight" valign="bottom"><b>LocalizedNumberFormatter</b></td></tr> <tr class="separator:a467d78050c95e8f4fafef2d416818f95"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>The result of a number formatting operation. </p> <p>This class allows the result to be exported in several data types, including a <a class="el" href="classicu_1_1UnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a> and a <a class="el" href="classicu_1_1FieldPositionIterator.html" title="FieldPositionIterator returns the field ids and their start/limit positions generated by a call to Fo...">FieldPositionIterator</a>.</p> <dl class="draft"><dt><b><a class="el" href="draft.html#_draft000135">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 60 </dd></dl> <p class="definition">Definition at line <a class="el" href="numberformatter_8h_source.html#l01876">1876</a> of file <a class="el" href="numberformatter_8h_source.html">numberformatter.h</a>.</p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a id="ac4d706a0a9881bd88c4d233bcd83cb51"></a> <h2 class="memtitle"><span class="permalink"><a href="#ac4d706a0a9881bd88c4d233bcd83cb51">◆ </a></span>~FormattedNumber()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">icu::number::FormattedNumber::~FormattedNumber </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Destruct an instance of <a class="el" href="classicu_1_1number_1_1FormattedNumber.html" title="The result of a number formatting operation. ">FormattedNumber</a>, cleaning up any memory it might own. </p> <dl class="draft"><dt><b><a class="el" href="draft.html#_draft000185">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 60 </dd></dl> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a id="a5e2eb957ee505291eeed7346844f55b8"></a> <h2 class="memtitle"><span class="permalink"><a href="#a5e2eb957ee505291eeed7346844f55b8">◆ </a></span>appendTo()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classicu_1_1Appendable.html">Appendable</a>& icu::number::FormattedNumber::appendTo </td> <td>(</td> <td class="paramtype"><a class="el" href="classicu_1_1Appendable.html">Appendable</a> & </td> <td class="paramname"><em>appendable</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Appends the formatted number to an <a class="el" href="classicu_1_1Appendable.html" title="Base class for objects to which Unicode characters and strings can be appended. ">Appendable</a>. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">appendable</td><td>The <a class="el" href="classicu_1_1Appendable.html" title="Base class for objects to which Unicode characters and strings can be appended. ">Appendable</a> to which to append the formatted number string. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The same <a class="el" href="classicu_1_1Appendable.html" title="Base class for objects to which Unicode characters and strings can be appended. ">Appendable</a>, for chaining. </dd></dl> <dl class="draft"><dt><b><a class="el" href="draft.html#_draft000182">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 60 </dd></dl> <dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1Appendable.html" title="Base class for objects to which Unicode characters and strings can be appended. ">Appendable</a> </dd></dl> </div> </div> <a id="a8d619ad6fd81da5191b1f6a001cf55aa"></a> <h2 class="memtitle"><span class="permalink"><a href="#a8d619ad6fd81da5191b1f6a001cf55aa">◆ </a></span>populateFieldPosition()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void icu::number::FormattedNumber::populateFieldPosition </td> <td>(</td> <td class="paramtype"><a class="el" href="classicu_1_1FieldPosition.html">FieldPosition</a> & </td> <td class="paramname"><em>fieldPosition</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> </div><div class="memdoc"> <p>Determine the start and end indices of the first occurrence of the given <em>field</em> in the output string. </p> <p>This allows you to determine the locations of the integer part, fraction part, and sign.</p> <p>If multiple different field attributes are needed, this method can be called repeatedly, or if <em>all</em> field attributes are needed, consider using <a class="el" href="classicu_1_1number_1_1FormattedNumber.html#ae11233f56123263098464e81a1c11e86" title="Export the formatted number to a FieldPositionIterator. ">populateFieldPositionIterator()</a>.</p> <p>If a field occurs multiple times in an output string, such as a grouping separator, this method will only ever return the first occurrence. Use <a class="el" href="classicu_1_1number_1_1FormattedNumber.html#ae11233f56123263098464e81a1c11e86" title="Export the formatted number to a FieldPositionIterator. ">populateFieldPositionIterator()</a> to access all occurrences of an attribute.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">fieldPosition</td><td>The <a class="el" href="classicu_1_1FieldPosition.html" title="FieldPosition is a simple class used by Format and its subclasses to identify fields in formatted out...">FieldPosition</a> to populate with the start and end indices of the desired field. </td></tr> <tr><td class="paramname">status</td><td>Set if an error occurs while populating the <a class="el" href="classicu_1_1FieldPosition.html" title="FieldPosition is a simple class used by Format and its subclasses to identify fields in formatted out...">FieldPosition</a>. </td></tr> </table> </dd> </dl> <dl class="draft"><dt><b><a class="el" href="draft.html#_draft000183">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 60 </dd></dl> <dl class="section see"><dt>See also</dt><dd><a class="el" href="unum_8h.html#a491494a412a061fbfccb7f7622514856" title="FieldPosition and UFieldPosition selectors for format fields defined by NumberFormat and UNumberForma...">UNumberFormatFields</a> </dd></dl> </div> </div> <a id="ae11233f56123263098464e81a1c11e86"></a> <h2 class="memtitle"><span class="permalink"><a href="#ae11233f56123263098464e81a1c11e86">◆ </a></span>populateFieldPositionIterator()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void icu::number::FormattedNumber::populateFieldPositionIterator </td> <td>(</td> <td class="paramtype"><a class="el" href="classicu_1_1FieldPositionIterator.html">FieldPositionIterator</a> & </td> <td class="paramname"><em>iterator</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> </div><div class="memdoc"> <p>Export the formatted number to a <a class="el" href="classicu_1_1FieldPositionIterator.html" title="FieldPositionIterator returns the field ids and their start/limit positions generated by a call to Fo...">FieldPositionIterator</a>. </p> <p>This allows you to determine which characters in the output string correspond to which <em>fields</em>, such as the integer part, fraction part, and sign.</p> <p>If information on only one field is needed, consider using <a class="el" href="classicu_1_1number_1_1FormattedNumber.html#a8d619ad6fd81da5191b1f6a001cf55aa" title="Determine the start and end indices of the first occurrence of the given field in the output string...">populateFieldPosition()</a> instead.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">iterator</td><td>The <a class="el" href="classicu_1_1FieldPositionIterator.html" title="FieldPositionIterator returns the field ids and their start/limit positions generated by a call to Fo...">FieldPositionIterator</a> to populate with all of the fields present in the formatted number. </td></tr> <tr><td class="paramname">status</td><td>Set if an error occurs while populating the <a class="el" href="classicu_1_1FieldPositionIterator.html" title="FieldPositionIterator returns the field ids and their start/limit positions generated by a call to Fo...">FieldPositionIterator</a>. </td></tr> </table> </dd> </dl> <dl class="draft"><dt><b><a class="el" href="draft.html#_draft000184">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 60 </dd></dl> <dl class="section see"><dt>See also</dt><dd><a class="el" href="unum_8h.html#a491494a412a061fbfccb7f7622514856" title="FieldPosition and UFieldPosition selectors for format fields defined by NumberFormat and UNumberForma...">UNumberFormatFields</a> </dd></dl> </div> </div> <a id="a90879163568aaa20b23d0df36171d69c"></a> <h2 class="memtitle"><span class="permalink"><a href="#a90879163568aaa20b23d0df36171d69c">◆ </a></span>toString()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> icu::number::FormattedNumber::toString </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Returns a <a class="el" href="classicu_1_1UnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a> representation of the formatted number. </p> <dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="classicu_1_1UnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a> containing the localized number. </dd></dl> <dl class="draft"><dt><b><a class="el" href="draft.html#_draft000181">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 60 </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="numberformatter_8h_source.html">numberformatter.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.14 </small></address> </body> </html>