<!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: pythonforecast.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_cfc6129efafb4deb1379318d01a4b532.html">modules</a> » <a class="el" href="dir_4a975c66df64d91ea50e31e1c6371883.html">forecast</a>
</div>
</div>
<div class="contents">
<h1>pythonforecast.cpp</h1><a href="a00232.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/modules/forecast/pythonforecast.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>00028 <span class="preprocessor">#include "<a class="code" href="a00204.html" title="Header file for the module forecast.">forecast.h</a>"</span>
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="keyword">namespace </span>module_forecast
<a name="l00031"></a>00031 {
<a name="l00032"></a>00032
<a name="l00033"></a>00033
<a name="l00034"></a><a class="code" href="a00072.html#aec8f8c238a8cb202cd176332b71ebd3b">00034</a> PyObject* <a class="code" href="a00072.html#aec8f8c238a8cb202cd176332b71ebd3b">Forecast::getattro</a>(<span class="keyword">const</span> <a class="code" href="a00002.html" title="A class to model keyword instances.">Attribute</a>& attr)
<a name="l00035"></a>00035 {
<a name="l00036"></a>00036 <span class="keywordflow">if</span> (attr.<a class="code" href="a00002.html#aebffce6c4fcf1696ca34f63f2b6ee091">isA</a>(<a class="code" href="a00177.html#af73b7397b82ca602df4b4e35a2fa41c0">Tags::tag_calendar</a>))
<a name="l00037"></a>00037 <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="a00072.html#a424607b08d7f501ec1552c65915c407a">getCalendar</a>());
<a name="l00038"></a>00038 <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#aed69995b3ea237df03211c52edfe2a3e">Tags::tag_discrete</a>))
<a name="l00039"></a>00039 <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="a00072.html#a64b5b2b91ee5408e10d8a4e3748ec1f5">getDiscrete</a>());
<a name="l00040"></a>00040 <span class="keywordflow">return</span> <a class="code" href="a00072.html#aec8f8c238a8cb202cd176332b71ebd3b">Demand::getattro</a>(attr);
<a name="l00041"></a>00041 }
<a name="l00042"></a>00042
<a name="l00043"></a>00043
<a name="l00044"></a><a class="code" href="a00072.html#a2427de0bf9ce7f2ca779b8740deced52">00044</a> <span class="keywordtype">int</span> <a class="code" href="a00072.html#a2427de0bf9ce7f2ca779b8740deced52">Forecast::setattro</a>(<span class="keyword">const</span> <a class="code" href="a00002.html" title="A class to model keyword instances.">Attribute</a>& 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>& field)
<a name="l00045"></a>00045 {
<a name="l00046"></a>00046 <span class="keywordflow">if</span> (attr.<a class="code" href="a00002.html#aebffce6c4fcf1696ca34f63f2b6ee091">isA</a>(<a class="code" href="a00177.html#af73b7397b82ca602df4b4e35a2fa41c0">Tags::tag_calendar</a>))
<a name="l00047"></a>00047 {
<a name="l00048"></a>00048 <span class="keywordflow">if</span> (!field.<a class="code" href="a00154.html#aa5f7a25056671e8df629cd42b0061b28">check</a>(Calendar::metadata))
<a name="l00049"></a>00049 {
<a name="l00050"></a>00050 PyErr_SetString(<a class="code" href="a00257.html#a75c689d2dca4282e2ca0dad79dab1063" title="Python exception class matching with frepple::DataException.">PythonDataException</a>, <span class="stringliteral">"forecast calendar must be of type calendar"</span>);
<a name="l00051"></a>00051 <span class="keywordflow">return</span> -1;
<a name="l00052"></a>00052 }
<a name="l00053"></a>00053 <a class="code" href="a00013.html" title="This is the class used to represent variables that are varying over time.">Calendar</a>* y = <span class="keyword">static_cast<</span><a class="code" href="a00013.html" title="This is the class used to represent variables that are varying over time.">Calendar</a>*<span class="keyword">></span>(<span class="keyword">static_cast<</span>PyObject*<span class="keyword">></span>(field));
<a name="l00054"></a>00054 <a class="code" href="a00072.html#a1cb40a614cc39d2121edba4912fd5847">setCalendar</a>(y);
<a name="l00055"></a>00055 }
<a name="l00056"></a>00056 <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#aed69995b3ea237df03211c52edfe2a3e">Tags::tag_discrete</a>))
<a name="l00057"></a>00057 <a class="code" href="a00072.html#aec4536cbcd5b29f2e64e71424957c9af">setDiscrete</a>(field.<a class="code" href="a00154.html#a804b478fb76759d334882ee468fc84f9">getBool</a>());
<a name="l00058"></a>00058 <span class="keywordflow">else</span>
<a name="l00059"></a>00059 <span class="keywordflow">return</span> <a class="code" href="a00072.html#a2427de0bf9ce7f2ca779b8740deced52">Demand::setattro</a>(attr, field);
<a name="l00060"></a>00060 <span class="keywordflow">return</span> 0; <span class="comment">// OK</span>
<a name="l00061"></a>00061 }
<a name="l00062"></a>00062
<a name="l00063"></a>00063
<a name="l00064"></a><a class="code" href="a00072.html#a79267a1541b64718bf9136554d94441e">00064</a> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> PyObject* <a class="code" href="a00072.html#a79267a1541b64718bf9136554d94441e">Forecast::timeseries</a>(PyObject *<span class="keyword">self</span>, PyObject *args)
<a name="l00065"></a>00065 {
<a name="l00066"></a>00066 <span class="comment">// Get the forecast model</span>
<a name="l00067"></a>00067 <a class="code" href="a00072.html" title="This class represents a bucketized demand signal.">Forecast</a>* forecast = <span class="keyword">static_cast<</span><a class="code" href="a00072.html" title="This class represents a bucketized demand signal.">Forecast</a>*<span class="keyword">></span>(<span class="keyword">self</span>);
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="comment">// Parse the Python arguments</span>
<a name="l00070"></a>00070 PyObject* history;
<a name="l00071"></a>00071 PyObject* buckets = NULL;
<a name="l00072"></a>00072 <span class="keywordtype">int</span> ok = PyArg_ParseTuple(args, <span class="stringliteral">"O|O"</span>, &history, &buckets);
<a name="l00073"></a>00073 <span class="keywordflow">if</span> (!ok) <span class="keywordflow">return</span> NULL;
<a name="l00074"></a>00074
<a name="l00075"></a>00075 <span class="comment">// Verify we can iterate over the arguments</span>
<a name="l00076"></a>00076 PyObject *historyiterator = PyObject_GetIter(history);
<a name="l00077"></a>00077 PyObject *bucketiterator = NULL;
<a name="l00078"></a>00078 <span class="keywordflow">if</span> (!historyiterator)
<a name="l00079"></a>00079 {
<a name="l00080"></a>00080 PyErr_Format(PyExc_AttributeError,<span class="stringliteral">"Invalid type for time series"</span>);
<a name="l00081"></a>00081 <span class="keywordflow">return</span> NULL;
<a name="l00082"></a>00082 }
<a name="l00083"></a>00083 <span class="keywordflow">if</span> (buckets) bucketiterator = PyObject_GetIter(buckets);
<a name="l00084"></a>00084 <span class="keywordflow">if</span> (!bucketiterator)
<a name="l00085"></a>00085 {
<a name="l00086"></a>00086 PyErr_Format(PyExc_AttributeError,<span class="stringliteral">"Invalid type for time series"</span>);
<a name="l00087"></a>00087 <span class="keywordflow">return</span> NULL;
<a name="l00088"></a>00088 }
<a name="l00089"></a>00089
<a name="l00090"></a>00090 <span class="comment">// Copy the history data into a C++ data structure</span>
<a name="l00091"></a>00091 <span class="keywordtype">double</span> data[300];
<a name="l00092"></a>00092 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> historycount = 0;
<a name="l00093"></a>00093 PyObject *item;
<a name="l00094"></a>00094 <span class="keywordflow">while</span> ((item = PyIter_Next(historyiterator)))
<a name="l00095"></a>00095 {
<a name="l00096"></a>00096 data[historycount++] = PyFloat_AsDouble(item);
<a name="l00097"></a>00097 Py_DECREF(item);
<a name="l00098"></a>00098 <span class="keywordflow">if</span> (historycount>=300) <span class="keywordflow">break</span>;
<a name="l00099"></a>00099 }
<a name="l00100"></a>00100 Py_DECREF(historyiterator);
<a name="l00101"></a>00101
<a name="l00102"></a>00102 <span class="comment">// Copy the bucket data into a C++ data structure</span>
<a name="l00103"></a>00103 <a class="code" href="a00049.html" title="This class represents a date and time with an accuracy of one second.">Date</a> bucketdata[300];
<a name="l00104"></a>00104 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> bucketcount = 0;
<a name="l00105"></a>00105 <span class="keywordflow">while</span> ((item = PyIter_Next(bucketiterator)))
<a name="l00106"></a>00106 {
<a name="l00107"></a>00107 bucketdata[bucketcount++] = <a class="code" href="a00154.html" title="This class handles two-way translation between the data types in C++ and Python.">PythonObject</a>(item).getDate();
<a name="l00108"></a>00108 Py_DECREF(item);
<a name="l00109"></a>00109 <span class="keywordflow">if</span> (bucketcount>=300) <span class="keywordflow">break</span>;
<a name="l00110"></a>00110 }
<a name="l00111"></a>00111 Py_DECREF(bucketiterator);
<a name="l00112"></a>00112
<a name="l00113"></a>00113 Py_BEGIN_ALLOW_THREADS <span class="comment">// Free the Python interpreter for other threads</span>
<a name="l00114"></a>00114 <span class="keywordflow">try</span> {
<a name="l00115"></a>00115 <span class="comment">// Generate the forecast</span>
<a name="l00116"></a>00116 forecast-><a class="code" href="a00072.html#a5c266d5446015daf35d15abd4ba8368c">generateFutureValues</a>
<a name="l00117"></a>00117 (data, historycount, bucketdata, bucketcount, <span class="keyword">true</span>);
<a name="l00118"></a>00118 }
<a name="l00119"></a>00119 <span class="keywordflow">catch</span> (...)
<a name="l00120"></a>00120 {
<a name="l00121"></a>00121 Py_BLOCK_THREADS;
<a name="l00122"></a>00122 PythonType::evalException();
<a name="l00123"></a>00123 <span class="keywordflow">return</span> NULL;
<a name="l00124"></a>00124 }
<a name="l00125"></a>00125 Py_END_ALLOW_THREADS <span class="comment">// Release the Python interpreter</span>
<a name="l00126"></a>00126 <span class="keywordflow">return</span> Py_BuildValue(<span class="stringliteral">""</span>);
<a name="l00127"></a>00127 }
<a name="l00128"></a>00128
<a name="l00129"></a>00129
<a name="l00130"></a><a class="code" href="a00073.html#ade3f84f6ad92522fff6f76792b24c796">00130</a> PyObject* <a class="code" href="a00073.html#ade3f84f6ad92522fff6f76792b24c796">ForecastBucket::getattro</a>(<span class="keyword">const</span> <a class="code" href="a00002.html" title="A class to model keyword instances.">Attribute</a>& attr)
<a name="l00131"></a>00131 {
<a name="l00132"></a>00132 <span class="keywordflow">if</span> (attr.<a class="code" href="a00002.html#aebffce6c4fcf1696ca34f63f2b6ee091">isA</a>(<a class="code" href="a00177.html#ad9f517eb408578e29b6ad9f219174a17">Tags::tag_startdate</a>))
<a name="l00133"></a>00133 <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="a00073.html#a86fcfc356492a8ad2ec2a07219331eb7">getDueRange</a>().<a class="code" href="a00050.html#a73e574de7fbf5df8ebc4c5190e7d49c3">getStart</a>());
<a name="l00134"></a>00134 <span class="keywordflow">if</span> (attr.<a class="code" href="a00002.html#aebffce6c4fcf1696ca34f63f2b6ee091">isA</a>(<a class="code" href="a00177.html#a6ed90c86398dbf951ebdee0a767f2e28">Tags::tag_enddate</a>))
<a name="l00135"></a>00135 <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="a00073.html#a86fcfc356492a8ad2ec2a07219331eb7">getDueRange</a>().<a class="code" href="a00050.html#a165a8f748d8468e5ba8331c0e06bd3a2">getEnd</a>());
<a name="l00136"></a>00136 <span class="keywordflow">if</span> (attr.<a class="code" href="a00002.html#aebffce6c4fcf1696ca34f63f2b6ee091">isA</a>(<a class="code" href="a00072.html#a8f1b1910feb8fcaa9d2a261949cfbb67">Forecast::tag_total</a>))
<a name="l00137"></a>00137 <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="a00073.html#ad8b6e29264104892adfafdc78e8e17db">getTotal</a>());
<a name="l00138"></a>00138 <span class="keywordflow">if</span> (attr.<a class="code" href="a00002.html#aebffce6c4fcf1696ca34f63f2b6ee091">isA</a>(<a class="code" href="a00072.html#aa00855cb99c427b85ed329cf22634431">Forecast::tag_consumed</a>))
<a name="l00139"></a>00139 <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="a00073.html#a501b4d69cf41b838649a50eb2aef4c9c">getConsumed</a>());
<a name="l00140"></a>00140 <span class="keywordflow">if</span> (attr.<a class="code" href="a00002.html#aebffce6c4fcf1696ca34f63f2b6ee091">isA</a>(<a class="code" href="a00177.html#a322eeb623ca6fea00c5ad9f6026ba54c">Tags::tag_weight</a>))
<a name="l00141"></a>00141 <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="a00073.html#aa39b372e48be5f516cb364ed0d025635">getWeight</a>());
<a name="l00142"></a>00142 <span class="keywordflow">return</span> <a class="code" href="a00073.html#ade3f84f6ad92522fff6f76792b24c796">Demand::getattro</a>(attr);
<a name="l00143"></a>00143 }
<a name="l00144"></a>00144
<a name="l00145"></a>00145
<a name="l00146"></a><a class="code" href="a00073.html#ab457351555ddc014de20f2412411ea49">00146</a> <span class="keywordtype">int</span> <a class="code" href="a00073.html#ab457351555ddc014de20f2412411ea49">ForecastBucket::setattro</a>(<span class="keyword">const</span> <a class="code" href="a00002.html" title="A class to model keyword instances.">Attribute</a>& 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>& field)
<a name="l00147"></a>00147 {
<a name="l00148"></a>00148 <span class="keywordflow">if</span> (attr.<a class="code" href="a00002.html#aebffce6c4fcf1696ca34f63f2b6ee091">isA</a>(<a class="code" href="a00072.html#a8f1b1910feb8fcaa9d2a261949cfbb67">Forecast::tag_total</a>))
<a name="l00149"></a>00149 <a class="code" href="a00073.html#a7efb5987d5d43cce60d9b36312c16b18">setTotal</a>(field.<a class="code" href="a00154.html#ad292e9b75b65eef65ff8701939ab348a">getDouble</a>());
<a name="l00150"></a>00150 <span class="keywordflow">else</span> <span class="keywordflow">if</span> (attr.<a class="code" href="a00002.html#aebffce6c4fcf1696ca34f63f2b6ee091">isA</a>(<a class="code" href="a00072.html#aa00855cb99c427b85ed329cf22634431">Forecast::tag_consumed</a>))
<a name="l00151"></a>00151 <a class="code" href="a00073.html#a9cf95fd6e0d3db71d9b63a742c9cec94">setConsumed</a>(field.<a class="code" href="a00154.html#ad292e9b75b65eef65ff8701939ab348a">getDouble</a>());
<a name="l00152"></a>00152 <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#a322eeb623ca6fea00c5ad9f6026ba54c">Tags::tag_weight</a>))
<a name="l00153"></a>00153 <a class="code" href="a00073.html#acedef7dd335c933fa119d335d8a6df20">setWeight</a>(field.<a class="code" href="a00154.html#ad292e9b75b65eef65ff8701939ab348a">getDouble</a>());
<a name="l00154"></a>00154 <span class="keywordflow">else</span>
<a name="l00155"></a>00155 <span class="keywordflow">return</span> <a class="code" href="a00073.html#ab457351555ddc014de20f2412411ea49">Demand::setattro</a>(attr, field);
<a name="l00156"></a>00156 <span class="keywordflow">return</span> 0; <span class="comment">// OK</span>
<a name="l00157"></a>00157 }
<a name="l00158"></a>00158
<a name="l00159"></a>00159
<a name="l00160"></a>00160 } <span class="comment">// end namespace</span>
</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>
