<!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.11"/> <title>ICU 58.2: icu::FieldPositionIterator 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 58.2  <span id="projectnumber">58.2</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.11 --> <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_1FieldPositionIterator.html">FieldPositionIterator</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::FieldPositionIterator Class Reference</div> </div> </div><!--header--> <div class="contents"> <p><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> returns the field ids and their start/limit positions generated by a call to <a class="el" href="classicu_1_1Format.html#ab510bded8f13465d98b950db03f15297" title="Formats an object to produce a string. ">Format::format</a>. <a href="classicu_1_1FieldPositionIterator.html#details">More...</a></p> <p><code>#include <<a class="el" href="fpositer_8h_source.html">fpositer.h</a>></code></p> <div class="dynheader"> Inheritance diagram for icu::FieldPositionIterator:</div> <div class="dyncontent"> <div class="center"> <img src="classicu_1_1FieldPositionIterator.png" usemap="#icu::FieldPositionIterator_map" alt=""/> <map id="icu::FieldPositionIterator_map" name="icu::FieldPositionIterator_map"> <area href="classicu_1_1UObject.html" title="UObject is the common ICU "boilerplate" class. " alt="icu::UObject" shape="rect" coords="0,56,147,80"/> <area href="classicu_1_1UMemory.html" title="UMemory is the common ICU base class. " alt="icu::UMemory" shape="rect" coords="0,0,147,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:a43ba850dce5e96fb75794b8b8b4df5d3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1FieldPositionIterator.html#a43ba850dce5e96fb75794b8b8b4df5d3">~FieldPositionIterator</a> ()</td></tr> <tr class="memdesc:a43ba850dce5e96fb75794b8b8b4df5d3"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a43ba850dce5e96fb75794b8b8b4df5d3">More...</a><br /></td></tr> <tr class="separator:a43ba850dce5e96fb75794b8b8b4df5d3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a493cb4b2512dbf54f3e9f88fc377221e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1FieldPositionIterator.html#a493cb4b2512dbf54f3e9f88fc377221e">FieldPositionIterator</a> (void)</td></tr> <tr class="memdesc:a493cb4b2512dbf54f3e9f88fc377221e"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new, empty iterator. <a href="#a493cb4b2512dbf54f3e9f88fc377221e">More...</a><br /></td></tr> <tr class="separator:a493cb4b2512dbf54f3e9f88fc377221e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a01fdbf54484e3a4ef32a57683c346dbf"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1FieldPositionIterator.html#a01fdbf54484e3a4ef32a57683c346dbf">FieldPositionIterator</a> (const <a class="el" href="classicu_1_1FieldPositionIterator.html">FieldPositionIterator</a> &)</td></tr> <tr class="memdesc:a01fdbf54484e3a4ef32a57683c346dbf"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#a01fdbf54484e3a4ef32a57683c346dbf">More...</a><br /></td></tr> <tr class="separator:a01fdbf54484e3a4ef32a57683c346dbf"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a61f92ffe12627d981c402a9a9a620fa7"><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_1FieldPositionIterator.html#a61f92ffe12627d981c402a9a9a620fa7">operator==</a> (const <a class="el" href="classicu_1_1FieldPositionIterator.html">FieldPositionIterator</a> &) const </td></tr> <tr class="memdesc:a61f92ffe12627d981c402a9a9a620fa7"><td class="mdescLeft"> </td><td class="mdescRight">Return true if another object is semantically equal to this one. <a href="#a61f92ffe12627d981c402a9a9a620fa7">More...</a><br /></td></tr> <tr class="separator:a61f92ffe12627d981c402a9a9a620fa7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a99b7caadf0c6b19336ed1e6b3a6c5ef5"><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_1FieldPositionIterator.html#a99b7caadf0c6b19336ed1e6b3a6c5ef5">operator!=</a> (const <a class="el" href="classicu_1_1FieldPositionIterator.html">FieldPositionIterator</a> &rhs) const </td></tr> <tr class="memdesc:a99b7caadf0c6b19336ed1e6b3a6c5ef5"><td class="mdescLeft"> </td><td class="mdescRight">Returns the complement of the result of operator==. <a href="#a99b7caadf0c6b19336ed1e6b3a6c5ef5">More...</a><br /></td></tr> <tr class="separator:a99b7caadf0c6b19336ed1e6b3a6c5ef5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2cd32dd34628434dfa7080be0c0a8549"><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_1FieldPositionIterator.html#a2cd32dd34628434dfa7080be0c0a8549">next</a> (<a class="el" href="classicu_1_1FieldPosition.html">FieldPosition</a> &fp)</td></tr> <tr class="memdesc:a2cd32dd34628434dfa7080be0c0a8549"><td class="mdescLeft"> </td><td class="mdescRight">If the current position is valid, updates 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> values, advances the iterator, and returns TRUE, otherwise returns FALSE. <a href="#a2cd32dd34628434dfa7080be0c0a8549">More...</a><br /></td></tr> <tr class="separator:a2cd32dd34628434dfa7080be0c0a8549"><td class="memSeparator" colspan="2"> </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">More...</a><br /></td></tr> <tr class="separator:af10026497704f510d3d1f2eff50acb18 inherit pub_methods_classicu_1_1UObject"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1aa93096e880907080b503ff1fb0f8bc inherit pub_methods_classicu_1_1UObject"><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_1UObject.html#a1aa93096e880907080b503ff1fb0f8bc">getDynamicClassID</a> () const </td></tr> <tr class="memdesc:a1aa93096e880907080b503ff1fb0f8bc inherit pub_methods_classicu_1_1UObject"><td class="mdescLeft"> </td><td class="mdescRight">ICU4C "poor man's RTTI", returns a UClassID for the actual ICU class. <a href="#a1aa93096e880907080b503ff1fb0f8bc">More...</a><br /></td></tr> <tr class="separator:a1aa93096e880907080b503ff1fb0f8bc inherit pub_methods_classicu_1_1UObject"><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:a521af666ba6670f8c8a975d22cc0400a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a521af666ba6670f8c8a975d22cc0400a"></a> class </td><td class="memItemRight" valign="bottom"><b>FieldPositionIteratorHandler</b></td></tr> <tr class="separator:a521af666ba6670f8c8a975d22cc0400a"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p><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> returns the field ids and their start/limit positions generated by a call to <a class="el" href="classicu_1_1Format.html#ab510bded8f13465d98b950db03f15297" title="Formats an object to produce a string. ">Format::format</a>. </p> <p>See <a class="el" href="classicu_1_1Format.html" title="Base class for all formats. ">Format</a>, <a class="el" href="classicu_1_1NumberFormat.html" title="Abstract base class for all number formats. ">NumberFormat</a>, <a class="el" href="classicu_1_1DecimalFormat.html" title="DecimalFormat is a concrete subclass of NumberFormat that formats decimal numbers. ">DecimalFormat</a>. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable003674">Stable:</a></b></dt><dd>ICU 4.4 </dd></dl> <p>Definition at line <a class="el" href="fpositer_8h_source.html#l00055">55</a> of file <a class="el" href="fpositer_8h_source.html">fpositer.h</a>.</p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="a43ba850dce5e96fb75794b8b8b4df5d3"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">icu::FieldPositionIterator::~FieldPositionIterator </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Destructor. </p> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable003675">Stable:</a></b></dt><dd>ICU 4.4 </dd></dl> </div> </div> <a class="anchor" id="a493cb4b2512dbf54f3e9f88fc377221e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">icu::FieldPositionIterator::FieldPositionIterator </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Constructs a new, empty iterator. </p> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable003676">Stable:</a></b></dt><dd>ICU 4.4 </dd></dl> </div> </div> <a class="anchor" id="a01fdbf54484e3a4ef32a57683c346dbf"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">icu::FieldPositionIterator::FieldPositionIterator </td> <td>(</td> <td class="paramtype">const <a class="el" href="classicu_1_1FieldPositionIterator.html">FieldPositionIterator</a> & </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Copy constructor. </p> <p>If the copy failed for some reason, the new iterator will be empty. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable003677">Stable:</a></b></dt><dd>ICU 4.4 </dd></dl> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a2cd32dd34628434dfa7080be0c0a8549"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> icu::FieldPositionIterator::next </td> <td>(</td> <td class="paramtype"><a class="el" href="classicu_1_1FieldPosition.html">FieldPosition</a> & </td> <td class="paramname"><em>fp</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>If the current position is valid, updates 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> values, advances the iterator, and returns TRUE, otherwise returns FALSE. </p> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable003680">Stable:</a></b></dt><dd>ICU 4.4 </dd></dl> </div> </div> <a class="anchor" id="a99b7caadf0c6b19336ed1e6b3a6c5ef5"></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::FieldPositionIterator::operator!= </td> <td>(</td> <td class="paramtype">const <a class="el" href="classicu_1_1FieldPositionIterator.html">FieldPositionIterator</a> & </td> <td class="paramname"><em>rhs</em></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>Returns the complement of the result of operator==. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">rhs</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 be compared for inequality </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the complement of the result of operator== </dd></dl> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable003679">Stable:</a></b></dt><dd>ICU 4.4 </dd></dl> <p>Definition at line <a class="el" href="fpositer_8h_source.html#l00092">92</a> of file <a class="el" href="fpositer_8h_source.html">fpositer.h</a>.</p> <p>References <a class="el" href="namespaceicu.html#a1c2f6ca43e636f38d1a3291eb851e9f0">icu::operator==()</a>, and <a class="el" href="uversion_8h_source.html#l00132">U_NAMESPACE_END</a>.</p> </div> </div> <a class="anchor" id="a61f92ffe12627d981c402a9a9a620fa7"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> icu::FieldPositionIterator::operator== </td> <td>(</td> <td class="paramtype">const <a class="el" href="classicu_1_1FieldPositionIterator.html">FieldPositionIterator</a> & </td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Return true if another object is semantically equal to this one. </p> <p>Return true if this <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> is at the same position in an equal array of run values. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable003678">Stable:</a></b></dt><dd>ICU 4.4 </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="fpositer_8h_source.html">fpositer.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.11 </small></address> </body> </html>