<!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::FlowPlan 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="a00068.html">FlowPlan</a>
</div>
</div>
<div class="contents">
<h1>frepple::FlowPlan Class Reference</h1><!-- doxytag: class="frepple::FlowPlan" --><!-- doxytag: inherits="frepple::utils::TimeLine::EventChangeOnhand,frepple::utils::PythonExtensionBase" -->
<p>A flowplan represents a planned material flow in or out of a buffer.
<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::FlowPlan:</div>
<div class="dynsection">
<div class="center"><img src="a00422.png" border="0" usemap="#frepple_1_1_flow_plan_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1_flow_plan_inherit__map" id="frepple_1_1_flow_plan_inherit__map">
<area shape="rect" id="node2" href="a00059.html" title="A timeline event representing a change of the current value." alt="" coords="517,5,875,33"/>
<area shape="rect" id="node4" href="a00058.html" title="Base class for nodes in the timeline." alt="" coords="229,5,469,33"/>
<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="5,5,181,33"/>
<area shape="rect" id="node8" href="a00151.html" title="This is a base class for all Python extension types." alt="" coords="583,55,809,83"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a00423.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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00068.html#aeefe1a570e0676af44ccd3a875b2fc6a">FlowPlan</a> (<a class="el" href="a00125.html">OperationPlan</a> *, const <a class="el" href="a00065.html">Flow</a> *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="a00008.html">Buffer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00068.html#aaf09e08ee1c324bcb978ac17a99ec518">getBuffer</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="a00065.html">Flow</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00068.html#afad8d8ad9e551d7abb012bf1383b18c8">getFlow</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00068.html#aa6f7c2c719f72d45be7bffb36c28476e">getHidden</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="a00068.html#afe1300d2e208fb1420a32caa3568e13d">getOperationPlan</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00178.html">TimeLine</a>< <a class="el" href="a00068.html">FlowPlan</a> > * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00068.html#a793b40303d8c43923fcdb4b9d4e532d5">getTimeLine</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00068.html#aaa7771a21e573b2a9981ff1c9bab321d">setFlow</a> (const <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="a00068.html#a0b5b8438e4f952d0ae4d50a9b5e1d68a">setQuantity</a> (double qty, bool b=false, bool u=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00068.html#aa33088a4a0f7150dd4ada78d4dacc754">update</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00068.html#ad54c77a23d8de5ae05e57352b09a40bc">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="a00068.html#a3b19cb2cd5d9dffdc79440ef91c849c4">~FlowPlan</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="a00068.html#a003341ddf9669d0ec1030b34c0a1f655">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="a00068.html#a784882efeb9633b6c44e9dc95834b852">metadata</a></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00068.html#a1bcf4243f450b6649e42c9e6031502a1">OperationPlan::FlowPlanIterator</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A flowplan represents a planned material flow in or out of a buffer. </p>
<p>Flowplans are owned by operationplans, which manage a container to store them. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03574">3574</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aeefe1a570e0676af44ccd3a875b2fc6a"></a><!-- doxytag: member="frepple::FlowPlan::FlowPlan" ref="aeefe1a570e0676af44ccd3a875b2fc6a" args="(OperationPlan *, const Flow *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::FlowPlan::FlowPlan </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00125.html">OperationPlan</a> * </td>
<td class="paramname"> <em>opplan</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00065.html">Flow</a> * </td>
<td class="paramname"> <em>f</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<p>Definition at line <a class="el" href="a00202_source.html#l00051">51</a> of file <a class="el" href="a00202_source.html">flowplan.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3b19cb2cd5d9dffdc79440ef91c849c4"></a><!-- doxytag: member="frepple::FlowPlan::~FlowPlan" ref="a3b19cb2cd5d9dffdc79440ef91c849c4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual frepple::FlowPlan::~FlowPlan </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03613">3613</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="aaf09e08ee1c324bcb978ac17a99ec518"></a><!-- doxytag: member="frepple::FlowPlan::getBuffer" ref="aaf09e08ee1c324bcb978ac17a99ec518" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="a00008.html">Buffer</a>* frepple::FlowPlan::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#l03602">3602</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="afad8d8ad9e551d7abb012bf1383b18c8"></a><!-- doxytag: member="frepple::FlowPlan::getFlow" ref="afad8d8ad9e551d7abb012bf1383b18c8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="a00065.html">Flow</a>* frepple::FlowPlan::getFlow </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 is an plan instance. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03599">3599</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa6f7c2c719f72d45be7bffb36c28476e"></a><!-- doxytag: member="frepple::FlowPlan::getHidden" ref="aa6f7c2c719f72d45be7bffb36c28476e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool frepple::FlowPlan::getHidden </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true when the flowplan is hidden.<br/>
This is determined by looking at whether the flow is hidden or not. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03651">3651</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="afe1300d2e208fb1420a32caa3568e13d"></a><!-- doxytag: member="frepple::FlowPlan::getOperationPlan" ref="afe1300d2e208fb1420a32caa3568e13d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00125.html">OperationPlan</a>* frepple::FlowPlan::getOperationPlan </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the operationplan owning this flowplan. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03610">3610</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a793b40303d8c43923fcdb4b9d4e532d5"></a><!-- doxytag: member="frepple::FlowPlan::getTimeLine" ref="a793b40303d8c43923fcdb4b9d4e532d5" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00178.html">TimeLine</a><<a class="el" href="a00068.html">FlowPlan</a>>* frepple::FlowPlan::getTimeLine </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a pointer to the timeline data structure owning this flowplan. </p>
<p>Reimplemented from <a class="el" href="a00058.html#acd6a23159a231648a4b63e6c01558cb4">frepple::utils::TimeLine< type >::Event</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l03645">3645</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a003341ddf9669d0ec1030b34c0a1f655"></a><!-- doxytag: member="frepple::FlowPlan::initialize" ref="a003341ddf9669d0ec1030b34c0a1f655" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int frepple::FlowPlan::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="a00202_source.html#l00036">36</a> of file <a class="el" href="a00202_source.html">flowplan.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aaa7771a21e573b2a9981ff1c9bab321d"></a><!-- doxytag: member="frepple::FlowPlan::setFlow" ref="aaa7771a21e573b2a9981ff1c9bab321d" args="(const Flow *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::FlowPlan::setFlow </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00065.html">Flow</a> * </td>
<td class="paramname"> <em>newfl</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Update the flow of an already existing flowplan.<br/>
The new flow must belong to the same operation. </p>
<p>Definition at line <a class="el" href="a00202_source.html#l00103">103</a> of file <a class="el" href="a00202_source.html">flowplan.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0b5b8438e4f952d0ae4d50a9b5e1d68a"></a><!-- doxytag: member="frepple::FlowPlan::setQuantity" ref="a0b5b8438e4f952d0ae4d50a9b5e1d68a" args="(double qty, bool b=false, bool u=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::FlowPlan::setQuantity </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>qty</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>b</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>u</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>Updates the quantity of the flowplan by changing the quantity of the operationplan owning this flowplan.<br/>
The boolean parameter is used to control whether to round up (false) or down (true) in case the operation quantity must be a multiple. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03633">3633</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa33088a4a0f7150dd4ada78d4dacc754"></a><!-- doxytag: member="frepple::FlowPlan::update" ref="aa33088a4a0f7150dd4ada78d4dacc754" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::FlowPlan::update </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function needs to be called whenever the flowplan date or quantity are changed. </p>
<p>Definition at line <a class="el" href="a00202_source.html#l00087">87</a> of file <a class="el" href="a00202_source.html">flowplan.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad54c77a23d8de5ae05e57352b09a40bc"></a><!-- doxytag: member="frepple::FlowPlan::writeElement" ref="ad54c77a23d8de5ae05e57352b09a40bc" args="(XMLOutput *, const Keyword &, mode=DEFAULT) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::FlowPlan::writeElement </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00189.html">XMLOutput</a> * </td>
<td class="paramname"> <em>o</em>, </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"> <em>tag</em>, </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"> <em>m</em> = <code>DEFAULT</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writing the element. This method has the same prototype as a usual instance of the Object class, but this is only superficial: <a class="el" href="a00068.html" title="A flowplan represents a planned material flow in or out of a buffer.">FlowPlan</a> isn't a subclass of Object at all. </p>
<p>Definition at line <a class="el" href="a00202_source.html#l00134">134</a> of file <a class="el" href="a00202_source.html">flowplan.cpp</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a1bcf4243f450b6649e42c9e6031502a1"></a><!-- doxytag: member="frepple::FlowPlan::OperationPlan::FlowPlanIterator" ref="a1bcf4243f450b6649e42c9e6031502a1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="a00069.html">OperationPlan::FlowPlanIterator</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00218_source.html#l03576">3576</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a784882efeb9633b6c44e9dc95834b852"></a><!-- doxytag: member="frepple::FlowPlan::metadata" ref="a784882efeb9633b6c44e9dc95834b852" 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="a00068.html#a784882efeb9633b6c44e9dc95834b852">frepple::FlowPlan::metadata</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00218_source.html#l03592">3592</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="a00202_source.html">flowplan.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>
