Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > 54cac1c2268db633d66eeff1b4faa585 > files > 370

frepple-doc-0.8.1-3.fc15.noarch.rpm

<!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>C++ API frePPLe: frepple::utils::HasName&lt; T &gt;::iterator Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="../styles.css" rel="stylesheet"  type="text/css">
</head>
<body>
<div id="container">

<div id="menubar"> 
<div id="logo" align="center">
<br/><img src='../frepple.bmp' alt="frepple" /><br/>
<a href='http://www.frepple.com/'>
<strong>a Free<br/>Production Planning<br/>Library</strong>
</a>
</div>
<div id="menu">
<br/>
<h3><a href='../Main/HomePage.html'>Main</a></h3>
<h3><a href='../UI/Main.html'>User Manual</a></h3>
<h3><a href='../Tutorial/Main.html'>Tutorial</a></h3>
<h3><a href='../Frepple/Main.html'>Reference Manual</a></h3>
<h3><a href='../Main/FAQ.html'>FAQ</a></h3>
<h3><a href='index.html'>C++ API</a></h3>
<br/>
</div>  
</div>

<div id="content">
<br/>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="a00256.html">frepple</a>::<a class="el" href="a00257.html">utils</a>::<a class="el" href="a00085.html">HasName</a>::<a class="el" href="a00094.html">iterator</a>
  </div>
</div>
<div class="contents">
<h1>frepple::utils::HasName&lt; T &gt;::iterator Class Reference</h1><!-- doxytag: class="frepple::utils::HasName::iterator" -->
<p>This class models a STL-like <a class="el" href="a00094.html" title="This class models a STL-like iterator that allows us to iterate over the named entities...">iterator</a> that allows us to iterate over the named entities in a simple and safe way.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00252_source.html">utils.h</a>&gt;</code></p>

<p><a href="a00594.html">List of all members.</a></p>
<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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00094.html#aee33fdbfc73495f056ff833ac8f277af">iterator</a> (const <a class="el" href="a00094.html">iterator</a> &amp;it)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00094.html#a80e9fe962543a304fd6ba54f71c0e57a">iterator</a> (<a class="el" href="a00182.html">Tree::TreeNode</a> *x)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00094.html#a17609bf0dba195ec8a2d08f714e58146">operator!=</a> (const <a class="el" href="a00094.html">iterator</a> &amp;y) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00094.html#a0ead0ea001dde38f630ba077fae747bc">operator*</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00094.html">iterator</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00094.html#a30975efffcd0e6c5c33ddb32095a5d4e">operator++</a> (int)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00094.html">iterator</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00094.html#a43a868e6064e13e51d07237024b261f4">operator++</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00094.html">iterator</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00094.html#a5cd62468dce145f1082c57bdd9fdd59d">operator--</a> (int)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00094.html">iterator</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00094.html#a6d031085c22ba190ddadf7774c5d2e4a">operator--</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00094.html#aca3f99686c799590bae74ff74b4ea269">operator-&gt;</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00094.html#a0cd402edc53364e4136c64eee0d7de64">operator==</a> (const <a class="el" href="a00094.html">iterator</a> &amp;y) const </td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class T&gt;<br/>
 class frepple::utils::HasName&lt; T &gt;::iterator</h3>

<p>This class models a STL-like <a class="el" href="a00094.html" title="This class models a STL-like iterator that allows us to iterate over the named entities...">iterator</a> that allows us to iterate over the named entities in a simple and safe way. </p>
<p>Objects of this class are created by the <a class="el" href="a00085.html#a1926a798edd9c04bc37e596936003cd6">begin()</a> and <a class="el" href="a00085.html#abb9d04973550ac71037718511358f2ff">end()</a> functions.  </p>

