<!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::CalendarPointer< T >::BucketPointer 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="a00021.html">CalendarPointer</a>::<a class="el" href="a00006.html">BucketPointer</a>
</div>
</div>
<div class="contents">
<h1>frepple::CalendarPointer< T >::BucketPointer Class Reference</h1><!-- doxytag: class="frepple::CalendarPointer::BucketPointer" --><!-- doxytag: inherits="frepple::Calendar::Bucket" -->
<p>A special type of calendar bucket, designed to hold a pointer to an object.
<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::CalendarPointer< T >::BucketPointer:</div>
<div class="dynsection">
<div class="center"><img src="a00370.png" border="0" usemap="#frepple_1_1_calendar_pointer_3_01_t_01_4_1_1_bucket_pointer_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1_calendar_pointer_3_01_t_01_4_1_1_bucket_pointer_inherit__map" id="frepple_1_1_calendar_pointer_3_01_t_01_4_1_1_bucket_pointer_inherit__map">
<area shape="rect" id="node2" href="a00004.html" title="This class represents a time bucket as a part of a calendar." alt="" coords="124,161,292,189"/>
<area shape="rect" id="node4" href="a00120.html" title="Object is the abstract base class for the main entities." alt="" coords="51,83,187,111"/>
<area shape="rect" id="node6" href="a00151.html" title="This is a base class for all Python extension types." alt="" coords="5,6,232,34"/>
<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="211,83,387,111"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a00371.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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00006.html#a92cb7f0ad18736ba1413a1fc6d5f3d69">beginElement</a> (<a class="el" href="a00186.html">XMLInput</a> &pIn, const <a class="el" href="a00002.html">Attribute</a> &pAttr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00006.html#a7ecbafecc4d244b5334c7eeb2812a375">endElement</a> (<a class="el" href="a00186.html">XMLInput</a> &pIn, const <a class="el" href="a00002.html">Attribute</a> &pAttr, const <a class="el" href="a00047.html">DataElement</a> &pElement)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00006.html#a8dedbd25a9b3b9ed34bc60b9d9da2554">getBool</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="a00006.html#a50a15da8c9ae4cc41cd8f895fdccdaf2">getSize</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="a00006.html#ae2c62769298877e9e553c59b2b309161">getType</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00006.html#aaea32ad98e4341a5054b776db0cd2d0e">getValue</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00006.html#a38cab5f6542867612e273e64857ef712">setValue</a> (T *v)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00006.html#a892ceaccb79b9fa01ff4963593d52aaa">writeElement</a> (<a class="el" href="a00189.html">XMLOutput</a> *o, const <a class="el" href="a00096.html">Keyword</a> &tag, <a class="el" href="a00257.html#a20c2c7e4c6b668e71c154ae3eb18f398">mode</a> m=DEFAULT) 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="a00006.html#afc2ad00806728e6087ed293f7e526439">CalendarPointer< T ></a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<typename T><br/>
class frepple::CalendarPointer< T >::BucketPointer</h3>
<p>A special type of calendar bucket, designed to hold a pointer to an object. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00004.html" title="This class represents a time bucket as a part of a calendar.">Calendar::Bucket</a> </dd></dl>
<p>Definition at line <a class="el" href="a00218_source.html#l00570">570</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a92cb7f0ad18736ba1413a1fc6d5f3d69"></a><!-- doxytag: member="frepple::CalendarPointer::BucketPointer::beginElement" ref="a92cb7f0ad18736ba1413a1fc6d5f3d69" args="(XMLInput &pIn, const Attribute &pAttr)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00021.html">frepple::CalendarPointer</a>< T >::BucketPointer::beginElement </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00186.html">XMLInput</a> & </td>
<td class="paramname">, </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"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called while restoring the model from an XML-file.<br/>
This is called for each element within the "this" element, for which the "this" element is immediate parent.<br/>
It is called when the open element tag is encountered. </p>
<p>Reimplemented from <a class="el" href="a00120.html#ac17c9f7df359ee20839f5e09723d38f1">frepple::utils::Object</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l00601">601</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7ecbafecc4d244b5334c7eeb2812a375"></a><!-- doxytag: member="frepple::CalendarPointer::BucketPointer::endElement" ref="a7ecbafecc4d244b5334c7eeb2812a375" args="(XMLInput &pIn, const Attribute &pAttr, const DataElement &pElement)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00021.html">frepple::CalendarPointer</a>< T >::BucketPointer::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> [inline, 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>Reimplemented from <a class="el" href="a00004.html#a986c72ca5eb5ea42663f09fc8b5533f6">frepple::Calendar::Bucket</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l00611">611</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8dedbd25a9b3b9ed34bc60b9d9da2554"></a><!-- doxytag: member="frepple::CalendarPointer::BucketPointer::getBool" ref="a8dedbd25a9b3b9ed34bc60b9d9da2554" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="a00021.html">frepple::CalendarPointer</a>< T >::BucketPointer::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 from <a class="el" href="a00004.html#a16d537a0864323adfc71730f11fa3034">frepple::Calendar::Bucket</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l00586">586</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a50a15da8c9ae4cc41cd8f895fdccdaf2"></a><!-- doxytag: member="frepple::CalendarPointer::BucketPointer::getSize" ref="a50a15da8c9ae4cc41cd8f895fdccdaf2" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname">virtual size_t <a class="el" href="a00021.html">frepple::CalendarPointer</a>< T >::BucketPointer::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>Reimplemented from <a class="el" href="a00004.html#a61f5feb37ae068c55aec5390b9138f87">frepple::Calendar::Bucket</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l00628">628</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae2c62769298877e9e553c59b2b309161"></a><!-- doxytag: member="frepple::CalendarPointer::BucketPointer::getType" ref="ae2c62769298877e9e553c59b2b309161" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="a00115.html">MetaClass</a>& <a class="el" href="a00021.html">frepple::CalendarPointer</a>< T >::BucketPointer::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="a00004.html#a315e9b2a148922112da74b3f89241a0e">frepple::Calendar::Bucket</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l00625">625</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="aaea32ad98e4341a5054b776db0cd2d0e"></a><!-- doxytag: member="frepple::CalendarPointer::BucketPointer::getValue" ref="aaea32ad98e4341a5054b776db0cd2d0e" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="a00021.html">frepple::CalendarPointer</a>< T >::BucketPointer::getValue </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the value stored in this bucket. </p>
<p>Reimplemented from <a class="el" href="a00004.html#a0c543f19e2f1edd5a87099190e905416">frepple::Calendar::Bucket</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l00583">583</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a38cab5f6542867612e273e64857ef712"></a><!-- doxytag: member="frepple::CalendarPointer::BucketPointer::setValue" ref="a38cab5f6542867612e273e64857ef712" args="(T *v)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00021.html">frepple::CalendarPointer</a>< T >::BucketPointer::setValue </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"> <em>v</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Updates the value of this bucket. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l00589">589</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a892ceaccb79b9fa01ff4963593d52aaa"></a><!-- doxytag: member="frepple::CalendarPointer::BucketPointer::writeElement" ref="a892ceaccb79b9fa01ff4963593d52aaa" args="(XMLOutput *o, const Keyword &tag, mode m=DEFAULT) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00021.html">frepple::CalendarPointer</a>< T >::BucketPointer::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> [inline, 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="a00004.html#aa057a70100e1be8898bc616144641b81">frepple::Calendar::Bucket</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l00592">592</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="afc2ad00806728e6087ed293f7e526439"></a><!-- doxytag: member="frepple::CalendarPointer::BucketPointer::CalendarPointer< T >" ref="afc2ad00806728e6087ed293f7e526439" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="a00021.html">CalendarPointer</a>< T ><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00218_source.html#l00572">572</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 file:<ul>
<li><a class="el" href="a00218_source.html">model.h</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>
