<!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::FlowStart 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="a00071.html">FlowStart</a>
</div>
</div>
<div class="contents">
<h1>frepple::FlowStart Class Reference</h1><!-- doxytag: class="frepple::FlowStart" --><!-- doxytag: inherits="frepple::Flow" -->
<p>This class defines a material flow to/from a buffer, linked with an operation. This subclass represents a flow that is at the start date 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::FlowStart:</div>
<div class="dynsection">
<div class="center"><img src="a00426.png" border="0" usemap="#frepple_1_1_flow_start_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1_flow_start_inherit__map" id="frepple_1_1_flow_start_inherit__map">
<area shape="rect" id="node2" href="a00065.html" title="This class defines a material flow to/from a buffer, linked with an operation. This..." alt="" coords="695,55,788,83"/>
<area shape="rect" id="node4" href="a00120.html" title="Object is the abstract base class for the main entities." alt="" coords="396,5,532,33"/>
<area shape="rect" id="node6" href="a00151.html" title="This is a base class for all Python extension types." alt="" coords="7,5,233,33"/>
<area shape="rect" id="node8" href="a00118.html" title="A base class for the class representing the association itself." alt="" coords="284,55,644,83"/>
<area shape="rect" id="node10" 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="a00427.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="a00071.html#a688a372382ad1417782d7084018847e6">FlowStart</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00071.html#a6ca276bbd59c9a101f064f42fe9574a0">FlowStart</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">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00071.html#a21f8efc3f9eb61c29861b153d374856c">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="a00071.html#a6345c19f1ab845656d160811372eac6f">getType</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00071.html#aa00857a8c270b341e14854f375379588">solve</a> (<a class="el" href="a00171.html">Solver</a> &s, void *v=NULL) const </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="a00115.html">MetaClass</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00071.html#a76c55c461c57c05fee361b0acaa71fd0">metadata</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 subclass represents a flow that is at the start date of the operation. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03527">3527</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a6ca276bbd59c9a101f064f42fe9574a0"></a><!-- doxytag: member="frepple::FlowStart::FlowStart" ref="a6ca276bbd59c9a101f064f42fe9574a0" args="(Operation *o, Buffer *b, double q)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::FlowStart::FlowStart </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#l03531">3531</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a688a372382ad1417782d7084018847e6"></a><!-- doxytag: member="frepple::FlowStart::FlowStart" ref="a688a372382ad1417782d7084018847e6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::FlowStart::FlowStart </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This constructor is called from the plan begin_element function. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l03534">3534</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="a21f8efc3f9eb61c29861b153d374856c"></a><!-- doxytag: member="frepple::FlowStart::getSize" ref="a21f8efc3f9eb61c29861b153d374856c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t frepple::FlowStart::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>Reimplemented from <a class="el" href="a00065.html#a768da880aa19ebd29d29f33cf57a7e6b">frepple::Flow</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l03538">3538</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6345c19f1ab845656d160811372eac6f"></a><!-- doxytag: member="frepple::FlowStart::getType" ref="a6345c19f1ab845656d160811372eac6f" 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::FlowStart::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>Reimplemented from <a class="el" href="a00065.html#a3f717a5154e2bea5a644444b57c9cff6">frepple::Flow</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l03536">3536</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa00857a8c270b341e14854f375379588"></a><!-- doxytag: member="frepple::FlowStart::solve" ref="aa00857a8c270b341e14854f375379588" args="(Solver &s, void *v=NULL) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void frepple::FlowStart::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="a00065.html#ab3005ab9056a1e56be03fe89122b3001">frepple::Flow</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l03539">3539</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="a76c55c461c57c05fee361b0acaa71fd0"></a><!-- doxytag: member="frepple::FlowStart::metadata" ref="a76c55c461c57c05fee361b0acaa71fd0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="a00115.html">MetaClass</a> * <a class="el" href="a00071.html#a76c55c461c57c05fee361b0acaa71fd0">frepple::FlowStart::metadata</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="a00065.html#a57cd1a48af0ab914b78bb411711c447a">frepple::Flow</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l03537">3537</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>
