Sophie

Sophie

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

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: solver.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&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><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&nbsp;List</span></a></li>
      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="dir_88117dff2735251a69c8eb9084477714.html">src</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_25032d30b6d615a661c02e2ac1394b01.html">model</a>
  </div>
</div>
<div class="contents">
<h1>solver.cpp</h1><a href="a00238.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/solver.cpp $</span>
<a name="l00003"></a>00003 <span class="comment">  version : $LastChangedRevision: 1108 $  $LastChangedBy: jdetaeye $</span>
<a name="l00004"></a>00004 <span class="comment">  date : $LastChangedDate: 2009-12-06 18:54:18 +0100 (Sun, 06 Dec 2009) $</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) 2009 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="a00238.html#a342983a479ae7a921be5face83fdb029">00028</a> <span class="preprocessor">#define FREPPLE_CORE</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#include &quot;<a class="code" href="a00218.html">frepple/model.h</a>&quot;</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 <span class="keyword">template</span>&lt;<span class="keyword">class</span> Solver&gt; <a class="code" href="a00252.html#a99b94ab8c2f2a32277559c7b2b0a054c">DECLARE_EXPORT</a> <a class="code" href="a00181.html" title="This class implements a binary tree data structure. It is used as a container for...">Tree</a> utils::HasName&lt;Solver&gt;::st;
<a name="l00035"></a>00035 <a class="code" href="a00252.html#a99b94ab8c2f2a32277559c7b2b0a054c">DECLARE_EXPORT</a> <span class="keyword">const</span> <a class="code" href="a00114.html" title="A MetaCategory instance represents metadata for a category of object.">MetaCategory</a>* <a class="code" href="a00171.html#a71e7d22ae04bc1aa927b489f1f022745">Solver::metadata</a>;
<a name="l00036"></a>00036 
<a name="l00037"></a>00037 
<a name="l00038"></a><a class="code" href="a00171.html#a9410da1315fa0ea25e61b7e867c34bac">00038</a> <span class="keywordtype">int</span> <a class="code" href="a00171.html#a9410da1315fa0ea25e61b7e867c34bac">Solver::initialize</a>()
<a name="l00039"></a>00039 {
<a name="l00040"></a>00040   <span class="comment">// Initialize the metadata</span>
<a name="l00041"></a>00041   <a class="code" href="a00171.html#a71e7d22ae04bc1aa927b489f1f022745">metadata</a> = <span class="keyword">new</span> <a class="code" href="a00114.html" title="A MetaCategory instance represents metadata for a category of object.">MetaCategory</a>(<span class="stringliteral">&quot;solver&quot;</span>, <span class="stringliteral">&quot;solvers&quot;</span>, <a class="code" href="a00085.html#ac14340cc8781e6f2b7235d50a1d17914">reader</a>, <a class="code" href="a00085.html#a1071369052edea444a06baa35d7e991e">writer</a>);
<a name="l00042"></a>00042 
<a name="l00043"></a>00043   <span class="comment">// Initialize the Python class</span>
<a name="l00044"></a>00044   <a class="code" href="a00171.html#aa616e2bc3ea78ac9fbf467544032fdc5">FreppleCategory&lt;Solver&gt;::getType</a>().addMethod(<span class="stringliteral">&quot;solve&quot;</span>, <a class="code" href="a00171.html#a6a52d1bf3db700368c4ed5ca9de8d296">solve</a>, METH_NOARGS, <span class="stringliteral">&quot;run the solver&quot;</span>);
<a name="l00045"></a>00045   <span class="keywordflow">return</span> <a class="code" href="a00171.html#a9410da1315fa0ea25e61b7e867c34bac">FreppleCategory&lt;Solver&gt;::initialize</a>();
<a name="l00046"></a>00046 }
<a name="l00047"></a>00047 
<a name="l00048"></a>00048 
<a name="l00049"></a>00049 <a class="code" href="a00252.html#a99b94ab8c2f2a32277559c7b2b0a054c">DECLARE_EXPORT</a> <span class="keywordtype">void</span> <a class="code" href="a00171.html#a710cb60097e6931be16ff0d842e1cb3b">Solver::writeElement</a>
<a name="l00050"></a><a class="code" href="a00171.html#a710cb60097e6931be16ff0d842e1cb3b">00050</a> (<a class="code" href="a00189.html" title="Base class for writing XML formatted data to an output stream.">XMLOutput</a> *o, <span class="keyword">const</span> <a class="code" href="a00096.html" title="This class defines a keyword for the frePPLe data model.">Keyword</a> &amp;tag, <a class="code" href="a00257.html#a20c2c7e4c6b668e71c154ae3eb18f398">mode</a> m) <span class="keyword">const</span>
<a name="l00051"></a>00051 {
<a name="l00052"></a>00052   <span class="comment">// The subclass should have written its own header</span>
<a name="l00053"></a>00053   assert(m == <a class="code" href="a00257.html#a20c2c7e4c6b668e71c154ae3eb18f398a2ad5e75fe119e297630882d182832243">NOHEADER</a>);
<a name="l00054"></a>00054 
<a name="l00055"></a>00055   <span class="comment">// Fields</span>
<a name="l00056"></a>00056   <span class="keywordflow">if</span> (loglevel) o-&gt;<a class="code" href="a00189.html#a711922eea4cfe3c33b97e4188dacc7d2">writeElement</a>(<a class="code" href="a00177.html#afcd1d8e47eb32ee971534eacec64df95">Tags::tag_loglevel</a>, loglevel);
<a name="l00057"></a>00057 
<a name="l00058"></a>00058   <span class="comment">// End object</span>
<a name="l00059"></a>00059   o-&gt;<a class="code" href="a00189.html#a05375aa593bb0514020b035411c8983c">EndObject</a>(tag);
<a name="l00060"></a>00060 }
<a name="l00061"></a>00061 
<a name="l00062"></a>00062 
<a name="l00063"></a><a class="code" href="a00171.html#ab301716662e85f733e8529d305bcc259">00063</a> <a class="code" href="a00252.html#a99b94ab8c2f2a32277559c7b2b0a054c">DECLARE_EXPORT</a> <span class="keywordtype">void</span> <a class="code" href="a00171.html#ab301716662e85f733e8529d305bcc259">Solver::endElement</a>(<a class="code" href="a00186.html" title="This class will read in an XML-file and call the appropriate handler functions of...">XMLInput</a>&amp; pIn, <span class="keyword">const</span> <a class="code" href="a00002.html" title="A class to model keyword instances.">Attribute</a>&amp; pAttr, <span class="keyword">const</span> <a class="code" href="a00047.html" title="This abstract class represents a attribute and value pair for updating objects in...">DataElement</a>&amp; pElement)
<a name="l00064"></a>00064 {
<a name="l00065"></a>00065   <span class="keywordflow">if</span> (pAttr.<a class="code" href="a00002.html#aebffce6c4fcf1696ca34f63f2b6ee091">isA</a>(<a class="code" href="a00177.html#afcd1d8e47eb32ee971534eacec64df95">Tags::tag_loglevel</a>))
<a name="l00066"></a>00066   {
<a name="l00067"></a>00067     <span class="keywordtype">int</span> i = pElement.<a class="code" href="a00047.html#a0d8c973cc584400f5ea5d8acfd82ace2">getInt</a>();
<a name="l00068"></a>00068     <span class="keywordflow">if</span> (i&lt;0 || i&gt;USHRT_MAX)
<a name="l00069"></a>00069       <span class="keywordflow">throw</span> <a class="code" href="a00048.html" title="An exception of this type is thrown when data errors are found.">DataException</a>(<span class="stringliteral">&quot;Invalid log level&quot;</span> + pElement.<a class="code" href="a00047.html#a053aa4cde35b21a399f26bca0132ab3f">getString</a>());
<a name="l00070"></a>00070     <a class="code" href="a00171.html#a373dc4d480568344c336cb193ce3edc2">setLogLevel</a>(i);
<a name="l00071"></a>00071   }
<a name="l00072"></a>00072 }
<a name="l00073"></a>00073 
<a name="l00074"></a>00074 
<a name="l00075"></a><a class="code" href="a00171.html#adfd5b71beb06efcdd5f382734df6dcd9">00075</a> <a class="code" href="a00252.html#a99b94ab8c2f2a32277559c7b2b0a054c">DECLARE_EXPORT</a> PyObject* <a class="code" href="a00171.html#adfd5b71beb06efcdd5f382734df6dcd9">Solver::getattro</a>(<span class="keyword">const</span> <a class="code" href="a00002.html" title="A class to model keyword instances.">Attribute</a>&amp; attr)
<a name="l00076"></a>00076 {
<a name="l00077"></a>00077   <span class="keywordflow">if</span> (attr.<a class="code" href="a00002.html#aebffce6c4fcf1696ca34f63f2b6ee091">isA</a>(<a class="code" href="a00177.html#aeb3841a93774dfc303e3df16304b5af2">Tags::tag_name</a>))
<a name="l00078"></a>00078     <span class="keywordflow">return</span> <a class="code" href="a00154.html" title="This class handles two-way translation between the data types in C++ and Python.">PythonObject</a>(<a class="code" href="a00182.html#a7416ca220c55147bc1276becc5b9de01">getName</a>());
<a name="l00079"></a>00079   <span class="keywordflow">if</span> (attr.<a class="code" href="a00002.html#aebffce6c4fcf1696ca34f63f2b6ee091">isA</a>(<a class="code" href="a00177.html#afcd1d8e47eb32ee971534eacec64df95">Tags::tag_loglevel</a>))
<a name="l00080"></a>00080     <span class="keywordflow">return</span> <a class="code" href="a00154.html" title="This class handles two-way translation between the data types in C++ and Python.">PythonObject</a>(<a class="code" href="a00171.html#a7331226cd4ef515184dff2d118c43423">getLogLevel</a>());
<a name="l00081"></a>00081   <span class="keywordflow">return</span> NULL;
<a name="l00082"></a>00082 }
<a name="l00083"></a>00083 
<a name="l00084"></a>00084 
<a name="l00085"></a><a class="code" href="a00171.html#a238d13fba4132fee44d612f3e2d5b335">00085</a> <a class="code" href="a00252.html#a99b94ab8c2f2a32277559c7b2b0a054c">DECLARE_EXPORT</a> <span class="keywordtype">int</span> <a class="code" href="a00171.html#a238d13fba4132fee44d612f3e2d5b335">Solver::setattro</a>(<span class="keyword">const</span> <a class="code" href="a00002.html" title="A class to model keyword instances.">Attribute</a>&amp; attr, <span class="keyword">const</span> <a class="code" href="a00154.html" title="This class handles two-way translation between the data types in C++ and Python.">PythonObject</a>&amp; field)
<a name="l00086"></a>00086 {
<a name="l00087"></a>00087   <span class="keywordflow">if</span> (attr.<a class="code" href="a00002.html#aebffce6c4fcf1696ca34f63f2b6ee091">isA</a>(<a class="code" href="a00177.html#aeb3841a93774dfc303e3df16304b5af2">Tags::tag_name</a>))
<a name="l00088"></a>00088     <a class="code" href="a00085.html#a97d855d8c9bc9774da9cd8905e242dde">setName</a>(field.<a class="code" href="a00154.html#a471bd4797fe735e12a1f485e05fc5940">getString</a>());
<a name="l00089"></a>00089   <span class="keywordflow">else</span> <span class="keywordflow">if</span> (attr.<a class="code" href="a00002.html#aebffce6c4fcf1696ca34f63f2b6ee091">isA</a>(<a class="code" href="a00177.html#afcd1d8e47eb32ee971534eacec64df95">Tags::tag_loglevel</a>))
<a name="l00090"></a>00090     <a class="code" href="a00171.html#a373dc4d480568344c336cb193ce3edc2">setLogLevel</a>(field.<a class="code" href="a00154.html#a783ec10f02cad37886df55bc3f08ba5e">getInt</a>());
<a name="l00091"></a>00091   <span class="keywordflow">else</span>
<a name="l00092"></a>00092     <span class="keywordflow">return</span> -1;  <span class="comment">// Error</span>
<a name="l00093"></a>00093   <span class="keywordflow">return</span> 0;  <span class="comment">// OK</span>
<a name="l00094"></a>00094 }
<a name="l00095"></a>00095 
<a name="l00096"></a>00096 
<a name="l00097"></a><a class="code" href="a00171.html#a6a52d1bf3db700368c4ed5ca9de8d296">00097</a> <a class="code" href="a00252.html#a99b94ab8c2f2a32277559c7b2b0a054c">DECLARE_EXPORT</a> PyObject *<a class="code" href="a00171.html#a6a52d1bf3db700368c4ed5ca9de8d296">Solver::solve</a>(PyObject *<span class="keyword">self</span>, PyObject *args)
<a name="l00098"></a>00098 {
<a name="l00099"></a>00099   Py_BEGIN_ALLOW_THREADS   <span class="comment">// Free Python interpreter for other threads</span>
<a name="l00100"></a>00100   <span class="keywordflow">try</span>
<a name="l00101"></a>00101   {
<a name="l00102"></a>00102     <span class="keyword">static_cast&lt;</span><a class="code" href="a00171.html" title="This class is an implementation of the &amp;quot;visitor&amp;quot; design pattern. It is...">Solver</a>*<span class="keyword">&gt;</span>(<span class="keyword">self</span>)-&gt;<a class="code" href="a00171.html#a6a52d1bf3db700368c4ed5ca9de8d296">solve</a>();
<a name="l00103"></a>00103   }
<a name="l00104"></a>00104   <span class="keywordflow">catch</span>(...)
<a name="l00105"></a>00105   {
<a name="l00106"></a>00106     Py_BLOCK_THREADS;
<a name="l00107"></a>00107     PythonType::evalException();
<a name="l00108"></a>00108     <span class="keywordflow">return</span> NULL;
<a name="l00109"></a>00109   }
<a name="l00110"></a>00110   Py_END_ALLOW_THREADS   <span class="comment">// Reclaim Python interpreter</span>
<a name="l00111"></a>00111   <span class="keywordflow">return</span> Py_BuildValue(<span class="stringliteral">&quot;&quot;</span>);
<a name="l00112"></a>00112 }
<a name="l00113"></a>00113 
<a name="l00114"></a>00114 } <span class="comment">// end namespace</span>
</pre></div></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>