Sophie

Sophie

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

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::OperationPlan::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="a00125.html">OperationPlan</a>::<a class="el" href="a00093.html">iterator</a>
  </div>
</div>
<div class="contents">
<h1>frepple::OperationPlan::iterator Class Reference</h1><!-- doxytag: class="frepple::OperationPlan::iterator" -->
<p>This class models an STL-like <a class="el" href="a00093.html" title="This class models an STL-like iterator that allows us to iterate over the operationplans...">iterator</a> that allows us to iterate over the operationplans in a simple and safe way.  
<a href="#_details">More...</a></p>

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

<p><a href="a00466.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="a00093.html#a356483c86daa87b18e58c95aa418d1ad">iterator</a> (const <a class="el" href="a00093.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="a00093.html#a3f1583afcfd7f0d6614150674fcb444f">iterator</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00093.html#ab087727f4bbf7d274d3ac8554fef06d9">iterator</a> (const <a class="el" href="a00125.html">OperationPlan</a> *x)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00093.html#a4e6be54a6be8b528d9bffbeaf1fc416d">iterator</a> (const <a class="el" href="a00121.html">Operation</a> *x)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00093.html#a571345ab2155e61434489741acd0eb15">operator!=</a> (const <a class="el" href="a00093.html">iterator</a> &amp;y) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00125.html">OperationPlan</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00093.html#af9e5d60bac2e76872e63b6fe611d6fe6">operator*</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00093.html">iterator</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00093.html#a845b9f200efcb7a527f62453ee9bafc6">operator++</a> (int)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00093.html">iterator</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00093.html#a6a2c15dcd3ae68d6b8229c22719ddb7c">operator++</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00125.html">OperationPlan</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00093.html#adda114d925ea27d4036a700d1e914828">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="a00093.html#aa0a3b43111533e6448309de727238d27">operator==</a> (const <a class="el" href="a00093.html">iterator</a> &amp;y) const </td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This class models an STL-like <a class="el" href="a00093.html" title="This class models an STL-like iterator that allows us to iterate over the operationplans...">iterator</a> that allows us to iterate over the operationplans in a simple and safe way. </p>
<p>Objects of this class are created by the <a class="el" href="a00125.html#a8bd5449992e056b2d637cfe65ac7da1f">begin()</a> and <a class="el" href="a00125.html#a0f9f6ba7d4fe7e20e9b88c765fe24f25">end()</a> functions. </p>

<p>Definition at line <a class="el" href="a00218_source.html#l01912">1912</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a4e6be54a6be8b528d9bffbeaf1fc416d"></a><!-- doxytag: member="frepple::OperationPlan::iterator::iterator" ref="a4e6be54a6be8b528d9bffbeaf1fc416d" args="(const Operation *x)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">frepple::OperationPlan::iterator::iterator </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00121.html">Operation</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. The <a class="el" href="a00093.html" title="This class models an STL-like iterator that allows us to iterate over the operationplans...">iterator</a> will loop only over the operationplans of the operation passed. </p>

<p>Definition at line <a class="el" href="a00218_source.html#l01917">1917</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="ab087727f4bbf7d274d3ac8554fef06d9"></a><!-- doxytag: member="frepple::OperationPlan::iterator::iterator" ref="ab087727f4bbf7d274d3ac8554fef06d9" args="(const OperationPlan *x)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">frepple::OperationPlan::iterator::iterator </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00125.html">OperationPlan</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. The <a class="el" href="a00093.html" title="This class models an STL-like iterator that allows us to iterate over the operationplans...">iterator</a> will loop only over the suboperationplans of the operationplan passed. </p>

<p>Definition at line <a class="el" href="a00218_source.html#l01924">1924</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="a3f1583afcfd7f0d6614150674fcb444f"></a><!-- doxytag: member="frepple::OperationPlan::iterator::iterator" ref="a3f1583afcfd7f0d6614150674fcb444f" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">frepple::OperationPlan::iterator::iterator </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Constructor. The <a class="el" href="a00093.html" title="This class models an STL-like iterator that allows us to iterate over the operationplans...">iterator</a> will loop over all operationplans. </p>

<p>Definition at line <a class="el" href="a00218_source.html#l01930">1930</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="a356483c86daa87b18e58c95aa418d1ad"></a><!-- doxytag: member="frepple::OperationPlan::iterator::iterator" ref="a356483c86daa87b18e58c95aa418d1ad" args="(const iterator &amp;it)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">frepple::OperationPlan::iterator::iterator </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00093.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="a00218_source.html#l01942">1942</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a571345ab2155e61434489741acd0eb15"></a><!-- doxytag: member="frepple::OperationPlan::iterator::operator!=" ref="a571345ab2155e61434489741acd0eb15" args="(const iterator &amp;y) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool frepple::OperationPlan::iterator::operator!= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00093.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="a00218_source.html#l01996">1996</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="af9e5d60bac2e76872e63b6fe611d6fe6"></a><!-- doxytag: member="frepple::OperationPlan::iterator::operator*" ref="af9e5d60bac2e76872e63b6fe611d6fe6" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00125.html">OperationPlan</a>&amp; frepple::OperationPlan::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="a00218_source.html#l01945">1945</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="a845b9f200efcb7a527f62453ee9bafc6"></a><!-- doxytag: member="frepple::OperationPlan::iterator::operator++" ref="a845b9f200efcb7a527f62453ee9bafc6" args="(int)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00093.html">iterator</a> frepple::OperationPlan::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="a00218_source.html#l01973">1973</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="a6a2c15dcd3ae68d6b8229c22719ddb7c"></a><!-- doxytag: member="frepple::OperationPlan::iterator::operator++" ref="a6a2c15dcd3ae68d6b8229c22719ddb7c" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00093.html">iterator</a>&amp; frepple::OperationPlan::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="a00218_source.html#l01952">1952</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="adda114d925ea27d4036a700d1e914828"></a><!-- doxytag: member="frepple::OperationPlan::iterator::operator&#45;&gt;" ref="adda114d925ea27d4036a700d1e914828" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00125.html">OperationPlan</a>* frepple::OperationPlan::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="a00218_source.html#l01948">1948</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="aa0a3b43111533e6448309de727238d27"></a><!-- doxytag: member="frepple::OperationPlan::iterator::operator==" ref="aa0a3b43111533e6448309de727238d27" args="(const iterator &amp;y) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool frepple::OperationPlan::iterator::operator== </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00093.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="a00218_source.html#l01993">1993</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00218_source.html">model.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>