<!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::PeggingIterator 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 Page</span></a></li>
<li><a href="pages.html"><span>Related 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 List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00256.html">frepple</a>::<a class="el" href="a00131.html">PeggingIterator</a>
</div>
</div>
<div class="contents">
<h1>frepple::PeggingIterator Class Reference</h1><!-- doxytag: class="frepple::PeggingIterator" --><!-- doxytag: inherits="frepple::utils::Object" -->
<p>This class allows upstream and downstream navigation through the plan.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00218_source.html">model.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for frepple::PeggingIterator:</div>
<div class="dynsection">
<div class="center"><img src="a00477.png" border="0" usemap="#frepple_1_1_pegging_iterator_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1_pegging_iterator_inherit__map" id="frepple_1_1_pegging_iterator_inherit__map">
<area shape="rect" id="node2" href="a00120.html" title="Object is the abstract base class for the main entities." alt="" coords="51,83,187,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"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a00478.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>state</b></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00131.html#a3686a0ca5ffd1d0e877010efe9b42f95">endElement</a> (<a class="el" href="a00186.html">XMLInput</a> &i, const <a class="el" href="a00002.html">Attribute</a> &a, const <a class="el" href="a00047.html">DataElement</a> &d)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00008.html">Buffer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00131.html#a48ef63840684ba1f16874d4a8482c852">getBuffer</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00049.html">Date</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00131.html#a91a7eb11f8f4a343a6368b72ae4cba36">getConsumingDate</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00125.html">OperationPlan</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00131.html#a13a0e06f84a6454978b771bab1d3c501">getConsumingOperationplan</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="a00131.html#af632716ea5dba8ea48ed27c5daf236ce">getFactor</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">short </td><td class="memItemRight" valign="bottom"><a class="el" href="a00131.html#a8495b82ca78a1538d808dd2bac5baa7d">getLevel</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00131.html#a7954650512af3da3de962376c61f0ad0">getPegged</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00049.html">Date</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00131.html#a300048d940a1178ddce0f1b6355e1f53">getProducingDate</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00125.html">OperationPlan</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00131.html#ac68b526ebb111056385f33b42ddacdf0">getProducingOperationplan</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="a00131.html#ad194bcf1218ad4f5a461789ed7040807">getQuantityBuffer</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="a00131.html#a98a6ba2e04556019f964e845a423e614">getQuantityDemand</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00131.html#a42312fbe647ebcb05794ef6752cd0875">getSize</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="a00115.html">MetaClass</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00131.html#aa0879486800600a37a7e95b8f4d5e215">getType</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00131.html#aac7a5bc00810ea3656d3463ad5aff140">isDownstream</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00131.html#ac9ca5c997b6ea4b693d89809158aac22">operator bool</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00131.html#a7f775712fe8bdd4d26ef40ba182fc310">operator!=</a> (const <a class="el" href="a00131.html">PeggingIterator</a> &x) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00131.html">PeggingIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00131.html#a6e1d12f7e653da314bc399b54464cf9e">operator++</a> (int)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00131.html">PeggingIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00131.html#a811307b4da595f2c945eaa98814adc67">operator++</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00131.html">PeggingIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00131.html#a2faad7cce52bf48abd964c1ddf77a352">operator--</a> (int)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00131.html">PeggingIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00131.html#aebce5b987ad17f344d269b5c3f5b5621">operator--</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00131.html#a478176fd144e0ad9fa227be6a5298c32">operator==</a> (const <a class="el" href="a00131.html">PeggingIterator</a> &x) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00131.html#acd4125b828f525e9ef827941554a8ba6">PeggingIterator</a> (const <a class="el" href="a00068.html">FlowPlan</a> *e, bool b=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00131.html#a3e9aadbd91e53e67d85279670065768a">PeggingIterator</a> (const <a class="el" href="a00051.html">Demand</a> *e)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00131.html#ae54c20a1ee7a60ef6448f05207c11990">updateStack</a> (short, double, double, const <a class="el" href="a00068.html">FlowPlan</a> *, const <a class="el" href="a00068.html">FlowPlan</a> *, bool=true)</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00131.html#a5df24add46f53dc91de8ce01a0a775e1">initialize</a> ()</td></tr>
<tr><td colspan="2"><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="a00114.html">MetaCategory</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00131.html#a91e7242dc3e6de8ced18195d5bf5933d">metadata</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This class allows upstream and downstream navigation through the plan. </p>
<p>Downstream navigation follows the material flow from raw materials towards the produced end item.<br/>
Upstream navigation traces back the material flow from the end item up to the consumed raw materials.<br/>
The class is implemented as an STL-like iterator.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l05732">5732</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a3e9aadbd91e53e67d85279670065768a"></a><!-- doxytag: member="frepple::PeggingIterator::PeggingIterator" ref="a3e9aadbd91e53e67d85279670065768a" args="(const Demand *e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::PeggingIterator::PeggingIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00051.html">Demand</a> * </td>
<td class="paramname"> <em>e</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<p>Definition at line <a class="el" href="a00225_source.html#l00053">53</a> of file <a class="el" href="a00225_source.html">pegging.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="acd4125b828f525e9ef827941554a8ba6"></a><!-- doxytag: member="frepple::PeggingIterator::PeggingIterator" ref="acd4125b828f525e9ef827941554a8ba6" args="(const FlowPlan *e, bool b=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::PeggingIterator::PeggingIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00068.html">FlowPlan</a> * </td>
<td class="paramname"> <em>e</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>b</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l05739">5739</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="a3686a0ca5ffd1d0e877010efe9b42f95"></a><!-- doxytag: member="frepple::PeggingIterator::endElement" ref="a3686a0ca5ffd1d0e877010efe9b42f95" args="(XMLInput &i, const Attribute &a, const DataElement &d)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void frepple::PeggingIterator::endElement </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00186.html">XMLInput</a> & </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00002.html">Attribute</a> & </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00047.html">DataElement</a> & </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called while restoring the model from an XML-file.<br/>
This is called when the corresponding close element tag is encountered, and the Data() member of pElement is valid. </p>
<p>Implements <a class="el" href="a00120.html#a88eab6db69f9b38c6b3f5ea37da630fd">frepple::utils::Object</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l05858">5858</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a48ef63840684ba1f16874d4a8482c852"></a><!-- doxytag: member="frepple::PeggingIterator::getBuffer" ref="a48ef63840684ba1f16874d4a8482c852" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00008.html">Buffer</a>* frepple::PeggingIterator::getBuffer </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the material buffer through which we are pegging. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l05758">5758</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a91a7eb11f8f4a343a6368b72ae4cba36"></a><!-- doxytag: member="frepple::PeggingIterator::getConsumingDate" ref="a91a7eb11f8f4a343a6368b72ae4cba36" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00049.html">Date</a> frepple::PeggingIterator::getConsumingDate </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the date when the material is consumed. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l05773">5773</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a13a0e06f84a6454978b771bab1d3c501"></a><!-- doxytag: member="frepple::PeggingIterator::getConsumingOperationplan" ref="a13a0e06f84a6454978b771bab1d3c501" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00125.html">OperationPlan</a>* frepple::PeggingIterator::getConsumingOperationplan </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the operationplan consuming the material. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l05751">5751</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="af632716ea5dba8ea48ed27c5daf236ce"></a><!-- doxytag: member="frepple::PeggingIterator::getFactor" ref="af632716ea5dba8ea48ed27c5daf236ce" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double frepple::PeggingIterator::getFactor </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns which portion of the current flowplan is fed/supplied by the original flowplan. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l05810">5810</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8495b82ca78a1538d808dd2bac5baa7d"></a><!-- doxytag: member="frepple::PeggingIterator::getLevel" ref="a8495b82ca78a1538d808dd2bac5baa7d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">short frepple::PeggingIterator::getLevel </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the recursion depth of the iterator.<br/>
The original flowplan is at level 0, and each level (either upstream or downstream) increments the value by 1. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l05790">5790</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7954650512af3da3de962376c61f0ad0"></a><!-- doxytag: member="frepple::PeggingIterator::getPegged" ref="a7954650512af3da3de962376c61f0ad0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool frepple::PeggingIterator::getPegged </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns false if the flowplan remained unpegged, i.e. it wasn't -either completely or paritally- unconsumed at the next level. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l05815">5815</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a300048d940a1178ddce0f1b6355e1f53"></a><!-- doxytag: member="frepple::PeggingIterator::getProducingDate" ref="a300048d940a1178ddce0f1b6355e1f53" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00049.html">Date</a> frepple::PeggingIterator::getProducingDate </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the date when the material is produced. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l05780">5780</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac68b526ebb111056385f33b42ddacdf0"></a><!-- doxytag: member="frepple::PeggingIterator::getProducingOperationplan" ref="ac68b526ebb111056385f33b42ddacdf0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00125.html">OperationPlan</a>* frepple::PeggingIterator::getProducingOperationplan </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the operationplan producing the material. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l05766">5766</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad194bcf1218ad4f5a461789ed7040807"></a><!-- doxytag: member="frepple::PeggingIterator::getQuantityBuffer" ref="ad194bcf1218ad4f5a461789ed7040807" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double frepple::PeggingIterator::getQuantityBuffer </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the quantity of the buffer flowplans that is linked to this pegging record. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l05800">5800</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a98a6ba2e04556019f964e845a423e614"></a><!-- doxytag: member="frepple::PeggingIterator::getQuantityDemand" ref="a98a6ba2e04556019f964e845a423e614" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double frepple::PeggingIterator::getQuantityDemand </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the quantity of the demand that is linked to this pegging record. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l05795">5795</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a42312fbe647ebcb05794ef6752cd0875"></a><!-- doxytag: member="frepple::PeggingIterator::getSize" ref="a42312fbe647ebcb05794ef6752cd0875" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t frepple::PeggingIterator::getSize </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the memory size of the object in bytes. </p>
<p>Implements <a class="el" href="a00120.html#ae381655a0e700d1e0d9ef72379792872">frepple::utils::Object</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l05864">5864</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa0879486800600a37a7e95b8f4d5e215"></a><!-- doxytag: member="frepple::PeggingIterator::getType" ref="aa0879486800600a37a7e95b8f4d5e215" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="a00115.html">MetaClass</a>& frepple::PeggingIterator::getType </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This returns the type information on the object, a bit similar to the standard type_info information. </p>
<p>Implements <a class="el" href="a00120.html#a2e5ff5e5d9c32647f692abd04a0d72d2">frepple::utils::Object</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l05862">5862</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5df24add46f53dc91de8ce01a0a775e1"></a><!-- doxytag: member="frepple::PeggingIterator::initialize" ref="a5df24add46f53dc91de8ce01a0a775e1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int frepple::PeggingIterator::initialize </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initialize the class. </p>
<p>Definition at line <a class="el" href="a00225_source.html#l00037">37</a> of file <a class="el" href="a00225_source.html">pegging.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aac7a5bc00810ea3656d3463ad5aff140"></a><!-- doxytag: member="frepple::PeggingIterator::isDownstream" ref="aac7a5bc00810ea3656d3463ad5aff140" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool frepple::PeggingIterator::isDownstream </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if this is a downstream iterator. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l05853">5853</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac9ca5c997b6ea4b693d89809158aac22"></a><!-- doxytag: member="frepple::PeggingIterator::operator bool" ref="ac9ca5c997b6ea4b693d89809158aac22" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::PeggingIterator::operator bool </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Conversion operator to a boolean value. The return value is true when the iterator still has next elements to explore. Returns false when the iteration is finished. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l05847">5847</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7f775712fe8bdd4d26ef40ba182fc310"></a><!-- doxytag: member="frepple::PeggingIterator::operator!=" ref="a7f775712fe8bdd4d26ef40ba182fc310" args="(const PeggingIterator &x) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool frepple::PeggingIterator::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00131.html">PeggingIterator</a> & </td>
<td class="paramname"> <em>x</em></td>
<td> ) </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#l05841">5841</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6e1d12f7e653da314bc399b54464cf9e"></a><!-- doxytag: member="frepple::PeggingIterator::operator++" ref="a6e1d12f7e653da314bc399b54464cf9e" args="(int)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00131.html">PeggingIterator</a> frepple::PeggingIterator::operator++ </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Move the iterator foward to the next downstream flowplan.<br/>
This post-increment operator is less efficient than the pre-increment operator. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l05824">5824</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a811307b4da595f2c945eaa98814adc67"></a><!-- doxytag: member="frepple::PeggingIterator::operator++" ref="a811307b4da595f2c945eaa98814adc67" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00131.html">PeggingIterator</a> & frepple::PeggingIterator::operator++ </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Move the iterator foward to the next downstream flowplan. </p>
<p>Definition at line <a class="el" href="a00225_source.html#l00091">91</a> of file <a class="el" href="a00225_source.html">pegging.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a2faad7cce52bf48abd964c1ddf77a352"></a><!-- doxytag: member="frepple::PeggingIterator::operator--" ref="a2faad7cce52bf48abd964c1ddf77a352" args="(int)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00131.html">PeggingIterator</a> frepple::PeggingIterator::operator-- </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Move the iterator foward to the next upstream flowplan.<br/>
This post-increment operator is less efficient than the pre-decrement operator. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l05834">5834</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="aebce5b987ad17f344d269b5c3f5b5621"></a><!-- doxytag: member="frepple::PeggingIterator::operator--" ref="aebce5b987ad17f344d269b5c3f5b5621" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00131.html">PeggingIterator</a> & frepple::PeggingIterator::operator-- </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Move the iterator foward to the next upstream flowplan. </p>
<p>Definition at line <a class="el" href="a00225_source.html#l00122">122</a> of file <a class="el" href="a00225_source.html">pegging.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a478176fd144e0ad9fa227be6a5298c32"></a><!-- doxytag: member="frepple::PeggingIterator::operator==" ref="a478176fd144e0ad9fa227be6a5298c32" args="(const PeggingIterator &x) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool frepple::PeggingIterator::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00131.html">PeggingIterator</a> & </td>
<td class="paramname"> <em>x</em></td>
<td> ) </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#l05838">5838</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae54c20a1ee7a60ef6448f05207c11990"></a><!-- doxytag: member="frepple::PeggingIterator::updateStack" ref="ae54c20a1ee7a60ef6448f05207c11990" args="(short, double, double, const FlowPlan *, const FlowPlan *, bool=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::PeggingIterator::updateStack </td>
<td>(</td>
<td class="paramtype">short </td>
<td class="paramname"> <em>l</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>q</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>f</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00068.html">FlowPlan</a> * </td>
<td class="paramname"> <em>fc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00068.html">FlowPlan</a> * </td>
<td class="paramname"> <em>fp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>p</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Update the stack. </p>
<p>Definition at line <a class="el" href="a00225_source.html#l00068">68</a> of file <a class="el" href="a00225_source.html">pegging.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a91e7242dc3e6de8ced18195d5bf5933d"></a><!-- doxytag: member="frepple::PeggingIterator::metadata" ref="a91e7242dc3e6de8ced18195d5bf5933d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="a00114.html">MetaCategory</a> * <a class="el" href="a00131.html#a91e7242dc3e6de8ced18195d5bf5933d">frepple::PeggingIterator::metadata</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00218_source.html#l05863">5863</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="a00225_source.html">pegging.cpp</a></li>
</ul>
</div>
<hr size="1"/><address style="align: right;"><small>Documentation generated for frePPLe by
<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>
