<!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::LoadPlan 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="a00105.html">LoadPlan</a>
</div>
</div>
<div class="contents">
<h1>frepple::LoadPlan Class Reference</h1><!-- doxytag: class="frepple::LoadPlan" --><!-- doxytag: inherits="frepple::utils::TimeLine::EventChangeOnhand,frepple::utils::PythonExtensionBase" -->
<p>This class represents the resource capacity of an operationplan.
<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::LoadPlan:</div>
<div class="dynsection">
<div class="center"><img src="a00445.png" border="0" usemap="#frepple_1_1_load_plan_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1_load_plan_inherit__map" id="frepple_1_1_load_plan_inherit__map">
<area shape="rect" id="node2" href="a00059.html" title="A timeline event representing a change of the current value." alt="" coords="519,5,876,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="584,55,811,83"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a00446.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">PyObject * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#a9a3adbd225be3dac4ff62f622b1b6a66">getattro</a> (const <a class="el" href="a00002.html">Attribute</a> &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#aaae23704c7fb0d7b379003e0280670cf">getHidden</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="a00103.html">Load</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#aa62c4a262f2146c1f53f032314aebe97">getLoad</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="a00105.html#a0969aca89148ba44b97211d25177cbed">getOperationPlan</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00105.html">LoadPlan</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#acad3d65dc1ef64a74ba42474d5dd20fa">getOtherLoadPlan</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="a00156.html">Resource</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#a88541f3fad5fb0f1b12fc2cb91908e7e">getResource</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const string & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#a15b97b617417b2186a43a4b827ecee73">getSetup</a> (bool=true) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00178.html">TimeLine</a>< <a class="el" href="a00105.html">LoadPlan</a> > * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#ad93093d41d6ba3f415eedf80522ad4f1">getTimeLine</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#ad9328f39af6a9759d0e97572f87d6f67">isStart</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#af510b8574f749397aabc3bbc0310db5b">LoadPlan</a> (<a class="el" href="a00125.html">OperationPlan</a> *, const <a class="el" href="a00103.html">Load</a> *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#af29285721b0f1da7828967fd751bf252">setLoad</a> (const <a class="el" href="a00103.html">Load</a> *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#a10145d82ee2c48553803262480792f2d">update</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html#a845aea8535b5fd2bbc91bd95ba517995">~LoadPlan</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="a00105.html#a25d02bae2fdf98b0e172fa1ed43826d4">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="a00105.html#a5105155c6ef43ae632c2f8ef74968324">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="a00105.html#a6e18b5c115a1d82ce796ef1bc4909c6d">OperationPlan::LoadPlanIterator</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This class represents the resource capacity of an operationplan. </p>
<p>For both the start and the end date of the operationplan, a loadplan object is created. These are then inserted in the timeline structure associated with a resource. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04803">4803</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="af510b8574f749397aabc3bbc0310db5b"></a><!-- doxytag: member="frepple::LoadPlan::LoadPlan" ref="af510b8574f749397aabc3bbc0310db5b" args="(OperationPlan *, const Load *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::LoadPlan::LoadPlan </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00125.html">OperationPlan</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="a00103.html">Load</a> * </td>
<td class="paramname"> <em>r</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>Public constructor.<br/>
This constructor constructs the starting loadplan and will also call a private constructor to creates the ending loadplan. In other words, a single call to the constructor will create two loadplan objects. </p>
<p>Definition at line <a class="el" href="a00213_source.html#l00052">52</a> of file <a class="el" href="a00213_source.html">loadplan.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a845aea8535b5fd2bbc91bd95ba517995"></a><!-- doxytag: member="frepple::LoadPlan::~LoadPlan" ref="a845aea8535b5fd2bbc91bd95ba517995" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::LoadPlan::~LoadPlan </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="a00213_source.html#l00174">174</a> of file <a class="el" href="a00213_source.html">loadplan.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a9a3adbd225be3dac4ff62f622b1b6a66"></a><!-- doxytag: member="frepple::LoadPlan::getattro" ref="a9a3adbd225be3dac4ff62f622b1b6a66" args="(const Attribute &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PyObject * frepple::LoadPlan::getattro </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00002.html">Attribute</a> & </td>
<td class="paramname"> <em>attr</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default getattro method. <br/>
Subclasses are expected to implement an override if the type supports gettattro. </p>
<p>Reimplemented from <a class="el" href="a00151.html#af3cfc29003472070ba9e133bcf5eb335">frepple::utils::PythonExtensionBase</a>.</p>
<p>Definition at line <a class="el" href="a00213_source.html#l00343">343</a> of file <a class="el" href="a00213_source.html">loadplan.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aaae23704c7fb0d7b379003e0280670cf"></a><!-- doxytag: member="frepple::LoadPlan::getHidden" ref="aaae23704c7fb0d7b379003e0280670cf" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool frepple::LoadPlan::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 loadplan is hidden.<br/>
This is determined by looking at whether the load is hidden or not. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04853">4853</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa62c4a262f2146c1f53f032314aebe97"></a><!-- doxytag: member="frepple::LoadPlan::getLoad" ref="aa62c4a262f2146c1f53f032314aebe97" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="a00103.html">Load</a>* frepple::LoadPlan::getLoad </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the load of which this is a plan instance. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04819">4819</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0969aca89148ba44b97211d25177cbed"></a><!-- doxytag: member="frepple::LoadPlan::getOperationPlan" ref="a0969aca89148ba44b97211d25177cbed" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00125.html">OperationPlan</a>* frepple::LoadPlan::getOperationPlan </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 owning this loadplan. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04816">4816</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="acad3d65dc1ef64a74ba42474d5dd20fa"></a><!-- doxytag: member="frepple::LoadPlan::getOtherLoadPlan" ref="acad3d65dc1ef64a74ba42474d5dd20fa" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00105.html">LoadPlan</a> * frepple::LoadPlan::getOtherLoadPlan </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Each operationplan has 2 loadplans per load: one at the start, when the capacity consumption starts, and one at the end, when the capacity consumption ends.<br/>
This method returns the "companion" loadplan. It is not very scalable: the performance is linear with the number of loadplans on the resource. </p>
<p>Definition at line <a class="el" href="a00213_source.html#l00123">123</a> of file <a class="el" href="a00213_source.html">loadplan.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a88541f3fad5fb0f1b12fc2cb91908e7e"></a><!-- doxytag: member="frepple::LoadPlan::getResource" ref="a88541f3fad5fb0f1b12fc2cb91908e7e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="a00156.html">Resource</a>* frepple::LoadPlan::getResource </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the resource. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04822">4822</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a15b97b617417b2186a43a4b827ecee73"></a><!-- doxytag: member="frepple::LoadPlan::getSetup" ref="a15b97b617417b2186a43a4b827ecee73" args="(bool=true) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const string & frepple::LoadPlan::getSetup </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>current</em> = <code>true</code></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the current setup of the resource.<br/>
When the argument is true (= default) the current setup is returned.<br/>
When the argument is false the setup just before the loadplan is returned. </p>
<p>Definition at line <a class="el" href="a00213_source.html#l00150">150</a> of file <a class="el" href="a00213_source.html">loadplan.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad93093d41d6ba3f415eedf80522ad4f1"></a><!-- doxytag: member="frepple::LoadPlan::getTimeLine" ref="ad93093d41d6ba3f415eedf80522ad4f1" 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="a00105.html">LoadPlan</a>>* frepple::LoadPlan::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 loadplan. </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#l04841">4841</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a25d02bae2fdf98b0e172fa1ed43826d4"></a><!-- doxytag: member="frepple::LoadPlan::initialize" ref="a25d02bae2fdf98b0e172fa1ed43826d4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int frepple::LoadPlan::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="a00213_source.html#l00037">37</a> of file <a class="el" href="a00213_source.html">loadplan.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad9328f39af6a9759d0e97572f87d6f67"></a><!-- doxytag: member="frepple::LoadPlan::isStart" ref="ad9328f39af6a9759d0e97572f87d6f67" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool frepple::LoadPlan::isStart </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return true when this loadplan marks the start of an operationplan. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l04830">4830</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="af29285721b0f1da7828967fd751bf252"></a><!-- doxytag: member="frepple::LoadPlan::setLoad" ref="af29285721b0f1da7828967fd751bf252" args="(const Load *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::LoadPlan::setLoad </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00103.html">Load</a> * </td>
<td class="paramname"> <em>newld</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Update the load of an already existing flowplan.<br/>
The new load must belong to the same operation. </p>
<p>Definition at line <a class="el" href="a00213_source.html#l00213">213</a> of file <a class="el" href="a00213_source.html">loadplan.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a10145d82ee2c48553803262480792f2d"></a><!-- doxytag: member="frepple::LoadPlan::update" ref="a10145d82ee2c48553803262480792f2d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::LoadPlan::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 loadplan date or quantity are changed. </p>
<p>Definition at line <a class="el" href="a00213_source.html#l00131">131</a> of file <a class="el" href="a00213_source.html">loadplan.cpp</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a6e18b5c115a1d82ce796ef1bc4909c6d"></a><!-- doxytag: member="frepple::LoadPlan::OperationPlan::LoadPlanIterator" ref="a6e18b5c115a1d82ce796ef1bc4909c6d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="a00106.html">OperationPlan::LoadPlanIterator</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00218_source.html#l04805">4805</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="a5105155c6ef43ae632c2f8ef74968324"></a><!-- doxytag: member="frepple::LoadPlan::metadata" ref="a5105155c6ef43ae632c2f8ef74968324" 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="a00105.html#a5105155c6ef43ae632c2f8ef74968324">frepple::LoadPlan::metadata</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00218_source.html#l04865">4865</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="a00213_source.html">loadplan.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>
