<!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: problems_demand.cpp Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_88117dff2735251a69c8eb9084477714.html">src</a> » <a class="el" href="dir_25032d30b6d615a661c02e2ac1394b01.html">model</a>
</div>
</div>
<div class="contents">
<h1>problems_demand.cpp</h1><a href="a00229.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/***************************************************************************</span>
<a name="l00002"></a>00002 <span class="comment"> file : $URL: https://frepple.svn.sourceforge.net/svnroot/frepple/trunk/src/model/problems_demand.cpp $</span>
<a name="l00003"></a>00003 <span class="comment"> version : $LastChangedRevision: 1315 $ $LastChangedBy: jdetaeye $</span>
<a name="l00004"></a>00004 <span class="comment"> date : $LastChangedDate: 2010-07-17 18:08:53 +0200 (Sat, 17 Jul 2010) $</span>
<a name="l00005"></a>00005 <span class="comment"> ***************************************************************************/</span>
<a name="l00006"></a>00006
<a name="l00007"></a>00007 <span class="comment">/***************************************************************************</span>
<a name="l00008"></a>00008 <span class="comment"> * *</span>
<a name="l00009"></a>00009 <span class="comment"> * Copyright (C) 2007-2010 by Johan De Taeye *</span>
<a name="l00010"></a>00010 <span class="comment"> * *</span>
<a name="l00011"></a>00011 <span class="comment"> * This library is free software; you can redistribute it and/or modify it *</span>
<a name="l00012"></a>00012 <span class="comment"> * under the terms of the GNU Lesser General Public License as published *</span>
<a name="l00013"></a>00013 <span class="comment"> * by the Free Software Foundation; either version 2.1 of the License, or *</span>
<a name="l00014"></a>00014 <span class="comment"> * (at your option) any later version. *</span>
<a name="l00015"></a>00015 <span class="comment"> * *</span>
<a name="l00016"></a>00016 <span class="comment"> * This library is distributed in the hope that it will be useful, *</span>
<a name="l00017"></a>00017 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of *</span>
<a name="l00018"></a>00018 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser *</span>
<a name="l00019"></a>00019 <span class="comment"> * General Public License for more details. *</span>
<a name="l00020"></a>00020 <span class="comment"> * *</span>
<a name="l00021"></a>00021 <span class="comment"> * You should have received a copy of the GNU Lesser General Public *</span>
<a name="l00022"></a>00022 <span class="comment"> * License along with this library; if not, write to the Free Software *</span>
<a name="l00023"></a>00023 <span class="comment"> * Foundation Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,*</span>
<a name="l00024"></a>00024 <span class="comment"> * USA *</span>
<a name="l00025"></a>00025 <span class="comment"> * *</span>
<a name="l00026"></a>00026 <span class="comment"> ***************************************************************************/</span>
<a name="l00027"></a>00027
<a name="l00028"></a><a class="code" href="a00229.html#a342983a479ae7a921be5face83fdb029">00028</a> <span class="preprocessor">#define FREPPLE_CORE</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#include "<a class="code" href="a00218.html">frepple/model.h</a>"</span>
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="keyword">namespace </span>frepple
<a name="l00032"></a>00032 {
<a name="l00033"></a>00033
<a name="l00034"></a>00034
<a name="l00035"></a><a class="code" href="a00051.html#a67d94aa1ffe1f5f41b62a5dc26e07f20">00035</a> <a class="code" href="a00252.html#a99b94ab8c2f2a32277559c7b2b0a054c">DECLARE_EXPORT</a> <span class="keywordtype">void</span> <a class="code" href="a00051.html#a67d94aa1ffe1f5f41b62a5dc26e07f20">Demand::updateProblems</a>()
<a name="l00036"></a>00036 {
<a name="l00037"></a>00037 <span class="comment">// The relation between the demand and the related problem classes is such</span>
<a name="l00038"></a>00038 <span class="comment">// that the demand object is the only active one. The problem objects are</span>
<a name="l00039"></a>00039 <span class="comment">// fully controlled and managed by the associated demand object.</span>
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="comment">// A flag for each problem type that may need to be created</span>
<a name="l00042"></a>00042 <span class="keywordtype">bool</span> needsNotPlanned(<span class="keyword">false</span>);
<a name="l00043"></a>00043 <span class="keywordtype">bool</span> needsEarly(<span class="keyword">false</span>);
<a name="l00044"></a>00044 <span class="keywordtype">bool</span> needsLate(<span class="keyword">false</span>);
<a name="l00045"></a>00045 <span class="keywordtype">bool</span> needsShort(<span class="keyword">false</span>);
<a name="l00046"></a>00046 <span class="keywordtype">bool</span> needsExcess(<span class="keyword">false</span>);
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <span class="comment">// Problem detection disabled on this demand</span>
<a name="l00049"></a>00049 <span class="keywordflow">if</span> (!<a class="code" href="a00133.html#a060a1f4f9488fb2f287470127b59f5ec">getDetectProblems</a>()) <span class="keywordflow">return</span>;
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="comment">// Check which problems need to be created</span>
<a name="l00052"></a>00052 <span class="keywordflow">if</span> (deli.empty())
<a name="l00053"></a>00053 {
<a name="l00054"></a>00054 <span class="comment">// Check if a new ProblemDemandNotPlanned needs to be created</span>
<a name="l00055"></a>00055 <span class="keywordflow">if</span> (<a class="code" href="a00051.html#af5fe6f1b6e8f9b2c24ce3479b6546444">getQuantity</a>()>0.0) needsNotPlanned = <span class="keyword">true</span>;
<a name="l00056"></a>00056 }
<a name="l00057"></a>00057 <span class="keywordflow">else</span>
<a name="l00058"></a>00058 {
<a name="l00059"></a>00059 <span class="comment">// Loop through the deliveries</span>
<a name="l00060"></a>00060 <span class="keywordflow">for</span> (OperationPlan_list::iterator i = deli.begin(); i!=deli.end(); ++i)
<a name="l00061"></a>00061 {
<a name="l00062"></a>00062 <span class="comment">// Check for ProblemLate problem</span>
<a name="l00063"></a>00063 <span class="keywordtype">long</span> d(<a class="code" href="a00051.html#ab21889e9a16e3701a84ba8f3aa68628b">getDue</a>() - (*i)->getDates().getEnd());
<a name="l00064"></a>00064 <span class="keywordflow">if</span> (d < 0L) needsLate = <span class="keyword">true</span>;
<a name="l00065"></a>00065 <span class="comment">// Check for ProblemEarly problem</span>
<a name="l00066"></a>00066 <span class="keywordflow">else</span> <span class="keywordflow">if</span> (d > 0L) needsEarly = <span class="keyword">true</span>;
<a name="l00067"></a>00067 }
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="comment">// Check for ProblemShort problem</span>
<a name="l00070"></a>00070 <span class="keywordtype">double</span> plannedqty = <a class="code" href="a00051.html#aa20cd6f8d1aef67b9822d2f847911168">getPlannedQuantity</a>();
<a name="l00071"></a>00071 <span class="keywordflow">if</span> (plannedqty + <a class="code" href="a00252.html#a42d90a6275119e1b4ce73c50f1867e60">ROUNDING_ERROR</a> < qty) needsShort = <span class="keyword">true</span>;
<a name="l00072"></a>00072
<a name="l00073"></a>00073 <span class="comment">// Check for ProblemExcess Problem</span>
<a name="l00074"></a>00074 <span class="keywordflow">if</span> (plannedqty - <a class="code" href="a00252.html#a42d90a6275119e1b4ce73c50f1867e60">ROUNDING_ERROR</a> > qty) needsExcess = <span class="keyword">true</span>;
<a name="l00075"></a>00075 }
<a name="l00076"></a>00076
<a name="l00077"></a>00077 <span class="comment">// Loop through the existing problems</span>
<a name="l00078"></a>00078 <span class="keywordflow">for</span> (<a class="code" href="a00039.html" title="This class models an STL-like iterator that allows us to iterate over the named entities...">Problem::const_iterator</a> j = <a class="code" href="a00134.html#a1532b2bb7078ebcd527a8bf332ffb861">Problem::begin</a>(<span class="keyword">this</span>, <span class="keyword">false</span>);
<a name="l00079"></a>00079 j!=<a class="code" href="a00085.html#abb9d04973550ac71037718511358f2ff">Problem::end</a>(); )
<a name="l00080"></a>00080 {
<a name="l00081"></a>00081 <span class="comment">// Need to increment now and define a pointer to the problem, since the</span>
<a name="l00082"></a>00082 <span class="comment">// problem can be deleted soon (which invalidates the iterator).</span>
<a name="l00083"></a>00083 <a class="code" href="a00134.html" title="A problem represents infeasibilities, alerts and warnings in the plan.">Problem</a>& curprob = *j;
<a name="l00084"></a>00084 ++j;
<a name="l00085"></a>00085 <span class="comment">// The if-statement keeps the problem detection code concise and</span>
<a name="l00086"></a>00086 <span class="comment">// concentrated. However, a drawback of this design is that a new Problem</span>
<a name="l00087"></a>00087 <span class="comment">// subclass will also require a new Demand subclass. I think such a link</span>
<a name="l00088"></a>00088 <span class="comment">// is acceptable.</span>
<a name="l00089"></a>00089 <span class="keywordflow">if</span> (<span class="keyword">typeid</span>(curprob) == <span class="keyword">typeid</span>(<a class="code" href="a00140.html" title="A problem of this class is created when a demand is planned earlier than the accepted...">ProblemEarly</a>))
<a name="l00090"></a>00090 {
<a name="l00091"></a>00091 <span class="comment">// if: problem needed and it exists already</span>
<a name="l00092"></a>00092 <span class="keywordflow">if</span> (needsEarly) needsEarly = <span class="keyword">false</span>;
<a name="l00093"></a>00093 <span class="comment">// else: problem not needed but it exists already</span>
<a name="l00094"></a>00094 <span class="keywordflow">else</span> <span class="keyword">delete</span> &curprob;
<a name="l00095"></a>00095 }
<a name="l00096"></a>00096 <span class="keywordflow">else</span> <span class="keywordflow">if</span> (<span class="keyword">typeid</span>(curprob) == <span class="keyword">typeid</span>(<a class="code" href="a00139.html" title="A Problem of this class is created in the model when a new demand is brought in the...">ProblemDemandNotPlanned</a>))
<a name="l00097"></a>00097 {
<a name="l00098"></a>00098 <span class="keywordflow">if</span> (needsNotPlanned) needsNotPlanned = <span class="keyword">false</span>;
<a name="l00099"></a>00099 <span class="keywordflow">else</span> <span class="keyword">delete</span> &curprob;
<a name="l00100"></a>00100 }
<a name="l00101"></a>00101 <span class="keywordflow">else</span> <span class="keywordflow">if</span> (<span class="keyword">typeid</span>(curprob) == <span class="keyword">typeid</span>(<a class="code" href="a00144.html" title="A problem of this class is created when a demand is satisfied later than the accepted...">ProblemLate</a>))
<a name="l00102"></a>00102 {
<a name="l00103"></a>00103 <span class="keywordflow">if</span> (needsLate) needsLate = <span class="keyword">false</span>;
<a name="l00104"></a>00104 <span class="keywordflow">else</span> <span class="keyword">delete</span> &curprob;
<a name="l00105"></a>00105 }
<a name="l00106"></a>00106 <span class="keywordflow">else</span> <span class="keywordflow">if</span> (<span class="keyword">typeid</span>(curprob) == <span class="keyword">typeid</span>(<a class="code" href="a00148.html" title="A problem of this class is created when a demand is planned for less than the requested...">ProblemShort</a>))
<a name="l00107"></a>00107 {
<a name="l00108"></a>00108 <span class="keywordflow">if</span> (needsShort) needsShort = <span class="keyword">false</span>;
<a name="l00109"></a>00109 <span class="keywordflow">else</span> <span class="keyword">delete</span> &curprob;
<a name="l00110"></a>00110 }
<a name="l00111"></a>00111 <span class="keywordflow">else</span> <span class="keywordflow">if</span> (<span class="keyword">typeid</span>(curprob) == <span class="keyword">typeid</span>(<a class="code" href="a00141.html" title="A problem of this class is created when a demand is planned for more than the requested...">ProblemExcess</a>))
<a name="l00112"></a>00112 {
<a name="l00113"></a>00113 <span class="keywordflow">if</span> (needsExcess) needsExcess = <span class="keyword">false</span>;
<a name="l00114"></a>00114 <span class="keywordflow">else</span> <span class="keyword">delete</span> &curprob;
<a name="l00115"></a>00115 }
<a name="l00116"></a>00116 <span class="comment">// Note that there may be other demand exceptions that are not caught in</span>
<a name="l00117"></a>00117 <span class="comment">// this loop. These are problems defined and managed by subclasses.</span>
<a name="l00118"></a>00118 }
<a name="l00119"></a>00119
<a name="l00120"></a>00120 <span class="comment">// Create the problems that are required but aren't existing yet.</span>
<a name="l00121"></a>00121 <span class="keywordflow">if</span> (needsNotPlanned) <span class="keyword">new</span> <a class="code" href="a00139.html" title="A Problem of this class is created in the model when a new demand is brought in the...">ProblemDemandNotPlanned</a>(<span class="keyword">this</span>);
<a name="l00122"></a>00122 <span class="keywordflow">if</span> (needsLate) <span class="keyword">new</span> <a class="code" href="a00144.html" title="A problem of this class is created when a demand is satisfied later than the accepted...">ProblemLate</a>(<span class="keyword">this</span>);
<a name="l00123"></a>00123 <span class="keywordflow">if</span> (needsEarly) <span class="keyword">new</span> <a class="code" href="a00140.html" title="A problem of this class is created when a demand is planned earlier than the accepted...">ProblemEarly</a>(<span class="keyword">this</span>);
<a name="l00124"></a>00124 <span class="keywordflow">if</span> (needsShort) <span class="keyword">new</span> <a class="code" href="a00148.html" title="A problem of this class is created when a demand is planned for less than the requested...">ProblemShort</a>(<span class="keyword">this</span>);
<a name="l00125"></a>00125 <span class="keywordflow">if</span> (needsExcess) <span class="keyword">new</span> <a class="code" href="a00141.html" title="A problem of this class is created when a demand is planned for more than the requested...">ProblemExcess</a>(<span class="keyword">this</span>);
<a name="l00126"></a>00126 }
<a name="l00127"></a>00127
<a name="l00128"></a>00128
<a name="l00129"></a><a class="code" href="a00144.html#ade00d69b8bb4102807e6b2f7642f2ca7">00129</a> <a class="code" href="a00252.html#a99b94ab8c2f2a32277559c7b2b0a054c">DECLARE_EXPORT</a> <span class="keywordtype">string</span> <a class="code" href="a00144.html#ade00d69b8bb4102807e6b2f7642f2ca7">ProblemLate::getDescription</a>()<span class="keyword"> const</span>
<a name="l00130"></a>00130 <span class="keyword"></span>{
<a name="l00131"></a>00131 assert(<a class="code" href="a00144.html#ac6a0949020f793f2eaf3ada3720437fb">getDemand</a>() && !<a class="code" href="a00144.html#ac6a0949020f793f2eaf3ada3720437fb">getDemand</a>()->getDelivery().empty());
<a name="l00132"></a>00132 <a class="code" href="a00179.html" title="This class represents a time duration with an accuracy of one second.">TimePeriod</a> t(<a class="code" href="a00144.html#ac6a0949020f793f2eaf3ada3720437fb">getDemand</a>()->getLatestDelivery()-><a class="code" href="a00144.html#abd7b025e57b1384f85d0403d70ebb3ae">getDates</a>().getEnd()
<a name="l00133"></a>00133 - <a class="code" href="a00144.html#ac6a0949020f793f2eaf3ada3720437fb">getDemand</a>()->getDue());
<a name="l00134"></a>00134 <span class="keywordflow">return</span> string(<span class="stringliteral">"Demand '"</span>) + <a class="code" href="a00144.html#ac6a0949020f793f2eaf3ada3720437fb">getDemand</a>()-><a class="code" href="a00182.html#a7416ca220c55147bc1276becc5b9de01">getName</a>() + <span class="stringliteral">"' planned "</span>
<a name="l00135"></a>00135 + string(t) + <span class="stringliteral">" after its due date"</span>;
<a name="l00136"></a>00136 }
<a name="l00137"></a>00137
<a name="l00138"></a>00138
<a name="l00139"></a><a class="code" href="a00140.html#ac710c5342837f6917534231a7b80e304">00139</a> <a class="code" href="a00252.html#a99b94ab8c2f2a32277559c7b2b0a054c">DECLARE_EXPORT</a> <span class="keywordtype">string</span> <a class="code" href="a00140.html#ac710c5342837f6917534231a7b80e304">ProblemEarly::getDescription</a>()<span class="keyword"> const</span>
<a name="l00140"></a>00140 <span class="keyword"></span>{
<a name="l00141"></a>00141 assert(<a class="code" href="a00140.html#a9e05f4f881626bafe013fd3a7c083d2d">getDemand</a>() && !<a class="code" href="a00140.html#a9e05f4f881626bafe013fd3a7c083d2d">getDemand</a>()->getDelivery().empty());
<a name="l00142"></a>00142 <a class="code" href="a00179.html" title="This class represents a time duration with an accuracy of one second.">TimePeriod</a> t(<a class="code" href="a00140.html#a9e05f4f881626bafe013fd3a7c083d2d">getDemand</a>()->getDue()
<a name="l00143"></a>00143 - <a class="code" href="a00140.html#a9e05f4f881626bafe013fd3a7c083d2d">getDemand</a>()->getEarliestDelivery()-><a class="code" href="a00140.html#acd0b81e032251aa2638f769c614c76b5">getDates</a>().getEnd());
<a name="l00144"></a>00144 <span class="keywordflow">return</span> string(<span class="stringliteral">"Demand '"</span>) + <a class="code" href="a00140.html#a9e05f4f881626bafe013fd3a7c083d2d">getDemand</a>()-><a class="code" href="a00182.html#a7416ca220c55147bc1276becc5b9de01">getName</a>() + <span class="stringliteral">"' planned "</span>
<a name="l00145"></a>00145 + string(t) + <span class="stringliteral">" before its due date"</span>;
<a name="l00146"></a>00146 }
<a name="l00147"></a>00147
<a name="l00148"></a>00148 }
</pre></div></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>
