<!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::Plannable 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="a00133.html">Plannable</a>
</div>
</div>
<div class="contents">
<h1>frepple::Plannable Class Reference</h1><!-- doxytag: class="frepple::Plannable" --><!-- doxytag: inherits="frepple::HasProblems,frepple::Solvable" -->
<p>This class needs to be implemented by all classes that implement dynamic behavior in 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::Plannable:</div>
<div class="dynsection">
<div class="center"><img src="a00481.png" border="0" usemap="#frepple_1_1_plannable_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1_plannable_inherit__map" id="frepple_1_1_plannable_inherit__map">
<area shape="rect" id="node7" href="a00008.html" title="A buffer represents a combination of a item and location.  It is the entity for keeping..." alt="" coords="387,81,485,109"/>
<area shape="rect" id="node15" href="a00051.html" title="Represents the (independent) demand in the system. It can represent a customer order..." alt="" coords="379,233,493,261"/>
<area shape="rect" id="node23" href="a00121.html" title="An operation represents an activity: these consume and produce material, take time..." alt="" coords="375,385,497,413"/>
<area shape="rect" id="node35" href="a00132.html" title="This is the (logical) top class of the complete model." alt="" coords="389,435,483,463"/>
<area shape="rect" id="node37" href="a00156.html" title="This class represents a workcentre, a physical or logical representation of capacity..." alt="" coords="375,562,497,590"/>
<area shape="rect" id="node2" href="a00086.html" title="Classes that keep track of problem conditions need to implement this class." alt="" coords="7,359,151,387"/>
<area shape="rect" id="node4" href="a00170.html" title="This class needs to be implemented by all classes that implement dynamic behavior..." alt="" coords="21,410,136,438"/>
<area shape="rect" id="node9" href="a00009.html" title="This class is the default implementation of the abstract Buffer class." alt="" coords="585,5,724,33"/>
<area shape="rect" id="node11" href="a00010.html" title="This class represents a material buffer with an infinite supply of extra material..." alt="" coords="587,55,723,83"/>
<area shape="rect" id="node13" href="a00012.html" title="This class models a buffer that is replenish by an external supplier using a reorder-point..." alt="" coords="583,106,727,134"/>
<area shape="rect" id="node17" href="a00052.html" title="This class is the default implementation of the abstract Demand class." alt="" coords="577,157,732,185"/>
<area shape="rect" id="node19" href="a00072.html" title="This class represents a bucketized demand signal." alt="" coords="567,207,743,235"/>
<area shape="rect" id="node21" href="a00073.html" title="This class represents a forecast value in a time bucket." alt="" coords="547,258,763,286"/>
<area shape="rect" id="node25" href="a00122.html" title="This class represents a choice between multiple operations. The alternates are sorted..." alt="" coords="567,309,743,337"/>
<area shape="rect" id="node27" href="a00123.html" title="Models an operation that takes a fixed amount of time, independent of the quantity..." alt="" coords="563,359,747,387"/>
<area shape="rect" id="node29" href="a00128.html" title="Represents a routing operation, i.e. an operation consisting of multiple, sequential..." alt="" coords="571,410,739,438"/>
<area shape="rect" id="node31" href="a00129.html" title="Models an operation to convert a setup on a resource." alt="" coords="576,461,733,489"/>
<area shape="rect" id="node33" href="a00130.html" title="Models an operation whose duration is the sum of a constant time, plus a cetain time..." alt="" coords="569,511,740,539"/>
<area shape="rect" id="node39" href="a00157.html" title="This class is the default implementation of the abstract Resource class." alt="" coords="573,562,736,590"/>
<area shape="rect" id="node41" href="a00158.html" title="This class represents a resource that'll never have any capacity shortage." alt="" coords="575,613,735,641"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a00482.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">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00133.html#adbaec4d97d9773b4eb1d63ea935d75ba">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">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00133.html#ad9ce53f3b9bdc55b7a9832cdfb991b87">getChanged</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00133.html#a060a1f4f9488fb2f287470127b59f5ec">getDetectProblems</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00133.html">Plannable</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00133.html#a31e0f131d2f97b203fc1dcab1d1dcd35">getEntity</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00133.html#a48173b237592533378d2f97e3ea5ceae">Plannable</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00133.html#a11a86a6e020664a337325a96a64f6d2c">setChanged</a> (bool b=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00133.html#a1bd0cabdb794a96725c03c2a74aa3662">setDetectProblems</a> (bool b)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00133.html#af52c6c3386a937db2bc91a1950622462">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 colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00133.html#a53bdeef1e395514631372ae74b596b2a">computeProblems</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This class needs to be implemented by all classes that implement dynamic behavior in the plan. </p>
<p>The problem detection logic is implemented in the detectProblems() method. For performance reasons, problem detection is "lazy", i.e. problems are computed only when somebody really needs the access to the list of problems. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l01214">1214</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a48173b237592533378d2f97e3ea5ceae"></a><!-- doxytag: member="frepple::Plannable::Plannable" ref="a48173b237592533378d2f97e3ea5ceae" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::Plannable::Plannable </td>
<td>(</td>
<td class="paramname"></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#l01218">1218</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="a53bdeef1e395514631372ae74b596b2a"></a><!-- doxytag: member="frepple::Plannable::computeProblems" ref="a53bdeef1e395514631372ae74b596b2a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Plannable::computeProblems </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Loops through all plannable objects and updates their problems if required. </p>
<p>Definition at line <a class="el" href="a00227_source.html#l00178">178</a> of file <a class="el" href="a00227_source.html">problem.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="adbaec4d97d9773b4eb1d63ea935d75ba"></a><!-- doxytag: member="frepple::Plannable::endElement" ref="adbaec4d97d9773b4eb1d63ea935d75ba" args="(XMLInput &, const Attribute &, const DataElement &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Plannable::endElement </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00186.html">XMLInput</a> & </td>
<td class="paramname"> <em>pIn</em>, </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"> <em>pAttr</em>, </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"> <em>pElement</em></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>Reimplemented in <a class="el" href="a00121.html#aa201f6f1dd9d0194ac419345333a5a7f">frepple::Operation</a>, <a class="el" href="a00123.html#aa83d7a485466fa68f047cd9bcacb5bf7">frepple::OperationFixedTime</a>, <a class="el" href="a00130.html#a19fb3f3759863a01b23df6566c602495">frepple::OperationTimePer</a>, <a class="el" href="a00128.html#a17ba27923c4f9e18199c48a9e4c7c980">frepple::OperationRouting</a>, <a class="el" href="a00122.html#aa1a730f69090603825c925e332491b4c">frepple::OperationAlternate</a>, <a class="el" href="a00008.html#a561782e0a5a6fb84c62209aba172a241">frepple::Buffer</a>, <a class="el" href="a00012.html#a50c10dee04e69195b5cccf8d91f9a3e9">frepple::BufferProcure</a>, <a class="el" href="a00156.html#a9c2b68e465e4a45d7e1c0f2125172eb6">frepple::Resource</a>, <a class="el" href="a00132.html#a728ace4034264f9e326eaeeab2e27464">frepple::Plan</a>, <a class="el" href="a00051.html#a368aa3430232ac2886706f8c1c448c73">frepple::Demand</a>, and <a class="el" href="a00072.html#a7684ca786326565eb2f7ceed1a821c5d">module_forecast::Forecast</a>.</p>
<p>Definition at line <a class="el" href="a00227_source.html#l00228">228</a> of file <a class="el" href="a00227_source.html">problem.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad9ce53f3b9bdc55b7a9832cdfb991b87"></a><!-- doxytag: member="frepple::Plannable::getChanged" ref="ad9ce53f3b9bdc55b7a9832cdfb991b87" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool frepple::Plannable::getChanged </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>See if this entity has changed since the last problem problem detection run. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l01233">1233</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a060a1f4f9488fb2f287470127b59f5ec"></a><!-- doxytag: member="frepple::Plannable::getDetectProblems" ref="a060a1f4f9488fb2f287470127b59f5ec" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool frepple::Plannable::getDetectProblems </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether or not this object needs to detect problems. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l01225">1225</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a31e0f131d2f97b203fc1dcab1d1dcd35"></a><!-- doxytag: member="frepple::Plannable::getEntity" ref="a31e0f131d2f97b203fc1dcab1d1dcd35" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00133.html">Plannable</a>* frepple::Plannable::getEntity </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implement the pure virtual function from the HasProblem class. </p>
<p>Implements <a class="el" href="a00086.html#a97837ce18709d6ee5535f15f39b1676b">frepple::HasProblems</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l01240">1240</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a11a86a6e020664a337325a96a64f6d2c"></a><!-- doxytag: member="frepple::Plannable::setChanged" ref="a11a86a6e020664a337325a96a64f6d2c" args="(bool b=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Plannable::setChanged </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>b</em> = <code>true</code></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Mark that this entity has been updated and that the problem detection needs to be redone. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l01237">1237</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a1bd0cabdb794a96725c03c2a74aa3662"></a><!-- doxytag: member="frepple::Plannable::setDetectProblems" ref="a1bd0cabdb794a96725c03c2a74aa3662" args="(bool b)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Plannable::setDetectProblems </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>b</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Specify whether this entity reports problems. </p>
<p>Definition at line <a class="el" href="a00227_source.html#l00164">164</a> of file <a class="el" href="a00227_source.html">problem.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af52c6c3386a937db2bc91a1950622462"></a><!-- doxytag: member="frepple::Plannable::writeElement" ref="af52c6c3386a937db2bc91a1950622462" args="(XMLOutput *, const Keyword &, mode=DEFAULT) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Plannable::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<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented in <a class="el" href="a00121.html#a3db91252184523fa8246064446d56b60">frepple::Operation</a>, <a class="el" href="a00123.html#aaa6f2f9a016a3af3db4d3703b0ef469f">frepple::OperationFixedTime</a>, <a class="el" href="a00129.html#afcbe8d4db472da78e2f9391078173e6f">frepple::OperationSetup</a>, <a class="el" href="a00130.html#a3b99f67bf66dd84414770ce2ee8617a4">frepple::OperationTimePer</a>, <a class="el" href="a00128.html#a6b681054d10d974688b5a0d92ea4d5f7">frepple::OperationRouting</a>, <a class="el" href="a00122.html#abc8519120ca9ff5e0be1a65131751a09">frepple::OperationAlternate</a>, <a class="el" href="a00008.html#a8e72becff5b6b068ce2cd9e008902209">frepple::Buffer</a>, <a class="el" href="a00010.html#a49b7c093cc51337c3f9536eca163416f">frepple::BufferInfinite</a>, <a class="el" href="a00012.html#a452abe7405e755e660a5b11a670c4996">frepple::BufferProcure</a>, <a class="el" href="a00156.html#a9b84a7753b5eca34228a34170d4b7174">frepple::Resource</a>, <a class="el" href="a00158.html#a5cde905609c6f34480bb33dfc0cd9add">frepple::ResourceInfinite</a>, <a class="el" href="a00132.html#abf19f56523e84d1ff33187bb7af4ba6b">frepple::Plan</a>, <a class="el" href="a00051.html#af36c6828c858ed4bc7c26fa2ddc33c23">frepple::Demand</a>, and <a class="el" href="a00072.html#a0d4e1372b309d8a5d1efbe4e8049621c">module_forecast::Forecast</a>.</p>
<p>Definition at line <a class="el" href="a00227_source.html#l00218">218</a> of file <a class="el" href="a00227_source.html">problem.cpp</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="a00227_source.html">problem.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>
