Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > 54cac1c2268db633d66eeff1b4faa585 > files > 416

frepple-doc-0.8.1-3.fc15.noarch.rpm

<!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::ProblemEarly 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&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;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&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="a00256.html">frepple</a>::<a class="el" href="a00140.html">ProblemEarly</a>
  </div>
</div>
<div class="contents">
<h1>frepple::ProblemEarly Class Reference</h1><!-- doxytag: class="frepple::ProblemEarly" --><!-- doxytag: inherits="frepple::Problem" -->
<p>A problem of this class is created when a demand is planned earlier than the accepted tolerance before its due date.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00218_source.html">model.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for frepple::ProblemEarly:</div>
<div class="dynsection">
<div class="center"><img src="a00497.png" border="0" usemap="#frepple_1_1_problem_early_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1_problem_early_inherit__map" id="frepple_1_1_problem_early_inherit__map">
<area shape="rect" id="node2" href="a00134.html" title="A problem represents infeasibilities, alerts and warnings in the plan." alt="" coords="125,161,240,189"/>
<area shape="rect" id="node4" href="a00119.html" title="Class NonCopyable is a base class. Derive your own class from it when you want to..." alt="" coords="5,83,181,111"/>
<area shape="rect" id="node6" href="a00120.html" title="Object is the abstract base class for the main entities." alt="" coords="205,83,341,111"/>
<area shape="rect" id="node8" href="a00151.html" title="This is a base class for all Python extension types." alt="" coords="160,6,387,34"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="a00498.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">const <a class="el" href="a00050.html">DateRange</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00140.html#acd0b81e032251aa2638f769c614c76b5">getDates</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00051.html">Demand</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00140.html#a9e05f4f881626bafe013fd3a7c083d2d">getDemand</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00140.html#ac710c5342837f6917534231a7b80e304">getDescription</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00140.html#ad44e67cadfcee6b0ccab59cc8b8b8ff3">getEntity</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00120.html">Object</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00140.html#aa561127356b359e05a87abf0ad888183">getOwner</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00140.html#ad88702a8f441676884f8d123f32b2e98">getSize</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="a00115.html">MetaClass</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00140.html#a719bca02cf8bcaa306d9937f51309386">getType</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00140.html#ae21dda70dc7b3aaa4670b8c9fbf0b67b">getWeight</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00140.html#a13a4eb640fef0880d82dd7f051316abd">isFeasible</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00140.html#a8d2bd123dc1719e795296447b67557a8">ProblemEarly</a> (<a class="el" href="a00051.html">Demand</a> *d, bool add=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00140.html#a4de46e9670aeccddb3ffd35d65d814d7">~ProblemEarly</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="a00115.html">MetaClass</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00140.html#abf3dfbf6f5b6e0880e76feb008872728">metadata</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A problem of this class is created when a demand is planned earlier than the accepted tolerance before its due date. </p>

<p>Definition at line <a class="el" href="a00218_source.html#l05151">5151</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a8d2bd123dc1719e795296447b67557a8"></a><!-- doxytag: member="frepple::ProblemEarly::ProblemEarly" ref="a8d2bd123dc1719e795296447b67557a8" args="(Demand *d, bool add=true)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">frepple::ProblemEarly::ProblemEarly </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00051.html">Demand</a> *&nbsp;</td>
          <td class="paramname"> <em>d</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>add</em> = <code>true</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline, explicit]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="a00218_source.html#l05164">5164</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="a4de46e9670aeccddb3ffd35d65d814d7"></a><!-- doxytag: member="frepple::ProblemEarly::~ProblemEarly" ref="a4de46e9670aeccddb3ffd35d65d814d7" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">frepple::ProblemEarly::~ProblemEarly </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="a00218_source.html#l05166">5166</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="acd0b81e032251aa2638f769c614c76b5"></a><!-- doxytag: member="frepple::ProblemEarly::getDates" ref="acd0b81e032251aa2638f769c614c76b5" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="a00050.html">DateRange</a> frepple::ProblemEarly::getDates </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the duration of this problem. </p>

<p>Implements <a class="el" href="a00134.html#af283f4815d85c0b33d112efe4435737b">frepple::Problem</a>.</p>

<p>Definition at line <a class="el" href="a00218_source.html#l05169">5169</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="a9e05f4f881626bafe013fd3a7c083d2d"></a><!-- doxytag: member="frepple::ProblemEarly::getDemand" ref="a9e05f4f881626bafe013fd3a7c083d2d" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00051.html">Demand</a>* frepple::ProblemEarly::getDemand </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="a00218_source.html#l05175">5175</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="ac710c5342837f6917534231a7b80e304"></a><!-- doxytag: member="frepple::ProblemEarly::getDescription" ref="ac710c5342837f6917534231a7b80e304" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string frepple::ProblemEarly::getDescription </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns a text description of this problem. </p>

