Sophie

Sophie

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

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::Problem::const_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="a00134.html">Problem</a>::<a class="el" href="a00039.html">const_iterator</a>
  </div>
</div>
<div class="contents">
<h1>frepple::Problem::const_iterator Class Reference</h1><!-- doxytag: class="frepple::Problem::const_iterator" -->
<p>This class models an STL-like iterator 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="a00218_source.html">model.h</a>&gt;</code></p>

<p><a href="a00485.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="a00039.html#a14112b5e3795720fca97e368b0007771">const_iterator</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00039.html#a26194b0b6de52d51822ad62dbd88a4d6">const_iterator</a> (<a class="el" href="a00134.html">Problem</a> *o)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00039.html#a13d6132ae640194d27956bfbbc54a909">const_iterator</a> (<a class="el" href="a00086.html">HasProblems</a> *o)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00039.html#a1fd734be62a43f00e5716376c83a67f9">operator!=</a> (const <a class="el" href="a00039.html">const_iterator</a> &amp;t) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00134.html">Problem</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00039.html#ac75f7ef117269859cf682a410bb9997f">operator*</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00039.html">const_iterator</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00039.html#ab31d6402106b61baaefbe494f3bc927d">operator++</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00134.html">Problem</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00039.html#a11809bc86772d033e574d12166917748">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="a00039.html#adc0643f9584e3c341b63afbb84c71ba6">operator==</a> (const <a class="el" href="a00039.html">const_iterator</a> &amp;t) const </td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00039.html#acc081cc87e465ee811f25f9676550d09">Problem</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This class models an STL-like iterator that allows us to iterate over the named entities in a simple and safe way. </p>
<p>Objects of this class are returned by the <a class="el" href="a00134.html#a1532b2bb7078ebcd527a8bf332ffb861">begin()</a> and <a class="el" href="a00134.html#ae3fc9d1129b3e956ac2c9ec6c54035d8">end()</a> functions. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00134.html#a1532b2bb7078ebcd527a8bf332ffb861">Problem::begin()</a> </dd>
<dd>
Problem::begin(HasProblem*) </dd>
<dd>
<a class="el" href="a00134.html#ae3fc9d1129b3e956ac2c9ec6c54035d8">Problem::end()</a> </dd></dl>

<p>Definition at line <a class="el" href="a00218_source.html#l05661">5661</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="a13d6132ae640194d27956bfbbc54a909"></a><!-- doxytag: member="frepple::Problem::const_iterator::const_iterator" ref="a13d6132ae640194d27956bfbbc54a909" args="(HasProblems *o)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">frepple::Problem::const_iterator::const_iterator </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00086.html">HasProblems</a> *&nbsp;</td>
          <td class="paramname"> <em>o</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, explicit]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Creates an iterator that will loop through the problems of a single entity only. <br/>
 This constructor is also used to create a end-iterator, when passed a NULL pointer as argument. </p>

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

</div>
</div>
<a class="anchor" id="a26194b0b6de52d51822ad62dbd88a4d6"></a><!-- doxytag: member="frepple::Problem::const_iterator::const_iterator" ref="a26194b0b6de52d51822ad62dbd88a4d6" args="(Problem *o)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">frepple::Problem::const_iterator::const_iterator </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00134.html">Problem</a> *&nbsp;</td>
          <td class="paramname"> <em>o</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, explicit]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Creates an iterator that will loop through the constraints of a demand. </p>

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

</div>
</div>
<a class="anchor" id="a14112b5e3795720fca97e368b0007771"></a><!-- doxytag: member="frepple::Problem::const_iterator::const_iterator" ref="a14112b5e3795720fca97e368b0007771" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">frepple::Problem::const_iterator::const_iterator </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, explicit]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Creates an iterator that will loop through the problems of all entities. </p>

<p>Definition at line <a class="el" href="a00218_source.html#l05688">5688</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="a1fd734be62a43f00e5716376c83a67f9"></a><!-- doxytag: member="frepple::Problem::const_iterator::operator!=" ref="a1fd734be62a43f00e5716376c83a67f9" args="(const const_iterator &amp;t) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool frepple::Problem::const_iterator::operator!= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00039.html">const_iterator</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>t</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#l05701">5701</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="ac75f7ef117269859cf682a410bb9997f"></a><!-- doxytag: member="frepple::Problem::const_iterator::operator*" ref="ac75f7ef117269859cf682a410bb9997f" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00134.html">Problem</a>&amp; frepple::Problem::const_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>Definition at line <a class="el" href="a00218_source.html#l05706">5706</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="ab31d6402106b61baaefbe494f3bc927d"></a><!-- doxytag: member="frepple::Problem::const_iterator::operator++" ref="ab31d6402106b61baaefbe494f3bc927d" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00039.html">Problem::const_iterator</a> &amp; frepple::Problem::const_iterator::operator++ </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Pre-increment operator. </p>

<p>Definition at line <a class="el" href="a00227_source.html#l00493">493</a> of file <a class="el" href="a00227_source.html">problem.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a11809bc86772d033e574d12166917748"></a><!-- doxytag: member="frepple::Problem::const_iterator::operator&#45;&gt;" ref="a11809bc86772d033e574d12166917748" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00134.html">Problem</a>* frepple::Problem::const_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>Definition at line <a class="el" href="a00218_source.html#l05707">5707</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="adc0643f9584e3c341b63afbb84c71ba6"></a><!-- doxytag: member="frepple::Problem::const_iterator::operator==" ref="adc0643f9584e3c341b63afbb84c71ba6" args="(const const_iterator &amp;t) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool frepple::Problem::const_iterator::operator== </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00039.html">const_iterator</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>t</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Equality operator. </p>

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

</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="acc081cc87e465ee811f25f9676550d09"></a><!-- doxytag: member="frepple::Problem::const_iterator::Problem" ref="acc081cc87e465ee811f25f9676550d09" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">friend class <a class="el" href="a00134.html">Problem</a><code> [friend]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="a00218_source.html#l05663">5663</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 files:<ul>
<li><a class="el" href="a00218_source.html">model.h</a></li>
<li><a class="el" href="a00227_source.html">problem.cpp</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>