<!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: module_forecast::ForecastBucket 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="a00258.html">module_forecast</a>::<a class="el" href="a00073.html">ForecastBucket</a>
</div>
</div>
<div class="contents">
<h1>module_forecast::ForecastBucket Class Reference</h1><!-- doxytag: class="module_forecast::ForecastBucket" --><!-- doxytag: inherits="frepple::Demand" -->
<p>This class represents a forecast value in a time bucket.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00204_source.html">forecast.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for module_forecast::ForecastBucket:</div>
<div class="dynsection">
<div class="center"><img src="a00681.png" border="0" usemap="#module__forecast_1_1_forecast_bucket_inherit__map" alt="Inheritance graph"/></div>
<map name="module__forecast_1_1_forecast_bucket_inherit__map" id="module__forecast_1_1_forecast_bucket_inherit__map">
<area shape="rect" id="node2" href="a00051.html" title="Represents the (independent) demand in the system. It can represent a customer order..." alt="" coords="1097,106,1212,134"/>
<area shape="rect" id="node4" href="a00083.html" title="frepple::utils::HasHierarchy\< Demand \>" alt="" coords="799,55,1047,83"/>
<area shape="rect" id="node6" href="a00085.html" title="frepple::utils::HasName\< Demand \>" alt="" coords="521,55,748,83"/>
<area shape="rect" id="node8" href="a00119.html" title="Class NonCopyable is a base class. Derive your own class from it when you want to..." alt="" coords="289,5,465,33"/>
<area shape="rect" id="node10" href="a00182.html" title="This class represents a node in the tree." alt="" coords="284,55,471,83"/>
<area shape="rect" id="node12" href="a00120.html" title="Object is the abstract base class for the main entities." alt="" coords="309,106,445,134"/>
<area shape="rect" id="node14" href="a00151.html" title="This is a base class for all Python extension types." alt="" coords="7,106,233,134"/>
<area shape="rect" id="node16" href="a00133.html" title="This class needs to be implemented by all classes that implement dynamic behavior..." alt="" coords="861,106,984,134"/>
<area shape="rect" id="node18" href="a00086.html" title="Classes that keep track of problem conditions need to implement this class." alt="" coords="563,106,707,134"/>
<area shape="rect" id="node20" href="a00170.html" title="This class needs to be implemented by all classes that implement dynamic behavior..." alt="" coords="577,157,692,185"/>
<area shape="rect" id="node22" href="a00082.html" title="This is a decorator class for the main objects." alt="" coords="829,157,1016,185"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a00682.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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#a078a7de0bed94630056b55f9cdb573d6">ForecastBucket</a> (<a class="el" href="a00072.html">Forecast</a> *f, <a class="el" href="a00049.html">Date</a> d, <a class="el" href="a00049.html">Date</a> e, double w, <a class="el" href="a00073.html">ForecastBucket</a> *p)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual PyObject * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#ade3f84f6ad92522fff6f76792b24c796">getattro</a> (const <a class="el" href="a00002.html">Attribute</a> &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#a501b4d69cf41b838649a50eb2aef4c9c">getConsumed</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00050.html">DateRange</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#a86fcfc356492a8ad2ec2a07219331eb7">getDueRange</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00073.html">ForecastBucket</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#af04c755acad6ee9635f4729d80ba215b">getNextBucket</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00073.html">ForecastBucket</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#aa76a0abad5e7ba73b4b29c7cc9208f91">getPreviousBucket</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#ac332e127008fd13e49627a000fd08cb4">getSize</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#ad8b6e29264104892adfafdc78e8e17db">getTotal</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="a00115.html">MetaClass</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#a5cea298c43e94dfb24844c4ed8c071ba">getType</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#aa39b372e48be5f516cb364ed0d025635">getWeight</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#a82661159f830efafdeac5d3fdfe7c20f">incConsumed</a> (double n)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#a3f19f8587d8748ff1c922f903a743c62">incTotal</a> (double n)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#ab457351555ddc014de20f2412411ea49">setattro</a> (const <a class="el" href="a00002.html">Attribute</a> &, const <a class="el" href="a00154.html">PythonObject</a> &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#a9cf95fd6e0d3db71d9b63a742c9cec94">setConsumed</a> (double n)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#a7efb5987d5d43cce60d9b36312c16b18">setTotal</a> (double n)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#acedef7dd335c933fa119d335d8a6df20">setWeight</a> (double n)</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#ae569e5dc37d82f7e96a85b793965863b">initialize</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#a57a164c790dd16395aaea813adbcb0d0">setDueAtEndOfBucket</a> (bool b)</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="a00073.html#ae08822e2f5a92d979c1b821666eacc9e">metadata</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This class represents a forecast value in a time bucket. </p>
<p>A forecast bucket is never manipulated or created directly. Instead, the owning forecast manages the buckets. </p>
<p>Definition at line <a class="el" href="a00204_source.html#l01116">1116</a> of file <a class="el" href="a00204_source.html">forecast.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a078a7de0bed94630056b55f9cdb573d6"></a><!-- doxytag: member="module_forecast::ForecastBucket::ForecastBucket" ref="a078a7de0bed94630056b55f9cdb573d6" args="(Forecast *f, Date d, Date e, double w, ForecastBucket *p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">module_forecast::ForecastBucket::ForecastBucket </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00072.html">Forecast</a> * </td>
<td class="paramname"> <em>f</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>d</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>e</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>w</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00073.html">ForecastBucket</a> * </td>
<td class="paramname"> <em>p</em></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="a00204_source.html#l01119">1119</a> of file <a class="el" href="a00204_source.html">forecast.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ade3f84f6ad92522fff6f76792b24c796"></a><!-- doxytag: member="module_forecast::ForecastBucket::getattro" ref="ade3f84f6ad92522fff6f76792b24c796" args="(const Attribute &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PyObject * module_forecast::ForecastBucket::getattro </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00002.html">Attribute</a> & </td>
<td class="paramname"> <em>attr</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default getattro method. <br/>
Subclasses are expected to implement an override if the type supports gettattro. </p>
<p>Reimplemented from <a class="el" href="a00051.html#a24cb2ab980abd3b6d69b4d8356c5df0d">frepple::Demand</a>.</p>
<p>Definition at line <a class="el" href="a00232_source.html#l00130">130</a> of file <a class="el" href="a00232_source.html">pythonforecast.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a501b4d69cf41b838649a50eb2aef4c9c"></a><!-- doxytag: member="module_forecast::ForecastBucket::getConsumed" ref="a501b4d69cf41b838649a50eb2aef4c9c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double module_forecast::ForecastBucket::getConsumed </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the consumed forecast. </p>
<p>Definition at line <a class="el" href="a00204_source.html#l01150">1150</a> of file <a class="el" href="a00204_source.html">forecast.h</a>.</p>
</div>
</div>
<a class="anchor" id="a86fcfc356492a8ad2ec2a07219331eb7"></a><!-- doxytag: member="module_forecast::ForecastBucket::getDueRange" ref="a86fcfc356492a8ad2ec2a07219331eb7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00050.html">DateRange</a> module_forecast::ForecastBucket::getDueRange </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the date range for this bucket. </p>
<p>Definition at line <a class="el" href="a00204_source.html#l01200">1200</a> of file <a class="el" href="a00204_source.html">forecast.h</a>.</p>
</div>
</div>
<a class="anchor" id="af04c755acad6ee9635f4729d80ba215b"></a><!-- doxytag: member="module_forecast::ForecastBucket::getNextBucket" ref="af04c755acad6ee9635f4729d80ba215b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00073.html">ForecastBucket</a>* module_forecast::ForecastBucket::getNextBucket </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a pointer to the next forecast bucket. </p>
<p>Definition at line <a class="el" href="a00204_source.html#l01203">1203</a> of file <a class="el" href="a00204_source.html">forecast.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa76a0abad5e7ba73b4b29c7cc9208f91"></a><!-- doxytag: member="module_forecast::ForecastBucket::getPreviousBucket" ref="aa76a0abad5e7ba73b4b29c7cc9208f91" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00073.html">ForecastBucket</a>* module_forecast::ForecastBucket::getPreviousBucket </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a pointer to the previous forecast bucket. </p>
<p>Definition at line <a class="el" href="a00204_source.html#l01206">1206</a> of file <a class="el" href="a00204_source.html">forecast.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac332e127008fd13e49627a000fd08cb4"></a><!-- doxytag: member="module_forecast::ForecastBucket::getSize" ref="ac332e127008fd13e49627a000fd08cb4" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t module_forecast::ForecastBucket::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="a00204_source.html#l01136">1136</a> of file <a class="el" href="a00204_source.html">forecast.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad8b6e29264104892adfafdc78e8e17db"></a><!-- doxytag: member="module_forecast::ForecastBucket::getTotal" ref="ad8b6e29264104892adfafdc78e8e17db" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double module_forecast::ForecastBucket::getTotal </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the total, gross forecast. </p>
<p>Definition at line <a class="el" href="a00204_source.html#l01147">1147</a> of file <a class="el" href="a00204_source.html">forecast.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5cea298c43e94dfb24844c4ed8c071ba"></a><!-- doxytag: member="module_forecast::ForecastBucket::getType" ref="a5cea298c43e94dfb24844c4ed8c071ba" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="a00115.html">MetaClass</a>& module_forecast::ForecastBucket::getType </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This returns the type information on the object, a bit similar to the standard type_info information. </p>
<p>Reimplemented from <a class="el" href="a00051.html#ac7635aa8627fde61557bdd522e118fff">frepple::Demand</a>.</p>
<p>Definition at line <a class="el" href="a00204_source.html#l01134">1134</a> of file <a class="el" href="a00204_source.html">forecast.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa39b372e48be5f516cb364ed0d025635"></a><!-- doxytag: member="module_forecast::ForecastBucket::getWeight" ref="aa39b372e48be5f516cb364ed0d025635" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double module_forecast::ForecastBucket::getWeight </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the relative weight of this forecast bucket when distributing forecast over different buckets. </p>
<p>Definition at line <a class="el" href="a00204_source.html#l01144">1144</a> of file <a class="el" href="a00204_source.html">forecast.h</a>.</p>
</div>
</div>
<a class="anchor" id="a82661159f830efafdeac5d3fdfe7c20f"></a><!-- doxytag: member="module_forecast::ForecastBucket::incConsumed" ref="a82661159f830efafdeac5d3fdfe7c20f" args="(double n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void module_forecast::ForecastBucket::incConsumed </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>n</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Increment the consumed forecast. </p>
<p>Definition at line <a class="el" href="a00204_source.html#l01179">1179</a> of file <a class="el" href="a00204_source.html">forecast.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3f19f8587d8748ff1c922f903a743c62"></a><!-- doxytag: member="module_forecast::ForecastBucket::incTotal" ref="a3f19f8587d8748ff1c922f903a743c62" args="(double n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void module_forecast::ForecastBucket::incTotal </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>n</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Increment the total, gross forecast. </p>
<p>Definition at line <a class="el" href="a00204_source.html#l01161">1161</a> of file <a class="el" href="a00204_source.html">forecast.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae569e5dc37d82f7e96a85b793965863b"></a><!-- doxytag: member="module_forecast::ForecastBucket::initialize" ref="ae569e5dc37d82f7e96a85b793965863b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int module_forecast::ForecastBucket::initialize </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="a00051.html#a769fc15a201e0de840f8e8bc76f15215">frepple::Demand</a>.</p>
<p>Definition at line <a class="el" href="a00203_source.html#l00057">57</a> of file <a class="el" href="a00203_source.html">forecast.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab457351555ddc014de20f2412411ea49"></a><!-- doxytag: member="module_forecast::ForecastBucket::setattro" ref="ab457351555ddc014de20f2412411ea49" args="(const Attribute &, const PythonObject &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int module_forecast::ForecastBucket::setattro </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00002.html">Attribute</a> & </td>
<td class="paramname"> <em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00154.html">PythonObject</a> & </td>
<td class="paramname"> <em>field</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default setattro method. <br/>
Subclasses are expected to implement an override if the type supports settattro. </p>
<p>Reimplemented from <a class="el" href="a00051.html#a088c9f23e4be2ff8413c9de6449f4c74">frepple::Demand</a>.</p>
<p>Definition at line <a class="el" href="a00232_source.html#l00146">146</a> of file <a class="el" href="a00232_source.html">pythonforecast.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9cf95fd6e0d3db71d9b63a742c9cec94"></a><!-- doxytag: member="module_forecast::ForecastBucket::setConsumed" ref="a9cf95fd6e0d3db71d9b63a742c9cec94" args="(double n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void module_forecast::ForecastBucket::setConsumed </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>n</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Update the consumed forecast.<br/>
This field is normally updated through the forecast netting solver, but you can use this method to update it directly. </p>
<p>Definition at line <a class="el" href="a00204_source.html#l01190">1190</a> of file <a class="el" href="a00204_source.html">forecast.h</a>.</p>
</div>
</div>
<a class="anchor" id="a57a164c790dd16395aaea813adbcb0d0"></a><!-- doxytag: member="module_forecast::ForecastBucket::setDueAtEndOfBucket" ref="a57a164c790dd16395aaea813adbcb0d0" args="(bool b)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void module_forecast::ForecastBucket::setDueAtEndOfBucket </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>b</em></td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A flag to mark whether forecast is due at the start or at the end of a bucket.<br/>
The default is false, ie due at the start of the bucket. </p>
<p>Definition at line <a class="el" href="a00204_source.html#l01212">1212</a> of file <a class="el" href="a00204_source.html">forecast.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7efb5987d5d43cce60d9b36312c16b18"></a><!-- doxytag: member="module_forecast::ForecastBucket::setTotal" ref="a7efb5987d5d43cce60d9b36312c16b18" args="(double n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void module_forecast::ForecastBucket::setTotal </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>n</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Update the total, gross forecast. </p>
<p>Definition at line <a class="el" href="a00204_source.html#l01169">1169</a> of file <a class="el" href="a00204_source.html">forecast.h</a>.</p>
</div>
</div>
<a class="anchor" id="acedef7dd335c933fa119d335d8a6df20"></a><!-- doxytag: member="module_forecast::ForecastBucket::setWeight" ref="acedef7dd335c933fa119d335d8a6df20" args="(double n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void module_forecast::ForecastBucket::setWeight </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>n</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Update the weight of this forecasting bucket. </p>
<p>Definition at line <a class="el" href="a00204_source.html#l01153">1153</a> of file <a class="el" href="a00204_source.html">forecast.h</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ae08822e2f5a92d979c1b821666eacc9e"></a><!-- doxytag: member="module_forecast::ForecastBucket::metadata" ref="ae08822e2f5a92d979c1b821666eacc9e" 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="a00073.html#ae08822e2f5a92d979c1b821666eacc9e">module_forecast::ForecastBucket::metadata</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="a00051.html#ab47d40bcf25de651514118609b00362b">frepple::Demand</a>.</p>
<p>Definition at line <a class="el" href="a00204_source.html#l01135">1135</a> of file <a class="el" href="a00204_source.html">forecast.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="a00204_source.html">forecast.h</a></li>
<li><a class="el" href="a00203_source.html">forecast.cpp</a></li>
<li><a class="el" href="a00232_source.html">pythonforecast.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>
