Sophie

Sophie

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

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::ProblemInvalidData 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="a00142.html">ProblemInvalidData</a>
  </div>
</div>
<div class="contents">
<h1>frepple::ProblemInvalidData Class Reference</h1><!-- doxytag: class="frepple::ProblemInvalidData" --><!-- doxytag: inherits="frepple::Problem" -->
<p>A <a class="el" href="a00134.html" title="A problem represents infeasibilities, alerts and warnings in the plan.">Problem</a> of this class is created in the model when a data exception prevents planning of certain objects.  
<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::ProblemInvalidData:</div>
<div class="dynsection">
<div class="center"><img src="a00501.png" border="0" usemap="#frepple_1_1_problem_invalid_data_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1_problem_invalid_data_inherit__map" id="frepple_1_1_problem_invalid_data_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="a00502.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="a00142.html#af3bbb2a72681a70a455aed16abbf728e">getDates</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00142.html#afa3fda28f4b2686e8167e0d1e4b53b4b">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="a00142.html#a2d17bb2d5d0518898e17db468f62c455">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="a00142.html#a2b2e1a7228ccb5854b7720a2d699dc30">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="a00142.html#a27e883271d2170a65f5507d4d3487587">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="a00142.html#a2db282b507ee45309395bcae4180752e">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="a00142.html#aa0359b6fb897e08e9a26b72508fa6875">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="a00142.html#a75d3e152ba273b0dc6aa886e4b726c9d">isFeasible</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00142.html#a69093a3aea37b832da11cc2602b9f894">ProblemInvalidData</a> (<a class="el" href="a00086.html">HasProblems</a> *o, string d, string e, <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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00142.html#ade260ce847688371de4fdd2c21084181">~ProblemInvalidData</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="a00142.html#a5d8c463f13053c0527013927e8b737ee">metadata</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A <a class="el" href="a00134.html" title="A problem represents infeasibilities, alerts and warnings in the plan.">Problem</a> of this class is created in the model when a data exception prevents planning of certain objects. </p>

<p>Definition at line <a class="el" href="a00218_source.html#l05189">5189</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="a69093a3aea37b832da11cc2602b9f894"></a><!-- doxytag: member="frepple::ProblemInvalidData::ProblemInvalidData" ref="a69093a3aea37b832da11cc2602b9f894" args="(HasProblems *o, string d, string e, Date st, Date nd, double q, bool add=true)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">frepple::ProblemInvalidData::ProblemInvalidData </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00086.html">HasProblems</a> *&nbsp;</td>
          <td class="paramname"> <em>o</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">string&nbsp;</td>
          <td class="paramname"> <em>d</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">string&nbsp;</td>
          <td class="paramname"> <em>e</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00049.html">Date</a>&nbsp;</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>&nbsp;</td>
          <td class="paramname"> <em>nd</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>q</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#l05195">5195</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="ade260ce847688371de4fdd2c21084181"></a><!-- doxytag: member="frepple::ProblemInvalidData::~ProblemInvalidData" ref="ade260ce847688371de4fdd2c21084181" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">frepple::ProblemInvalidData::~ProblemInvalidData </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#l05199">5199</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="af3bbb2a72681a70a455aed16abbf728e"></a><!-- doxytag: member="frepple::ProblemInvalidData::getDates" ref="af3bbb2a72681a70a455aed16abbf728e" 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::ProblemInvalidData::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#l05201">5201</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="afa3fda28f4b2686e8167e0d1e4b53b4b"></a><!-- doxytag: member="frepple::ProblemInvalidData::getDescription" ref="afa3fda28f4b2686e8167e0d1e4b53b4b" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string frepple::ProblemInvalidData::getDescription </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 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="a00218_source.html#l05192">5192</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="a2d17bb2d5d0518898e17db468f62c455"></a><!-- doxytag: member="frepple::ProblemInvalidData::getEntity" ref="a2d17bb2d5d0518898e17db468f62c455" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string frepple::ProblemInvalidData::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#l05200">5200</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="a2b2e1a7228ccb5854b7720a2d699dc30"></a><!-- doxytag: member="frepple::ProblemInvalidData::getOwner" ref="a2b2e1a7228ccb5854b7720a2d699dc30" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00120.html">Object</a>* frepple::ProblemInvalidData::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#l05202">5202</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="a27e883271d2170a65f5507d4d3487587"></a><!-- doxytag: member="frepple::ProblemInvalidData::getSize" ref="a27e883271d2170a65f5507d4d3487587" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t frepple::ProblemInvalidData::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#l05210">5210</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="a2db282b507ee45309395bcae4180752e"></a><!-- doxytag: member="frepple::ProblemInvalidData::getType" ref="a2db282b507ee45309395bcae4180752e" 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::ProblemInvalidData::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#l05214">5214</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="aa0359b6fb897e08e9a26b72508fa6875"></a><!-- doxytag: member="frepple::ProblemInvalidData::getWeight" ref="aa0359b6fb897e08e9a26b72508fa6875" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double frepple::ProblemInvalidData::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#l05194">5194</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="a75d3e152ba273b0dc6aa886e4b726c9d"></a><!-- doxytag: member="frepple::ProblemInvalidData::isFeasible" ref="a75d3e152ba273b0dc6aa886e4b726c9d" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool frepple::ProblemInvalidData::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#l05193">5193</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="a5d8c463f13053c0527013927e8b737ee"></a><!-- doxytag: member="frepple::ProblemInvalidData::metadata" ref="a5d8c463f13053c0527013927e8b737ee" 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="a00142.html#a5d8c463f13053c0527013927e8b737ee">frepple::ProblemInvalidData::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#l05217">5217</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>
</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>