Sophie

Sophie

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

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::FreppleIterator&lt; ME, ITERCLASS, DATACLASS &gt; Class Template 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="a00078.html">FreppleIterator</a>
  </div>
</div>
<div class="contents">
<h1>frepple::utils::FreppleIterator&lt; ME, ITERCLASS, DATACLASS &gt; Class Template Reference</h1><!-- doxytag: class="frepple::utils::FreppleIterator" --><!-- doxytag: inherits="PythonExtension&lt; ME &gt;" -->
<p>A template class to expose iterators to Python.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00252_source.html">utils.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for frepple::utils::FreppleIterator&lt; ME, ITERCLASS, DATACLASS &gt;:</div>
<div class="dynsection">
<div class="center"><img src="a00579.png" border="0" usemap="#frepple_1_1utils_1_1_frepple_iterator_3_01_m_e_00_01_i_t_e_r_c_l_a_s_s_00_01_d_a_t_a_c_l_a_s_s_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1utils_1_1_frepple_iterator_3_01_m_e_00_01_i_t_e_r_c_l_a_s_s_00_01_d_a_t_a_c_l_a_s_s_01_4_inherit__map" id="frepple_1_1utils_1_1_frepple_iterator_3_01_m_e_00_01_i_t_e_r_c_l_a_s_s_00_01_d_a_t_a_c_l_a_s_s_01_4_inherit__map">
<area shape="rect" id="node2" href="a00150.html" title="frepple::utils::PythonExtension\&lt; ME \&gt;" alt="" coords="109,83,352,111"/>
<area shape="rect" id="node4" href="a00151.html" title="This is a base class for all Python extension types." alt="" coords="5,6,232,34"/>
<area shape="rect" id="node6" href="a00119.html" title="Class NonCopyable is a base class. Derive your own class from it when you want to..." alt="" coords="256,6,432,34"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="a00580.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="memTemplParams" colspan="2">template&lt;class OTHER &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00078.html#a34c9b8c275b9d2ca32cd4e890a6f1064">FreppleIterator</a> (const OTHER &amp;o)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;class OTHER &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00078.html#a9f4eb10d871e65b5e250cb625305a811">FreppleIterator</a> (const OTHER *o)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#aac6b9d90292b7d3cc1bf125dbc35499a">FreppleIterator</a> ()</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static PyObject *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#ab493ad29bb7de9027770c1cb38c278fb">create</a> (PyObject *self, PyObject *args)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#acb8dad5955431c6d2b5f89dea7ac3018">initialize</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class ME, class ITERCLASS, class DATACLASS&gt;<br/>
 class frepple::utils::FreppleIterator&lt; ME, ITERCLASS, DATACLASS &gt;</h3>

<p>A template class to expose iterators to Python. </p>

<p>Definition at line <a class="el" href="a00252_source.html#l05557">5557</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="aac6b9d90292b7d3cc1bf125dbc35499a"></a><!-- doxytag: member="frepple::utils::FreppleIterator::FreppleIterator" ref="aac6b9d90292b7d3cc1bf125dbc35499a" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ME, class ITERCLASS, class DATACLASS&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00078.html">frepple::utils::FreppleIterator</a>&lt; ME, ITERCLASS, DATACLASS &gt;::<a class="el" href="a00078.html">FreppleIterator</a> </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

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

</div>
</div>
<a class="anchor" id="a9f4eb10d871e65b5e250cb625305a811"></a><!-- doxytag: member="frepple::utils::FreppleIterator::FreppleIterator" ref="a9f4eb10d871e65b5e250cb625305a811" args="(const OTHER *o)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ME, class ITERCLASS, class DATACLASS&gt; </div>
<div class="memtemplate">
template&lt;class OTHER &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00078.html">frepple::utils::FreppleIterator</a>&lt; ME, ITERCLASS, DATACLASS &gt;::<a class="el" href="a00078.html">FreppleIterator</a> </td>
          <td>(</td>
          <td class="paramtype">const OTHER *&nbsp;</td>
          <td class="paramname"> <em>o</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

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

</div>
</div>
<a class="anchor" id="a34c9b8c275b9d2ca32cd4e890a6f1064"></a><!-- doxytag: member="frepple::utils::FreppleIterator::FreppleIterator" ref="a34c9b8c275b9d2ca32cd4e890a6f1064" args="(const OTHER &amp;o)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ME, class ITERCLASS, class DATACLASS&gt; </div>
<div class="memtemplate">
template&lt;class OTHER &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00078.html">frepple::utils::FreppleIterator</a>&lt; ME, ITERCLASS, DATACLASS &gt;::<a class="el" href="a00078.html">FreppleIterator</a> </td>
          <td>(</td>
          <td class="paramtype">const OTHER &amp;&nbsp;</td>
          <td class="paramname"> <em>o</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="a00252_source.html#l05574">5574</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="ab493ad29bb7de9027770c1cb38c278fb"></a><!-- doxytag: member="frepple::utils::FreppleIterator::create" ref="ab493ad29bb7de9027770c1cb38c278fb" args="(PyObject *self, PyObject *args)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ME, class ITERCLASS, class DATACLASS&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">static PyObject* <a class="el" href="a00078.html">frepple::utils::FreppleIterator</a>&lt; ME, ITERCLASS, DATACLASS &gt;::create </td>
          <td>(</td>
          <td class="paramtype">PyObject *&nbsp;</td>
          <td class="paramname"> <em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">PyObject *&nbsp;</td>
          <td class="paramname"> <em>args</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

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

</div>
</div>
<a class="anchor" id="acb8dad5955431c6d2b5f89dea7ac3018"></a><!-- doxytag: member="frepple::utils::FreppleIterator::initialize" ref="acb8dad5955431c6d2b5f89dea7ac3018" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ME, class ITERCLASS, class DATACLASS&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">static int <a class="el" href="a00078.html">frepple::utils::FreppleIterator</a>&lt; ME, ITERCLASS, DATACLASS &gt;::initialize </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="a00252_source.html#l05560">5560</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>