<!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::Calendar::Bucket 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="a00013.html">Calendar</a>::<a class="el" href="a00004.html">Bucket</a>
</div>
</div>
<div class="contents">
<h1>frepple::Calendar::Bucket Class Reference</h1><!-- doxytag: class="frepple::Calendar::Bucket" --><!-- doxytag: inherits="frepple::utils::Object,frepple::utils::NonCopyable" -->
<p>This class represents a time bucket as a part of a calendar.
<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::Calendar::Bucket:</div>
<div class="dynsection">
<div class="center"><img src="a00349.png" border="0" usemap="#frepple_1_1_calendar_1_1_bucket_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1_calendar_1_1_bucket_inherit__map" id="frepple_1_1_calendar_1_1_bucket_inherit__map">
<area shape="rect" id="node9" href="a00006.html" title="A special type of calendar bucket, designed to hold a pointer to an object." alt="" coords="723,5,1003,33"/>
<area shape="rect" id="node11" href="a00007.html" title="A special type of calendar bucket, designed to hold a a value." alt="" coords="731,55,995,83"/>
<area shape="rect" id="node2" href="a00120.html" title="Object is the abstract base class for the main entities." alt="" coords="303,5,439,33"/>
<area shape="rect" id="node4" href="a00151.html" title="This is a base class for all Python extension types." alt="" coords="7,5,233,33"/>
<area shape="rect" id="node6" href="a00119.html" title="Class NonCopyable is a base class. Derive your own class from it when you want to..." alt="" coords="283,55,459,83"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a00350.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">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00004.html#add074cec3b31942028928c046155b7d8">checkValid</a> (<a class="el" href="a00049.html">Date</a> d) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00004.html#a986c72ca5eb5ea42663f09fc8b5533f6">endElement</a> (<a class="el" href="a00186.html">XMLInput</a> &, const <a class="el" href="a00002.html">Attribute</a> &, const <a class="el" href="a00047.html">DataElement</a> &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual PyObject * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00004.html#a05cd3bbccc162fb0b2f1f3b8b455fa20">getattro</a> (const <a class="el" href="a00002.html">Attribute</a> &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00004.html#a16d537a0864323adfc71730f11fa3034">getBool</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00013.html">Calendar</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00004.html#a47ca1ccaa3650fc8bbeadf85a05ac6ca">getCalendar</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00049.html">Date</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00004.html#abe0d506c6f5f9784b026fa7058cb582b">getEnd</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00004.html#abb2dfd16fa97bc9a11b3d57a7422c010">getName</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00004.html#a1ee4f2d13a569d57455010bc07e87e8f">getPriority</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="a00004.html#a61f5feb37ae068c55aec5390b9138f87">getSize</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00049.html">Date</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00004.html#a6fee57da0b402d5a8274aa2236ae0fa7">getStart</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="a00004.html#a315e9b2a148922112da74b3f89241a0e">getType</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00004.html#a0c543f19e2f1edd5a87099190e905416">getValue</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00004.html#a970aa8fef3b7045bec049267f319a534">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="a00004.html#a69afab48556134260c898f2a0a9d1cc0">setEnd</a> (const <a class="el" href="a00049.html">Date</a> &d)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00004.html#a3557885f7f93cf0d7c37ed6d07d729f0">setName</a> (const string &s)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00004.html#a3938b2e4e2a5791f8afd2bd8db8a72c6">setPriority</a> (int f)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00004.html#ae3255059e42e08ad87f8ba5680825138">setStart</a> (const <a class="el" href="a00049.html">Date</a> &d)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00004.html#a8e7f830189481b4101c6aa841f4d8a8b">setValue</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00004.html#a71775e9479aa9b80e30915542df8e913">useDefaultName</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00004.html#aa057a70100e1be8898bc616144641b81">writeElement</a> (<a class="el" href="a00189.html">XMLOutput</a> *, const <a class="el" href="a00096.html">Keyword</a> &, <a class="el" href="a00257.html#a20c2c7e4c6b668e71c154ae3eb18f398">mode</a>=DEFAULT) const </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="a00004.html#a6f316ec0ee254598f9579e47da246f54">initialize</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="a00114.html">MetaCategory</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00004.html#ae4b17005ad88cca2acf6cb2b861b8d53">metadata</a></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00004.html#aa4a05dde857b725480fbfd5e5b084b1e">Bucket</a> (<a class="el" href="a00013.html">Calendar</a> *c, <a class="el" href="a00049.html">Date</a> start, <a class="el" href="a00049.html">Date</a> end, string name)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00004.html#a0d175c88908e7789f03a44c694c0e5bd">writeHeader</a> (<a class="el" href="a00189.html">XMLOutput</a> *, const <a class="el" href="a00096.html">Keyword</a> &) const </td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00004.html#adcfeac2ea8fbe60d8ca38bdf9647ce78">BucketIterator</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00004.html#aa12e1a9a4fba3d6b22f6e42faeee5d06">Calendar</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00004.html#ac57a4aa458c0a4baca8e36553e950298">EventIterator</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This class represents a time bucket as a part of a calendar. </p>
<p>Manipulation of instances of this class need to be handled with the methods on the friend class <a class="el" href="a00013.html" title="This is the class used to represent variables that are varying over time.">Calendar</a>. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00013.html" title="This is the class used to represent variables that are varying over time.">Calendar</a> </dd></dl>
<p>Definition at line <a class="el" href="a00218_source.html#l00106">106</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa4a05dde857b725480fbfd5e5b084b1e"></a><!-- doxytag: member="frepple::Calendar::Bucket::Bucket" ref="aa4a05dde857b725480fbfd5e5b084b1e" args="(Calendar *c, Date start, Date end, string name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::Calendar::Bucket::Bucket </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00013.html">Calendar</a> * </td>
<td class="paramname"> <em>c</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>start</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>end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string </td>
<td class="paramname"> <em>name</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l00149">149</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="add074cec3b31942028928c046155b7d8"></a><!-- doxytag: member="frepple::Calendar::Bucket::checkValid" ref="add074cec3b31942028928c046155b7d8" args="(Date d) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool frepple::Calendar::Bucket::checkValid </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00049.html">Date</a> </td>
<td class="paramname"> <em>d</em></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Verifies whether this entry is effective on a given date. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l00215">215</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a986c72ca5eb5ea42663f09fc8b5533f6"></a><!-- doxytag: member="frepple::Calendar::Bucket::endElement" ref="a986c72ca5eb5ea42663f09fc8b5533f6" args="(XMLInput &, const Attribute &, const DataElement &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Calendar::Bucket::endElement </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00186.html">XMLInput</a> & </td>
<td class="paramname"> <em>pIn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00002.html">Attribute</a> & </td>
<td class="paramname"> <em>pAttr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00047.html">DataElement</a> & </td>
<td class="paramname"> <em>pElement</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>Reads the bucket information from the input. Only the fields "name" and "start" are read in. Other fields as also written out but these are information-only fields. </p>
<p>Implements <a class="el" href="a00120.html#a88eab6db69f9b38c6b3f5ea37da630fd">frepple::utils::Object</a>.</p>
<p>Reimplemented in <a class="el" href="a00007.html#a4c5ab899d78a3ec8f59bef821254bef6">frepple::CalendarValue< T >::BucketValue</a>, and <a class="el" href="a00006.html#a7ecbafecc4d244b5334c7eeb2812a375">frepple::CalendarPointer< T >::BucketPointer</a>.</p>
<p>Definition at line <a class="el" href="a00195_source.html#l00437">437</a> of file <a class="el" href="a00195_source.html">calendar.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a05cd3bbccc162fb0b2f1f3b8b455fa20"></a><!-- doxytag: member="frepple::Calendar::Bucket::getattro" ref="a05cd3bbccc162fb0b2f1f3b8b455fa20" args="(const Attribute &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PyObject * frepple::Calendar::Bucket::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="a00151.html#af3cfc29003472070ba9e133bcf5eb335">frepple::utils::PythonExtensionBase</a>.</p>
<p>Definition at line <a class="el" href="a00195_source.html#l00823">823</a> of file <a class="el" href="a00195_source.html">calendar.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a16d537a0864323adfc71730f11fa3034"></a><!-- doxytag: member="frepple::Calendar::Bucket::getBool" ref="a16d537a0864323adfc71730f11fa3034" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool frepple::Calendar::Bucket::getBool </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert the value of the bucket to a boolean value. </p>
<p>Reimplemented in <a class="el" href="a00007.html#aabea463d765b6e617e3137b5fcf40924">frepple::CalendarValue< T >::BucketValue</a>, <a class="el" href="a00006.html#a8dedbd25a9b3b9ed34bc60b9d9da2554">frepple::CalendarPointer< T >::BucketPointer</a>, <a class="el" href="a00007.html#a4ad5dabd9aaaba93f17e5ed9269a7f0a">frepple::CalendarValue< T >::BucketValue</a>, and <a class="el" href="a00007.html#a4ad5dabd9aaaba93f17e5ed9269a7f0a">frepple::CalendarValue< T >::BucketValue</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l00221">221</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a47ca1ccaa3650fc8bbeadf85a05ac6ca"></a><!-- doxytag: member="frepple::Calendar::Bucket::getCalendar" ref="a47ca1ccaa3650fc8bbeadf85a05ac6ca" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00013.html">Calendar</a>* frepple::Calendar::Bucket::getCalendar </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the calendar to whom the bucket belongs. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l00158">158</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="abe0d506c6f5f9784b026fa7058cb582b"></a><!-- doxytag: member="frepple::Calendar::Bucket::getEnd" ref="abe0d506c6f5f9784b026fa7058cb582b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00049.html">Date</a> frepple::Calendar::Bucket::getEnd </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the end date of the bucket. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l00189">189</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="abb2dfd16fa97bc9a11b3d57a7422c010"></a><!-- doxytag: member="frepple::Calendar::Bucket::getName" ref="abb2dfd16fa97bc9a11b3d57a7422c010" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string frepple::Calendar::Bucket::getName </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the name of the bucket. If no name was ever explicitly specified with the <a class="el" href="a00004.html#a3557885f7f93cf0d7c37ed6d07d729f0">setName()</a> method, a default name is generated by converting the start date into a string.<br/>
To reduce the memory needs, this default string is computed with every call to the <a class="el" href="a00004.html#abb2dfd16fa97bc9a11b3d57a7422c010">getName()</a> method and never stored internally. Only explicitly specified names are kept in memory. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l00179">179</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a1ee4f2d13a569d57455010bc07e87e8f"></a><!-- doxytag: member="frepple::Calendar::Bucket::getPriority" ref="a1ee4f2d13a569d57455010bc07e87e8f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int frepple::Calendar::Bucket::getPriority </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the priority of this bucket, compared to other buckets effective at a certain time.<br/>
Lower numbers indicate a higher priority level.<br/>
The default value is 0. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l00205">205</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a61f5feb37ae068c55aec5390b9138f87"></a><!-- doxytag: member="frepple::Calendar::Bucket::getSize" ref="a61f5feb37ae068c55aec5390b9138f87" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t frepple::Calendar::Bucket::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>Reimplemented in <a class="el" href="a00007.html#abd26681eab3d0542ea5970ec0a3fc07d">frepple::CalendarValue< T >::BucketValue</a>, and <a class="el" href="a00006.html#a50a15da8c9ae4cc41cd8f895fdccdaf2">frepple::CalendarPointer< T >::BucketPointer</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l00234">234</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6fee57da0b402d5a8274aa2236ae0fa7"></a><!-- doxytag: member="frepple::Calendar::Bucket::getStart" ref="a6fee57da0b402d5a8274aa2236ae0fa7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00049.html">Date</a> frepple::Calendar::Bucket::getStart </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the start date of the bucket. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l00195">195</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a315e9b2a148922112da74b3f89241a0e"></a><!-- doxytag: member="frepple::Calendar::Bucket::getType" ref="a315e9b2a148922112da74b3f89241a0e" 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>& frepple::Calendar::Bucket::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>Implements <a class="el" href="a00120.html#a2e5ff5e5d9c32647f692abd04a0d72d2">frepple::utils::Object</a>.</p>
<p>Reimplemented in <a class="el" href="a00007.html#a8ac1d7e67ac34ef400dc813fee35888d">frepple::CalendarValue< T >::BucketValue</a>, and <a class="el" href="a00006.html#ae2c62769298877e9e553c59b2b309161">frepple::CalendarPointer< T >::BucketPointer</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l00232">232</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0c543f19e2f1edd5a87099190e905416"></a><!-- doxytag: member="frepple::Calendar::Bucket::getValue" ref="a0c543f19e2f1edd5a87099190e905416" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Calendar::Bucket::getValue </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method is here only to keep the API of all calendar classes consistent.<br/>
Note that this isn't exactly a virtual method, since the return value is different for different calendar types. </p>
<p>Reimplemented in <a class="el" href="a00007.html#a272fe75e4a6d35f489c4033078d072db">frepple::CalendarValue< T >::BucketValue</a>, and <a class="el" href="a00006.html#aaea32ad98e4341a5054b776db0cd2d0e">frepple::CalendarPointer< T >::BucketPointer</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l00165">165</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6f316ec0ee254598f9579e47da246f54"></a><!-- doxytag: member="frepple::Calendar::Bucket::initialize" ref="a6f316ec0ee254598f9579e47da246f54" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int frepple::Calendar::Bucket::initialize </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00195_source.html#l00058">58</a> of file <a class="el" href="a00195_source.html">calendar.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a970aa8fef3b7045bec049267f319a534"></a><!-- doxytag: member="frepple::Calendar::Bucket::setattro" ref="a970aa8fef3b7045bec049267f319a534" args="(const Attribute &, const PythonObject &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int frepple::Calendar::Bucket::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="a00151.html#a0a1bd051198a1b82fd23d3ca04c3ee8d">frepple::utils::PythonExtensionBase</a>.</p>
<p>Definition at line <a class="el" href="a00195_source.html#l00854">854</a> of file <a class="el" href="a00195_source.html">calendar.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a69afab48556134260c898f2a0a9d1cc0"></a><!-- doxytag: member="frepple::Calendar::Bucket::setEnd" ref="a69afab48556134260c898f2a0a9d1cc0" args="(const Date &d)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Calendar::Bucket::setEnd </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00049.html">Date</a> & </td>
<td class="paramname"> <em>d</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Updates the end date of the bucket. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l00192">192</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3557885f7f93cf0d7c37ed6d07d729f0"></a><!-- doxytag: member="frepple::Calendar::Bucket::setName" ref="a3557885f7f93cf0d7c37ed6d07d729f0" args="(const string &s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Calendar::Bucket::setName </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>s</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Updates the name of a bucket. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l00186">186</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3938b2e4e2a5791f8afd2bd8db8a72c6"></a><!-- doxytag: member="frepple::Calendar::Bucket::setPriority" ref="a3938b2e4e2a5791f8afd2bd8db8a72c6" args="(int f)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Calendar::Bucket::setPriority </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>f</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Updates the priority of this bucket, compared to other buckets effective at a certain time.<br/>
Lower numbers indicate a higher priority level.<br/>
The default value is 0. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l00212">212</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae3255059e42e08ad87f8ba5680825138"></a><!-- doxytag: member="frepple::Calendar::Bucket::setStart" ref="ae3255059e42e08ad87f8ba5680825138" args="(const Date &d)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Calendar::Bucket::setStart </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00049.html">Date</a> & </td>
<td class="paramname"> <em>d</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Updates the end date of the bucket. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l00198">198</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8e7f830189481b4101c6aa841f4d8a8b"></a><!-- doxytag: member="frepple::Calendar::Bucket::setValue" ref="a8e7f830189481b4101c6aa841f4d8a8b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Calendar::Bucket::setValue </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method is here only to keep the API of all calendar classes consistent. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l00170">170</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a71775e9479aa9b80e30915542df8e913"></a><!-- doxytag: member="frepple::Calendar::Bucket::useDefaultName" ref="a71775e9479aa9b80e30915542df8e913" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool frepple::Calendar::Bucket::useDefaultName </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if the name of the bucket has not been explicitly specified. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l00183">183</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa057a70100e1be8898bc616144641b81"></a><!-- doxytag: member="frepple::Calendar::Bucket::writeElement" ref="aa057a70100e1be8898bc616144641b81" args="(XMLOutput *, const Keyword &, mode=DEFAULT) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Calendar::Bucket::writeElement </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00189.html">XMLOutput</a> * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00096.html">Keyword</a> & </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00257.html#a20c2c7e4c6b668e71c154ae3eb18f398">mode</a> </td>
<td class="paramname"> = <code>DEFAULT</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called while writing the model into an XML-file. The user class should write itself out, using the IOutStream members for its "simple" members and calling writeElement recursively for any contained objects. Not all classes are expected to implement this method. In instances of such a class can be created but can't be persisted. E.g. Command </p>
<p>Reimplemented from <a class="el" href="a00120.html#a324e43c334cb519909fcbdad0f8cbd82">frepple::utils::Object</a>.</p>
<p>Reimplemented in <a class="el" href="a00007.html#a9a1fa1b53177a30505fc24bc28c5208e">frepple::CalendarValue< T >::BucketValue</a>, and <a class="el" href="a00006.html#a892ceaccb79b9fa01ff4963593d52aaa">frepple::CalendarPointer< T >::BucketPointer</a>.</p>
<p>Definition at line <a class="el" href="a00195_source.html#l00428">428</a> of file <a class="el" href="a00195_source.html">calendar.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0d175c88908e7789f03a44c694c0e5bd"></a><!-- doxytag: member="frepple::Calendar::Bucket::writeHeader" ref="a0d175c88908e7789f03a44c694c0e5bd" args="(XMLOutput *, const Keyword &) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::Calendar::Bucket::writeHeader </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00189.html">XMLOutput</a> * </td>
<td class="paramname"> <em>o</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00096.html">Keyword</a> & </td>
<td class="paramname"> <em>tag</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Auxilary function to write out the start of the XML. </p>
<p>Definition at line <a class="el" href="a00195_source.html#l00387">387</a> of file <a class="el" href="a00195_source.html">calendar.cpp</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="adcfeac2ea8fbe60d8ca38bdf9647ce78"></a><!-- doxytag: member="frepple::Calendar::Bucket::BucketIterator" ref="adcfeac2ea8fbe60d8ca38bdf9647ce78" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="a00005.html">BucketIterator</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00218_source.html#l00109">109</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa12e1a9a4fba3d6b22f6e42faeee5d06"></a><!-- doxytag: member="frepple::Calendar::Bucket::Calendar" ref="aa12e1a9a4fba3d6b22f6e42faeee5d06" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="a00013.html">Calendar</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00218_source.html#l00108">108</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac57a4aa458c0a4baca8e36553e950298"></a><!-- doxytag: member="frepple::Calendar::Bucket::EventIterator" ref="ac57a4aa458c0a4baca8e36553e950298" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="a00061.html">EventIterator</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00218_source.html#l00110">110</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="ae4b17005ad88cca2acf6cb2b861b8d53"></a><!-- doxytag: member="frepple::Calendar::Bucket::metadata" ref="ae4b17005ad88cca2acf6cb2b861b8d53" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="a00114.html">MetaCategory</a> * <a class="el" href="a00004.html#ae4b17005ad88cca2acf6cb2b861b8d53">frepple::Calendar::Bucket::metadata</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00218_source.html#l00236">236</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="a00195_source.html">calendar.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>