<p>Definition at line <a class="el" href="a00252_source.html#l04511">4511</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a80e9fe962543a304fd6ba54f71c0e57a"></a><!-- doxytag: member="frepple::utils::HasName::iterator::iterator" ref="a80e9fe962543a304fd6ba54f71c0e57a" args="(Tree::TreeNode *x)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00085.html">frepple::utils::HasName</a>&lt; T &gt;::iterator::iterator </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00182.html">Tree::TreeNode</a> *&nbsp;</td>
          <td class="paramname"> <em>x</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Constructor. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l04515">4515</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="aee33fdbfc73495f056ff833ac8f277af"></a><!-- doxytag: member="frepple::utils::HasName::iterator::iterator" ref="aee33fdbfc73495f056ff833ac8f277af" args="(const iterator &amp;it)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00085.html">frepple::utils::HasName</a>&lt; T &gt;::iterator::iterator </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00094.html">iterator</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>it</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Copy constructor. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l04518">4518</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a17609bf0dba195ec8a2d08f714e58146"></a><!-- doxytag: member="frepple::utils::HasName::iterator::operator!=" ref="a17609bf0dba195ec8a2d08f714e58146" args="(const iterator &amp;y) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="a00085.html">frepple::utils::HasName</a>&lt; T &gt;::iterator::operator!= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00094.html">iterator</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>y</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Inequality operator. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l04556">4556</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="a0ead0ea001dde38f630ba077fae747bc"></a><!-- doxytag: member="frepple::utils::HasName::iterator::operator*" ref="a0ead0ea001dde38f630ba077fae747bc" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">T&amp; <a class="el" href="a00085.html">frepple::utils::HasName</a>&lt; T &gt;::iterator::operator* </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return the content of the current node. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l04521">4521</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="a30975efffcd0e6c5c33ddb32095a5d4e"></a><!-- doxytag: member="frepple::utils::HasName::iterator::operator++" ref="a30975efffcd0e6c5c33ddb32095a5d4e" args="(int)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00094.html">iterator</a> <a class="el" href="a00085.html">frepple::utils::HasName</a>&lt; T &gt;::iterator::operator++ </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Post-increment operator which moves the pointer to the next element. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l04532">4532</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="a43a868e6064e13e51d07237024b261f4"></a><!-- doxytag: member="frepple::utils::HasName::iterator::operator++" ref="a43a868e6064e13e51d07237024b261f4" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00094.html">iterator</a>&amp; <a class="el" href="a00085.html">frepple::utils::HasName</a>&lt; T &gt;::iterator::operator++ </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Pre-increment operator which moves the pointer to the next element. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l04528">4528</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="a5cd62468dce145f1082c57bdd9fdd59d"></a><!-- doxytag: member="frepple::utils::HasName::iterator::operator&#45;&#45;" ref="a5cd62468dce145f1082c57bdd9fdd59d" args="(int)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00094.html">iterator</a> <a class="el" href="a00085.html">frepple::utils::HasName</a>&lt; T &gt;::iterator::operator-- </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Post-decrement operator which moves the pointer to the previous element. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l04545">4545</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="a6d031085c22ba190ddadf7774c5d2e4a"></a><!-- doxytag: member="frepple::utils::HasName::iterator::operator&#45;&#45;" ref="a6d031085c22ba190ddadf7774c5d2e4a" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00094.html">iterator</a>&amp; <a class="el" href="a00085.html">frepple::utils::HasName</a>&lt; T &gt;::iterator::operator-- </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Pre-decrement operator which moves the pointer to the previous element. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l04541">4541</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="aca3f99686c799590bae74ff74b4ea269"></a><!-- doxytag: member="frepple::utils::HasName::iterator::operator&#45;&gt;" ref="aca3f99686c799590bae74ff74b4ea269" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">T* <a class="el" href="a00085.html">frepple::utils::HasName</a>&lt; T &gt;::iterator::operator-&gt; </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return the content of the current node. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l04524">4524</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<a class="anchor" id="a0cd402edc53364e4136c64eee0d7de64"></a><!-- doxytag: member="frepple::utils::HasName::iterator::operator==" ref="a0cd402edc53364e4136c64eee0d7de64" args="(const iterator &amp;y) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="a00085.html">frepple::utils::HasName</a>&lt; T &gt;::iterator::operator== </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00094.html">iterator</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>y</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Comparison operator. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l04553">4553</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00252_source.html">utils.h</a></li>
</ul>
</div>
<hr size="1"/><address style="align: right;"><small>Documentation generated for frePPLe by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"/></a></small></address>
</div>
</div>
</body>
</html>