<!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::Flow 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="a00065.html">Flow</a>
</div>
</div>
<div class="contents">
<h1>frepple::Flow Class Reference</h1><!-- doxytag: class="frepple::Flow" --><!-- doxytag: inherits="frepple::utils::Object,frepple::utils::Association::Node,frepple::Solvable" -->
<p>This class defines a material flow to/from a buffer, linked with an operation. This default implementation plans the material flow at the start of the operation.
<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::Flow:</div>
<div class="dynsection">
<div class="center"><img src="a00416.png" border="0" usemap="#frepple_1_1_flow_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1_flow_inherit__map" id="frepple_1_1_flow_inherit__map">
<area shape="rect" id="node11" href="a00066.html" title="This class defines a material flow to/from a buffer, linked with an operation. This..." alt="" coords="840,30,957,58"/>
<area shape="rect" id="node13" href="a00071.html" title="This class defines a material flow to/from a buffer, linked with an operation. This..." alt="" coords="837,81,960,109"/>
<area shape="rect" id="node2" href="a00120.html" title="Object is the abstract base class for the main entities." alt="" coords="396,5,532,33"/>
<area shape="rect" id="node4" href="a00151.html" title="This is a base class for all Python extension types." alt="" coords="7,5,233,33"/>
<area shape="rect" id="node6" href="a00118.html" title="A base class for the class representing the association itself." alt="" coords="284,55,644,83"/>
<area shape="rect" id="node8" href="a00170.html" title="This class needs to be implemented by all classes that implement dynamic behavior..." alt="" coords="407,106,521,134"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a00417.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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a1caf73b47d83e6a5a27b183500b56474">beginElement</a> (<a class="el" href="a00186.html">XMLInput</a> &, const <a class="el" href="a00002.html">Attribute</a> &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a9cfcb370887357ac10be5b051ff158e5">endElement</a> (<a class="el" href="a00186.html">XMLInput</a> &, const <a class="el" href="a00002.html">Attribute</a> &, const <a class="el" href="a00047.html">DataElement</a> &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#ae7cb1e7bf86875e2e3b07a488290c7b9">Flow</a> (<a class="el" href="a00121.html">Operation</a> *o, <a class="el" href="a00008.html">Buffer</a> *b, double q)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00065.html">Flow</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a24a2afc7eb0ad57edf20f87e9ce2de96">getAlternate</a> () const </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="a00065.html#a3034ea6d121f86338faeab26ec7464d4">getBuffer</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="a00049.html">Date</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#abb5314ce07f4b2ded0808e5cd410dbec">getFlowplanDate</a> (const <a class="el" href="a00068.html">FlowPlan</a> *) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a13d896fb20aea3e8ca941b5d70e9be8f">getFlowplanQuantity</a> (const <a class="el" href="a00068.html">FlowPlan</a> *) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a090f125701f6a938022491d80b0b7df0">getHidden</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00121.html">Operation</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#af7649182aaa0020e9684ccd337a357ad">getOperation</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a8cac1ed580a00c11f797bf0eae77330e">getPriority</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a29332e8619e350ec887efbdead1c1b11">getQuantity</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00256.html#aa439ebf4ddfb4983ac3d44abacb9b749">SearchMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a05fe56fbc1e8ee1712ead3b6cb554584">getSearch</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a768da880aa19ebd29d29f33cf57a7e6b">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="a00065.html#a3f717a5154e2bea5a644444b57c9cff6">getType</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#af014c60036fa0d54295e2a179e146c11">hasAlternates</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a306253a0c51478215c2709d9f36e096a">isConsumer</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a048de4136c01bff69765080bd357d98c">isProducer</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#ae2f035507f2ba15c6958c63df01c496d">setAlternate</a> (const string &n)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a15ed015585168ab76a66da36447f9483">setAlternate</a> (<a class="el" href="a00065.html">Flow</a> *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a40617c135538c6efd90cd515d7026032">setBuffer</a> (<a class="el" href="a00008.html">Buffer</a> *b)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a6d954f1d4e61bd68fcb4cafb8a30d24a">setOperation</a> (<a class="el" href="a00121.html">Operation</a> *o)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a4d95731a9a9abe9ccf2544905f420913">setPriority</a> (int i)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a96f7a635f0f33ff70455c4eabb7b3c19">setQuantity</a> (double f)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a86dca007409391d08d3640c3eb1161b0">setSearch</a> (const string a)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#ab3005ab9056a1e56be03fe89122b3001">solve</a> (<a class="el" href="a00171.html">Solver</a> &s, void *v=NULL) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a5dfbe11d919a0028ceeea0a7de2da8df">writeElement</a> (<a class="el" href="a00189.html">XMLOutput</a> *, const <a class="el" href="a00096.html">Keyword</a> &, <a class="el" href="a00257.html#a20c2c7e4c6b668e71c154ae3eb18f398">mode</a>=DEFAULT) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a9cbc31e4846e1d798306661735c08068">~Flow</a> ()</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="a00065.html#aa9a892bf7301ba668c3871f17830780f">initialize</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#a308ad9c0fd39b78a25ab6b59558d62f7">writer</a> (const <a class="el" href="a00114.html">MetaCategory</a> *, <a class="el" href="a00189.html">XMLOutput</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="a00065.html#a57cd1a48af0ab914b78bb411711c447a">metadata</a></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00065.html#ace1ec37bd417fc3a199eeb45fc5c8d28">Flow</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This class defines a material flow to/from a buffer, linked with an operation. This default implementation plans the material flow at the start of the operation. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03390">3390</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a9cbc31e4846e1d798306661735c08068"></a><!-- doxytag: member="frepple::Flow::~Flow" ref="a9cbc31e4846e1d798306661735c08068" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::Flow::~Flow </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>Definition at line <a class="el" href="a00201_source.html#l00147">147</a> of file <a class="el" href="a00201_source.html">flow.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae7cb1e7bf86875e2e3b07a488290c7b9"></a><!-- doxytag: member="frepple::Flow::Flow" ref="ae7cb1e7bf86875e2e3b07a488290c7b9" args="(Operation *o, Buffer *b, double q)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::Flow::Flow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00121.html">Operation</a> * </td>
<td class="paramname"> <em>o</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00008.html">Buffer</a> * </td>
<td class="paramname"> <em>b</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>q</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03398">3398</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="ace1ec37bd417fc3a199eeb45fc5c8d28"></a><!-- doxytag: member="frepple::Flow::Flow" ref="ace1ec37bd417fc3a199eeb45fc5c8d28" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::Flow::Flow </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, explicit, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03495">3495</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="a1caf73b47d83e6a5a27b183500b56474"></a><!-- doxytag: member="frepple::Flow::beginElement" ref="a1caf73b47d83e6a5a27b183500b56474" args="(XMLInput &, const Attribute &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Flow::beginElement </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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called while restoring the model from an XML-file.<br/>
This is called for each element within the "this" element, for which the "this" element is immediate parent.<br/>
It is called when the open element tag is encountered. </p>
<p>Reimplemented from <a class="el" href="a00120.html#ac17c9f7df359ee20839f5e09723d38f1">frepple::utils::Object</a>.</p>
<p>Definition at line <a class="el" href="a00201_source.html#l00284">284</a> of file <a class="el" href="a00201_source.html">flow.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9cfcb370887357ac10be5b051ff158e5"></a><!-- doxytag: member="frepple::Flow::endElement" ref="a9cfcb370887357ac10be5b051ff158e5" args="(XMLInput &, const Attribute &, const DataElement &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Flow::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> [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="a00201_source.html#l00293">293</a> of file <a class="el" href="a00201_source.html">flow.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a24a2afc7eb0ad57edf20f87e9ce2de96"></a><!-- doxytag: member="frepple::Flow::getAlternate" ref="a24a2afc7eb0ad57edf20f87e9ce2de96" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00065.html">Flow</a>* frepple::Flow::getAlternate </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the flow of which this one is an alternate.<br/>
NULL is return where there is none. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03453">3453</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3034ea6d121f86338faeab26ec7464d4"></a><!-- doxytag: member="frepple::Flow::getBuffer" ref="a3034ea6d121f86338faeab26ec7464d4" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00008.html">Buffer</a>* frepple::Flow::getBuffer </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the buffer. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03433">3433</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="abb5314ce07f4b2ded0808e5cd410dbec"></a><!-- doxytag: member="frepple::Flow::getFlowplanDate" ref="abb5314ce07f4b2ded0808e5cd410dbec" args="(const FlowPlan *) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00049.html">Date</a> frepple::Flow::getFlowplanDate </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00068.html">FlowPlan</a> * </td>
<td class="paramname"> <em>fl</em></td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method holds the logic the compute the date of a flowplan. </p>
<p>Reimplemented in <a class="el" href="a00066.html#aae9b46e0d88faaec4b9a9d6e76bab753">frepple::FlowEnd</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l03663">3663</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a13d896fb20aea3e8ca941b5d70e9be8f"></a><!-- doxytag: member="frepple::Flow::getFlowplanQuantity" ref="a13d896fb20aea3e8ca941b5d70e9be8f" args="(const FlowPlan *) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double frepple::Flow::getFlowplanQuantity </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00068.html">FlowPlan</a> * </td>
<td class="paramname"> <em>fl</em></td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method holds the logic the compute the quantity of a flowplan. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03655">3655</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a090f125701f6a938022491d80b0b7df0"></a><!-- doxytag: member="frepple::Flow::getHidden" ref="a090f125701f6a938022491d80b0b7df0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool frepple::Flow::getHidden </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A flow is considered hidden when either its buffer or operation are hidden. </p>
<p>Reimplemented from <a class="el" href="a00120.html#a05c1c38045f55cd8ce66cee9e933d2bb">frepple::utils::Object</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l03469">3469</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="af7649182aaa0020e9684ccd337a357ad"></a><!-- doxytag: member="frepple::Flow::getOperation" ref="af7649182aaa0020e9684ccd337a357ad" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00121.html">Operation</a>* frepple::Flow::getOperation </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the operation. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03408">3408</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8cac1ed580a00c11f797bf0eae77330e"></a><!-- doxytag: member="frepple::Flow::getPriority" ref="a8cac1ed580a00c11f797bf0eae77330e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int frepple::Flow::getPriority </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the priority of a flow. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03445">3445</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a29332e8619e350ec887efbdead1c1b11"></a><!-- doxytag: member="frepple::Flow::getQuantity" ref="a29332e8619e350ec887efbdead1c1b11" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double frepple::Flow::getQuantity </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the material flow PER UNIT of the operationplan. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03423">3423</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a05fe56fbc1e8ee1712ead3b6cb554584"></a><!-- doxytag: member="frepple::Flow::getSearch" ref="a05fe56fbc1e8ee1712ead3b6cb554584" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00256.html#aa439ebf4ddfb4983ac3d44abacb9b749">SearchMode</a> frepple::Flow::getSearch </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the search mode. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03462">3462</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a768da880aa19ebd29d29f33cf57a7e6b"></a><!-- doxytag: member="frepple::Flow::getSize" ref="a768da880aa19ebd29d29f33cf57a7e6b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t frepple::Flow::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>Reimplemented in <a class="el" href="a00071.html#a21f8efc3f9eb61c29861b153d374856c">frepple::FlowStart</a>, and <a class="el" href="a00066.html#abb8d647ceb45fe1d33d688121a84d901">frepple::FlowEnd</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l03491">3491</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3f717a5154e2bea5a644444b57c9cff6"></a><!-- doxytag: member="frepple::Flow::getType" ref="a3f717a5154e2bea5a644444b57c9cff6" 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::Flow::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>Reimplemented in <a class="el" href="a00071.html#a6345c19f1ab845656d160811372eac6f">frepple::FlowStart</a>, and <a class="el" href="a00066.html#a0d4df42aaa489791c066d55d84945143">frepple::FlowEnd</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l03489">3489</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="af014c60036fa0d54295e2a179e146c11"></a><!-- doxytag: member="frepple::Flow::hasAlternates" ref="af014c60036fa0d54295e2a179e146c11" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool frepple::Flow::hasAlternates </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if there are alternates for this flow. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03448">3448</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa9a892bf7301ba668c3871f17830780f"></a><!-- doxytag: member="frepple::Flow::initialize" ref="aa9a892bf7301ba668c3871f17830780f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int frepple::Flow::initialize </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00201_source.html#l00038">38</a> of file <a class="el" href="a00201_source.html">flow.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a306253a0c51478215c2709d9f36e096a"></a><!-- doxytag: member="frepple::Flow::isConsumer" ref="a306253a0c51478215c2709d9f36e096a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool frepple::Flow::isConsumer </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if this flow consumes material from the buffer. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03417">3417</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a048de4136c01bff69765080bd357d98c"></a><!-- doxytag: member="frepple::Flow::isProducer" ref="a048de4136c01bff69765080bd357d98c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool frepple::Flow::isProducer </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if this flow produces material into the buffer. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03420">3420</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae2f035507f2ba15c6958c63df01c496d"></a><!-- doxytag: member="frepple::Flow::setAlternate" ref="ae2f035507f2ba15c6958c63df01c496d" args="(const string &n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Flow::setAlternate </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>n</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Define the flow of which this one is an alternate. </p>
<p>Definition at line <a class="el" href="a00201_source.html#l00236">236</a> of file <a class="el" href="a00201_source.html">flow.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a15ed015585168ab76a66da36447f9483"></a><!-- doxytag: member="frepple::Flow::setAlternate" ref="a15ed015585168ab76a66da36447f9483" args="(Flow *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Flow::setAlternate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00065.html">Flow</a> * </td>
<td class="paramname"> <em>f</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Define the flow of which this one is an alternate. </p>
<p>Definition at line <a class="el" href="a00201_source.html#l00220">220</a> of file <a class="el" href="a00201_source.html">flow.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a40617c135538c6efd90cd515d7026032"></a><!-- doxytag: member="frepple::Flow::setBuffer" ref="a40617c135538c6efd90cd515d7026032" args="(Buffer *b)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Flow::setBuffer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00008.html">Buffer</a> * </td>
<td class="paramname"> <em>b</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Updates the buffer of this flow. This method can be called only ONCE for each flow. In case that doesn't suit you, delete the existing flow and create a new one. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03439">3439</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6d954f1d4e61bd68fcb4cafb8a30d24a"></a><!-- doxytag: member="frepple::Flow::setOperation" ref="a6d954f1d4e61bd68fcb4cafb8a30d24a" args="(Operation *o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Flow::setOperation </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00121.html">Operation</a> * </td>
<td class="paramname"> <em>o</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Updates the operation of this flow. This method can be called only ONCE for each flow. In case that doesn't suit you, delete the existing flow and create a new one. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03414">3414</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a4d95731a9a9abe9ccf2544905f420913"></a><!-- doxytag: member="frepple::Flow::setPriority" ref="a4d95731a9a9abe9ccf2544905f420913" args="(int i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Flow::setPriority </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>i</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Update the priority of a flow. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03442">3442</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a96f7a635f0f33ff70455c4eabb7b3c19"></a><!-- doxytag: member="frepple::Flow::setQuantity" ref="a96f7a635f0f33ff70455c4eabb7b3c19" args="(double f)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Flow::setQuantity </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>f</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Updates the material flow PER UNIT of the operationplan. Existing flowplans are NOT updated to take the new quantity in effect. Only new operationplans and updates to existing ones will use the new quantity value. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03430">3430</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a86dca007409391d08d3640c3eb1161b0"></a><!-- doxytag: member="frepple::Flow::setSearch" ref="a86dca007409391d08d3640c3eb1161b0" args="(const string a)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Flow::setSearch </td>
<td>(</td>
<td class="paramtype">const string </td>
<td class="paramname"> <em>a</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Update the search mode. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03465">3465</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab3005ab9056a1e56be03fe89122b3001"></a><!-- doxytag: member="frepple::Flow::solve" ref="ab3005ab9056a1e56be03fe89122b3001" args="(Solver &s, void *v=NULL) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void frepple::Flow::solve </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00171.html">Solver</a> & </td>
<td class="paramname"> <em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>v</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method is called by solver classes. The implementation of this class simply calls the solve method on the solver class. Using the polymorphism the solver can implement seperate methods for different plannable subclasses. </p>
<p>Reimplemented from <a class="el" href="a00170.html#a35ad0dc1632fbfaee0ecc55752980c29">frepple::Solvable</a>.</p>
<p>Reimplemented in <a class="el" href="a00071.html#aa00857a8c270b341e14854f375379588">frepple::FlowStart</a>, and <a class="el" href="a00066.html#ac411d858c3fa38537b122f0ef50bc454">frepple::FlowEnd</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l03487">3487</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5dfbe11d919a0028ceeea0a7de2da8df"></a><!-- doxytag: member="frepple::Flow::writeElement" ref="a5dfbe11d919a0028ceeea0a7de2da8df" args="(XMLOutput *, const Keyword &, mode=DEFAULT) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Flow::writeElement </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00189.html">XMLOutput</a> * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00096.html">Keyword</a> & </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00257.html#a20c2c7e4c6b668e71c154ae3eb18f398">mode</a> </td>
<td class="paramname"> = <code>DEFAULT</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called while writing the model into an XML-file. The user class should write itself out, using the IOutStream members for its "simple" members and calling writeElement recursively for any contained objects. Not all classes are expected to implement this method. In instances of such a class can be created but can't be persisted. E.g. Command </p>
<p>Reimplemented from <a class="el" href="a00120.html#a324e43c334cb519909fcbdad0f8cbd82">frepple::utils::Object</a>.</p>
<p>Reimplemented in <a class="el" href="a00066.html#aff668cf48e9f1c26f917b64a238ae78b">frepple::FlowEnd</a>.</p>
<p>Definition at line <a class="el" href="a00201_source.html#l00246">246</a> of file <a class="el" href="a00201_source.html">flow.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a308ad9c0fd39b78a25ab6b59558d62f7"></a><!-- doxytag: member="frepple::Flow::writer" ref="a308ad9c0fd39b78a25ab6b59558d62f7" args="(const MetaCategory *, XMLOutput *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Flow::writer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00114.html">MetaCategory</a> * </td>
<td class="paramname"> <em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00189.html">XMLOutput</a> * </td>
<td class="paramname"> <em>o</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00201_source.html#l00061">61</a> of file <a class="el" href="a00201_source.html">flow.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a57cd1a48af0ab914b78bb411711c447a"></a><!-- doxytag: member="frepple::Flow::metadata" ref="a57cd1a48af0ab914b78bb411711c447a" 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="a00065.html#a57cd1a48af0ab914b78bb411711c447a">frepple::Flow::metadata</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented in <a class="el" href="a00071.html#a76c55c461c57c05fee361b0acaa71fd0">frepple::FlowStart</a>, and <a class="el" href="a00066.html#a9f2203732db979d868deaa981d229836">frepple::FlowEnd</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l03490">3490</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="a00201_source.html">flow.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>