<p>Implements <a class="el" href="a00134.html#a37253df6ba9ebdbea97e9f789dfb8bb2">frepple::Problem</a>.</p>

<p>Definition at line <a class="el" href="a00229_source.html#l00139">139</a> of file <a class="el" href="a00229_source.html">problems_demand.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="ad44e67cadfcee6b0ccab59cc8b8b8ff3"></a><!-- doxytag: member="frepple::ProblemEarly::getEntity" ref="ad44e67cadfcee6b0ccab59cc8b8b8ff3" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string frepple::ProblemEarly::getEntity </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the object type having this problem. </p>

<p>Implements <a class="el" href="a00134.html#a393e211b1d4da9fbc4cb1b1284248c1b">frepple::Problem</a>.</p>

<p>Definition at line <a class="el" href="a00218_source.html#l05167">5167</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="aa561127356b359e05a87abf0ad888183"></a><!-- doxytag: member="frepple::ProblemEarly::getOwner" ref="aa561127356b359e05a87abf0ad888183" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00120.html">Object</a>* frepple::ProblemEarly::getOwner </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns a pointer to the object that owns this problem. </p>

<p>Implements <a class="el" href="a00134.html#a66e1a9cb011d009afffb32f428c06fdf">frepple::Problem</a>.</p>

<p>Definition at line <a class="el" href="a00218_source.html#l05168">5168</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="ad88702a8f441676884f8d123f32b2e98"></a><!-- doxytag: member="frepple::ProblemEarly::getSize" ref="ad88702a8f441676884f8d123f32b2e98" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t frepple::ProblemEarly::getSize </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</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>Implements <a class="el" href="a00120.html#ae381655a0e700d1e0d9ef72379792872">frepple::utils::Object</a>.</p>

<p>Definition at line <a class="el" href="a00218_source.html#l05176">5176</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="a719bca02cf8bcaa306d9937f51309386"></a><!-- doxytag: member="frepple::ProblemEarly::getType" ref="a719bca02cf8bcaa306d9937f51309386" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="a00115.html">MetaClass</a>&amp; frepple::ProblemEarly::getType </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return a reference to the metadata structure. </p>

<p>Reimplemented from <a class="el" href="a00134.html#a8a73cf77f0bed3a807e65f9844d9baf4">frepple::Problem</a>.</p>

<p>Definition at line <a class="el" href="a00218_source.html#l05179">5179</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="ae21dda70dc7b3aaa4670b8c9fbf0b67b"></a><!-- doxytag: member="frepple::ProblemEarly::getWeight" ref="ae21dda70dc7b3aaa4670b8c9fbf0b67b" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double frepple::ProblemEarly::getWeight </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns a double number reflecting the magnitude of the problem. This allows us to focus on the significant problems and filter out the small ones. </p>

<p>Implements <a class="el" href="a00134.html#aeac2c097edda9dee786247f8cd69bb4b">frepple::Problem</a>.</p>

<p>Definition at line <a class="el" href="a00218_source.html#l05156">5156</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="a13a4eb640fef0880d82dd7f051316abd"></a><!-- doxytag: member="frepple::ProblemEarly::isFeasible" ref="a13a4eb640fef0880d82dd7f051316abd" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool frepple::ProblemEarly::isFeasible </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns true if the plan remains feasible even if it contains this problem, i.e. if the problems flags only a warning. Returns false if a certain problem points at an infeasibility of the plan. </p>

<p>Implements <a class="el" href="a00134.html#a3ce24ef75c043698afa411a6f9eeca61">frepple::Problem</a>.</p>

<p>Definition at line <a class="el" href="a00218_source.html#l05155">5155</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="abf3dfbf6f5b6e0880e76feb008872728"></a><!-- doxytag: member="frepple::ProblemEarly::metadata" ref="abf3dfbf6f5b6e0880e76feb008872728" 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="a00140.html#abf3dfbf6f5b6e0880e76feb008872728">frepple::ProblemEarly::metadata</a><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Storing metadata on this class. </p>

<p>Reimplemented from <a class="el" href="a00134.html#a9e707be88274a5c5d7bc4c71f2ea1338">frepple::Problem</a>.</p>

<p>Definition at line <a class="el" href="a00218_source.html#l05182">5182</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="a00227_source.html">problem.cpp</a></li>
<li><a class="el" href="a00229_source.html">problems_demand.cpp</a></li>
</ul>
</div>
<hr size="1"/><address style="align: right;"><small>Documentation generated for frePPLe by&nbsp;
<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>