<!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::ProblemCapacityOverload 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="a00137.html">ProblemCapacityOverload</a>
</div>
</div>
<div class="contents">
<h1>frepple::ProblemCapacityOverload Class Reference</h1><!-- doxytag: class="frepple::ProblemCapacityOverload" --><!-- doxytag: inherits="frepple::Problem" -->
<p>A problem of this class is created when a resource is being overloaded during a certain period of time.
<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::ProblemCapacityOverload:</div>
<div class="dynsection">
<div class="center"><img src="a00491.png" border="0" usemap="#frepple_1_1_problem_capacity_overload_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1_problem_capacity_overload_inherit__map" id="frepple_1_1_problem_capacity_overload_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="a00492.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> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00137.html#a9922f56dcb6a1be746c864a9c7da675d">getDates</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00137.html#a2ea4a1ba2b3127a1100e066754b39a9f">getDescription</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00137.html#a2fe091b3d530d69d29b515dc81f7f163">getEntity</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00120.html">Object</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00137.html#a13c984ea173b1859314f4f2242064e89">getOwner</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00156.html">Resource</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00137.html#aef00b4c5382cc41b3dd289cf707c327d">getResource</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00137.html#a8d48531319ab5b458961b4b1cc726c3e">getSize</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="a00115.html">MetaClass</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00137.html#a7a79b8ed4938884bf731056b67ff097f">getType</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="a00137.html#ad4e3131c7f9190da5462ce6c608b50a5">getWeight</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00137.html#a6a30768f2d97c3b7a6889c976bf27d55">isFeasible</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00137.html#a69e58ec524b522589624d811c2c3a8e2">ProblemCapacityOverload</a> (<a class="el" href="a00156.html">Resource</a> *r, <a class="el" href="a00049.html">Date</a> st, <a class="el" href="a00049.html">Date</a> nd, double q, bool add=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00137.html#a875571a6a31333a2b2e82a8d9b82bba6">~ProblemCapacityOverload</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> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00137.html#ae943a0ede255ced55bc8ac355c50fff6">metadata</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A problem of this class is created when a resource is being overloaded during a certain period of time. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l05301">5301</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a69e58ec524b522589624d811c2c3a8e2"></a><!-- doxytag: member="frepple::ProblemCapacityOverload::ProblemCapacityOverload" ref="a69e58ec524b522589624d811c2c3a8e2" args="(Resource *r, Date st, Date nd, double q, bool add=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::ProblemCapacityOverload::ProblemCapacityOverload </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00156.html">Resource</a> * </td>
<td class="paramname"> <em>r</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00049.html">Date</a> </td>
<td class="paramname"> <em>st</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00049.html">Date</a> </td>
<td class="paramname"> <em>nd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>q</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>add</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00218_source.html#l05307">5307</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a875571a6a31333a2b2e82a8d9b82bba6"></a><!-- doxytag: member="frepple::ProblemCapacityOverload::~ProblemCapacityOverload" ref="a875571a6a31333a2b2e82a8d9b82bba6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::ProblemCapacityOverload::~ProblemCapacityOverload </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00218_source.html#l05309">5309</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="a9922f56dcb6a1be746c864a9c7da675d"></a><!-- doxytag: member="frepple::ProblemCapacityOverload::getDates" ref="a9922f56dcb6a1be746c864a9c7da675d" 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::ProblemCapacityOverload::getDates </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </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#l05312">5312</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2ea4a1ba2b3127a1100e066754b39a9f"></a><!-- doxytag: member="frepple::ProblemCapacityOverload::getDescription" ref="a2ea4a1ba2b3127a1100e066754b39a9f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string frepple::ProblemCapacityOverload::getDescription </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </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="a00231_source.html#l00141">141</a> of file <a class="el" href="a00231_source.html">problems_resource.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a2fe091b3d530d69d29b515dc81f7f163"></a><!-- doxytag: member="frepple::ProblemCapacityOverload::getEntity" ref="a2fe091b3d530d69d29b515dc81f7f163" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string frepple::ProblemCapacityOverload::getEntity </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </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#l05310">5310</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a13c984ea173b1859314f4f2242064e89"></a><!-- doxytag: member="frepple::ProblemCapacityOverload::getOwner" ref="a13c984ea173b1859314f4f2242064e89" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00120.html">Object</a>* frepple::ProblemCapacityOverload::getOwner </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </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#l05311">5311</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="aef00b4c5382cc41b3dd289cf707c327d"></a><!-- doxytag: member="frepple::ProblemCapacityOverload::getResource" ref="aef00b4c5382cc41b3dd289cf707c327d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00156.html">Resource</a>* frepple::ProblemCapacityOverload::getResource </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00218_source.html#l05313">5313</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8d48531319ab5b458961b4b1cc726c3e"></a><!-- doxytag: member="frepple::ProblemCapacityOverload::getSize" ref="a8d48531319ab5b458961b4b1cc726c3e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t frepple::ProblemCapacityOverload::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>Implements <a class="el" href="a00120.html#ae381655a0e700d1e0d9ef72379792872">frepple::utils::Object</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l05314">5314</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7a79b8ed4938884bf731056b67ff097f"></a><!-- doxytag: member="frepple::ProblemCapacityOverload::getType" ref="a7a79b8ed4938884bf731056b67ff097f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="a00115.html">MetaClass</a>& frepple::ProblemCapacityOverload::getType </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 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#l05317">5317</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad4e3131c7f9190da5462ce6c608b50a5"></a><!-- doxytag: member="frepple::ProblemCapacityOverload::getWeight" ref="ad4e3131c7f9190da5462ce6c608b50a5" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double frepple::ProblemCapacityOverload::getWeight </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </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#l05306">5306</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6a30768f2d97c3b7a6889c976bf27d55"></a><!-- doxytag: member="frepple::ProblemCapacityOverload::isFeasible" ref="a6a30768f2d97c3b7a6889c976bf27d55" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool frepple::ProblemCapacityOverload::isFeasible </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </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#l05305">5305</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="ae943a0ede255ced55bc8ac355c50fff6"></a><!-- doxytag: member="frepple::ProblemCapacityOverload::metadata" ref="ae943a0ede255ced55bc8ac355c50fff6" 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="a00137.html#ae943a0ede255ced55bc8ac355c50fff6">frepple::ProblemCapacityOverload::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#l05320">5320</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="a00231_source.html">problems_resource.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>
