<!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::CalendarValue< T > Class Template 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="a00023.html">CalendarValue</a>
</div>
</div>
<div class="contents">
<h1>frepple::CalendarValue< T > Class Template Reference</h1><!-- doxytag: class="frepple::CalendarValue" --><!-- doxytag: inherits="frepple::Calendar" -->
<p>This calendar type is used to store values in its buckets.
<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::CalendarValue< T >:</div>
<div class="dynsection">
<div class="center"><img src="a00376.png" border="0" usemap="#frepple_1_1_calendar_value_3_01_t_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1_calendar_value_3_01_t_01_4_inherit__map" id="frepple_1_1_calendar_value_3_01_t_01_4_inherit__map">
<area shape="rect" id="node2" href="a00013.html" title="This is the class used to represent variables that are varying over time." alt="" coords="240,238,357,266"/>
<area shape="rect" id="node4" href="a00085.html" title="frepple::utils::HasName\< Calendar \>" alt="" coords="183,161,415,189"/>
<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="5,83,181,111"/>
<area shape="rect" id="node8" href="a00182.html" title="This class represents a node in the tree." alt="" coords="205,83,392,111"/>
<area shape="rect" id="node10" href="a00120.html" title="Object is the abstract base class for the main entities." alt="" coords="416,83,552,111"/>
<area shape="rect" id="node12" href="a00151.html" title="This is a base class for all Python extension types." alt="" coords="371,6,597,34"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a00377.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00007.html">BucketValue</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A special type of calendar bucket, designed to hold a a value. <a href="a00007.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html">EventIterator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A special event iterator, providing also access to the current value. <a href="a00060.html#_details">More...</a><br/></td></tr>
<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="a00023.html#a53a1997a04270f13c0bff6988ad84944">CalendarValue</a> (const string &n)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#aa6b62fc5a84316ae8e83b925d843873f">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="memTemplParams" colspan="2">template<> </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00023.html#a9be7284aa0fab42d4a384fc2e9fef6d8">getBool</a> () const</td></tr>
<tr><td class="memTemplParams" colspan="2">template<> </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00023.html#a9be7284aa0fab42d4a384fc2e9fef6d8">getBool</a> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#a82e1b9aa3591374f0e66e583477fc579">getBool</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual T </td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#a156309370ee8f10385d95e586670152a">getDefault</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="a00023.html#aeb587e5b6263f9c39780db24d7684330">getType</a> () const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const T & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#af98e95203e453f8a206b4055f5290b4b">getValue</a> (<a class="el" href="a00005.html">Calendar::BucketIterator</a> &i) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const T & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#a269067e065a9ca2a62be6cbfcf489fa1">getValue</a> (const <a class="el" href="a00049.html">Date</a> d) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#abbe5b906c2087c141d60400801bb0b1d">setDefault</a> (const T v)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#a5888afe15ac98205aff226fa224b2962">setValue</a> (<a class="el" href="a00049.html">Date</a> start, <a class="el" href="a00049.html">Date</a> end, const T &v)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#aadad1a9e6bde310767e671c148e0553c">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>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<typename T><br/>
class frepple::CalendarValue< T ></h3>
<p>This calendar type is used to store values in its buckets. </p>
<p>The template type must statisfy the following requirements:</p>
<ul>
<li>XML import supported by the operator >> of the class DataElement.</li>
<li>XML export supported by the method writeElement of the class XMLOutput. Subclasses will need to implement the <a class="el" href="a00023.html#aeb587e5b6263f9c39780db24d7684330">getType()</a> method. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00021.html" title="This calendar type is used to store object pointers in its buckets.">CalendarPointer</a> </dd></dl>
</li>
</ul>
<p>Definition at line <a class="el" href="a00218_source.html#l00388">388</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a53a1997a04270f13c0bff6988ad84944"></a><!-- doxytag: member="frepple::CalendarValue::CalendarValue" ref="a53a1997a04270f13c0bff6988ad84944" args="(const string &n)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00023.html">frepple::CalendarValue</a>< T >::<a class="el" href="a00023.html">CalendarValue</a> </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>n</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l00462">462</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="aa6b62fc5a84316ae8e83b925d843873f"></a><!-- doxytag: member="frepple::CalendarValue::endElement" ref="aa6b62fc5a84316ae8e83b925d843873f" 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="a00023.html">frepple::CalendarValue</a>< T >::endElement </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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00047.html">DataElement</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 when the corresponding close element tag is encountered, and the Data() member of pElement is valid. </p>
<p>Reimplemented from <a class="el" href="a00013.html#af329023a8f1fc62b562fd360c3a95140">frepple::Calendar</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l00529">529</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9be7284aa0fab42d4a384fc2e9fef6d8"></a><!-- doxytag: member="frepple::CalendarValue::getBool" ref="a9be7284aa0fab42d4a384fc2e9fef6d8" args="() const" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="a00023.html">frepple::CalendarValue</a>< string >::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 calendar to a boolean value. </p>
<p>Reimplemented from <a class="el" href="a00013.html#aebd67249291e4a2bfaabea4db5de4ff0">frepple::Calendar</a>.</p>
</div>
</div>
<a class="anchor" id="a9be7284aa0fab42d4a384fc2e9fef6d8"></a><!-- doxytag: member="frepple::CalendarValue::getBool" ref="a9be7284aa0fab42d4a384fc2e9fef6d8" args="() const" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="a00023.html">frepple::CalendarValue</a>< string >::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 calendar to a boolean value. </p>
<p>Reimplemented from <a class="el" href="a00013.html#aebd67249291e4a2bfaabea4db5de4ff0">frepple::Calendar</a>.</p>
<p>Definition at line <a class="el" href="a00195_source.html#l00153">153</a> of file <a class="el" href="a00195_source.html">calendar.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a82e1b9aa3591374f0e66e583477fc579"></a><!-- doxytag: member="frepple::CalendarValue::getBool" ref="a82e1b9aa3591374f0e66e583477fc579" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname">virtual bool <a class="el" href="a00023.html">frepple::CalendarValue</a>< T >::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 calendar to a boolean value. </p>
<p>Reimplemented from <a class="el" href="a00013.html#aebd67249291e4a2bfaabea4db5de4ff0">frepple::Calendar</a>.</p>
<p>Reimplemented in <a class="el" href="a00022.html#a6e0ad8b3c764ba547919d89022f4e6d5">frepple::CalendarString</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l00496">496</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a156309370ee8f10385d95e586670152a"></a><!-- doxytag: member="frepple::CalendarValue::getDefault" ref="a156309370ee8f10385d95e586670152a" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname">virtual T <a class="el" href="a00023.html">frepple::CalendarValue</a>< T >::getDefault </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the default calendar value when no entry is matching. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l00493">493</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="aeb587e5b6263f9c39780db24d7684330"></a><!-- doxytag: member="frepple::CalendarValue::getType" ref="aeb587e5b6263f9c39780db24d7684330" args="() const =0" -->
<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="a00023.html">frepple::CalendarValue</a>< T >::getType </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure 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="a00013.html#a4ee612ef7997c99d1c1539cfd1137a19">frepple::Calendar</a>.</p>
<p>Implemented in <a class="el" href="a00016.html#acec9529c83ad07d47d62391b1102f39b">frepple::CalendarDouble</a>, <a class="el" href="a00018.html#adf37d97b30a70c6fb63d2b1d13492f9f">frepple::CalendarInt</a>, <a class="el" href="a00014.html#a6a2231a9fceb06aa01dad35b7f335c36">frepple::CalendarBool</a>, and <a class="el" href="a00022.html#ad0ec94a79fc61d85ac9fa065f7a0980c">frepple::CalendarString</a>.</p>
</div>
</div>
<a class="anchor" id="af98e95203e453f8a206b4055f5290b4b"></a><!-- doxytag: member="frepple::CalendarValue::getValue" ref="af98e95203e453f8a206b4055f5290b4b" args="(Calendar::BucketIterator &i) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname">const T& <a class="el" href="a00023.html">frepple::CalendarValue</a>< T >::getValue </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00005.html">Calendar::BucketIterator</a> & </td>
<td class="paramname"> <em>i</em></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00218_source.html#l00489">489</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a269067e065a9ca2a62be6cbfcf489fa1"></a><!-- doxytag: member="frepple::CalendarValue::getValue" ref="a269067e065a9ca2a62be6cbfcf489fa1" args="(const Date d) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname">const T& <a class="el" href="a00023.html">frepple::CalendarValue</a>< T >::getValue </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> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the value on the specified date. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l00465">465</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="abbe5b906c2087c141d60400801bb0b1d"></a><!-- doxytag: member="frepple::CalendarValue::setDefault" ref="abbe5b906c2087c141d60400801bb0b1d" args="(const T v)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="a00023.html">frepple::CalendarValue</a>< T >::setDefault </td>
<td>(</td>
<td class="paramtype">const T </td>
<td class="paramname"> <em>v</em></td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Update the default calendar value when no entry is matching. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l00499">499</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5888afe15ac98205aff226fa224b2962"></a><!-- doxytag: member="frepple::CalendarValue::setValue" ref="a5888afe15ac98205aff226fa224b2962" args="(Date start, Date end, const 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="a00023.html">frepple::CalendarValue</a>< T >::setValue </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">const T & </td>
<td class="paramname"> <em>v</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>Updates the value in a certain date range.<br/>
This will create a new bucket if required. </p>
<p>Definition at line <a class="el" href="a00218_source.html#l00473">473</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
</div>
</div>
<a class="anchor" id="aadad1a9e6bde310767e671c148e0553c"></a><!-- doxytag: member="frepple::CalendarValue::writeElement" ref="aadad1a9e6bde310767e671c148e0553c" 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="a00023.html">frepple::CalendarValue</a>< T >::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="a00013.html#aada6ba5b57ed15d5b9f639d3fb54955c">frepple::Calendar</a>.</p>
<p>Definition at line <a class="el" href="a00218_source.html#l00501">501</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>
