Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > 54cac1c2268db633d66eeff1b4faa585 > files > 337

frepple-doc-0.8.1-3.fc15.noarch.rpm

<!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::EventIterator 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&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;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&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;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="a00061.html">EventIterator</a>
  </div>
</div>
<div class="contents">
<h1>frepple::Calendar::EventIterator Class Reference</h1><!-- doxytag: class="frepple::Calendar::EventIterator" -->
<p>An iterator class to go through all dates where the calendar value changes.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00218_source.html">model.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for frepple::Calendar::EventIterator:</div>
<div class="dynsection">
<div class="center"><img src="a00352.png" border="0" usemap="#frepple_1_1_calendar_1_1_event_iterator_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1_calendar_1_1_event_iterator_inherit__map" id="frepple_1_1_calendar_1_1_event_iterator_inherit__map">
<area shape="rect" id="node3" href="a00062.html" title="A special event iterator, providing also access to the current value." alt="" coords="255,5,524,33"/>
<area shape="rect" id="node5" href="a00060.html" title="A special event iterator, providing also access to the current value." alt="" coords="259,55,520,83"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="a00353.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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00061.html#add36e83f21041db44b1004cbb9fa8aff">EventIterator</a> (const <a class="el" href="a00013.html">Calendar</a> *c, <a class="el" href="a00049.html">Date</a> d=Date::infinitePast, bool forward=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="a00004.html">Bucket</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00061.html#a32d10061d1e0447d6850cf073d6dccce">getBucket</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="a00013.html">Calendar</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00061.html#a9dbe8c28169053ef2e304576612cd8ec">getCalendar</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="a00049.html">Date</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00061.html#af62bd8787c04691a811c18d9958161f8">getDate</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00061.html">EventIterator</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00061.html#a9d4215411a72e4a9b1e1b703783250e9">operator++</a> (int)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00061.html">EventIterator</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00061.html#a3ad86d4277f7e365b45b84749a0b3f3a">operator++</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00061.html">EventIterator</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00061.html#a994ec70dd0eec7b0bc7f7014613d8fd4">operator--</a> (int)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00061.html">EventIterator</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00061.html#af77357c87e0a8ccb42e45b1d523a0a56">operator--</a> ()</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="a00004.html">Bucket</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00061.html#a23d29c08ee8a28039740fd93f41f5b8b">curBucket</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00049.html">Date</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00061.html#acab8e8a2aa626126d7cc1c28adc38c14">curDate</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00061.html#a297a21ab7b7d3b67c9de70b2a90e7d80">curPriority</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="a00013.html">Calendar</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00061.html#a62df3a271883d04f42d10afe3ce4c406">theCalendar</a></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00061.html#abebc766e2c27a55068ce32893d078d8a">Calendar::Bucket</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>An iterator class to go through all dates where the calendar value changes. </p>

<p>Definition at line <a class="el" href="a00218_source.html#l00282">282</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="add36e83f21041db44b1004cbb9fa8aff"></a><!-- doxytag: member="frepple::Calendar::EventIterator::EventIterator" ref="add36e83f21041db44b1004cbb9fa8aff" args="(const Calendar *c, Date d=Date::infinitePast, bool forward=true)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">frepple::Calendar::EventIterator::EventIterator </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00013.html">Calendar</a> *&nbsp;</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>&nbsp;</td>
          <td class="paramname"> <em>d</em> = <code>Date::infinitePast</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>forward</em> = <code>true</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Reimplemented in <a class="el" href="a00060.html#a7b7aa9b5cf0485fea1f354102aa98ec7">frepple::CalendarValue&lt; T &gt;::EventIterator</a>, and <a class="el" href="a00062.html#a21e4e4b6394cbdafc03112a737f9f47e">frepple::CalendarPointer&lt; T &gt;::EventIterator</a>.</p>

<p>Definition at line <a class="el" href="a00218_source.html#l00294">294</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="a32d10061d1e0447d6850cf073d6dccce"></a><!-- doxytag: member="frepple::Calendar::EventIterator::getBucket" ref="a32d10061d1e0447d6850cf073d6dccce" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="a00004.html">Bucket</a>* frepple::Calendar::EventIterator::getBucket </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="a00218_source.html#l00292">292</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="a9dbe8c28169053ef2e304576612cd8ec"></a><!-- doxytag: member="frepple::Calendar::EventIterator::getCalendar" ref="a9dbe8c28169053ef2e304576612cd8ec" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="a00013.html">Calendar</a>* frepple::Calendar::EventIterator::getCalendar </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="a00218_source.html#l00293">293</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="af62bd8787c04691a811c18d9958161f8"></a><!-- doxytag: member="frepple::Calendar::EventIterator::getDate" ref="af62bd8787c04691a811c18d9958161f8" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="a00049.html">Date</a>&amp; frepple::Calendar::EventIterator::getDate </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="a00218_source.html#l00291">291</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="a9d4215411a72e4a9b1e1b703783250e9"></a><!-- doxytag: member="frepple::Calendar::EventIterator::operator++" ref="a9d4215411a72e4a9b1e1b703783250e9" args="(int)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00061.html">EventIterator</a> frepple::Calendar::EventIterator::operator++ </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="a00218_source.html#l00303">303</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="a3ad86d4277f7e365b45b84749a0b3f3a"></a><!-- doxytag: member="frepple::Calendar::EventIterator::operator++" ref="a3ad86d4277f7e365b45b84749a0b3f3a" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00061.html">Calendar::EventIterator</a> &amp; frepple::Calendar::EventIterator::operator++ </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="a00195_source.html#l00444">444</a> of file <a class="el" href="a00195_source.html">calendar.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a994ec70dd0eec7b0bc7f7014613d8fd4"></a><!-- doxytag: member="frepple::Calendar::EventIterator::operator&#45;&#45;" ref="a994ec70dd0eec7b0bc7f7014613d8fd4" args="(int)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00061.html">EventIterator</a> frepple::Calendar::EventIterator::operator-- </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="a00218_source.html#l00305">305</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="af77357c87e0a8ccb42e45b1d523a0a56"></a><!-- doxytag: member="frepple::Calendar::EventIterator::operator&#45;&#45;" ref="af77357c87e0a8ccb42e45b1d523a0a56" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00061.html">Calendar::EventIterator</a> &amp; frepple::Calendar::EventIterator::operator-- </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="a00195_source.html#l00457">457</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="abebc766e2c27a55068ce32893d078d8a"></a><!-- doxytag: member="frepple::Calendar::EventIterator::Calendar::Bucket" ref="abebc766e2c27a55068ce32893d078d8a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">friend class <a class="el" href="a00004.html">Calendar::Bucket</a><code> [friend]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="a00218_source.html#l00284">284</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="a23d29c08ee8a28039740fd93f41f5b8b"></a><!-- doxytag: member="frepple::Calendar::EventIterator::curBucket" ref="a23d29c08ee8a28039740fd93f41f5b8b" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="a00004.html">Bucket</a>* <a class="el" href="a00061.html#a23d29c08ee8a28039740fd93f41f5b8b">frepple::Calendar::EventIterator::curBucket</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="a00218_source.html#l00287">287</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="acab8e8a2aa626126d7cc1c28adc38c14"></a><!-- doxytag: member="frepple::Calendar::EventIterator::curDate" ref="acab8e8a2aa626126d7cc1c28adc38c14" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00049.html">Date</a> <a class="el" href="a00061.html#acab8e8a2aa626126d7cc1c28adc38c14">frepple::Calendar::EventIterator::curDate</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="a00218_source.html#l00288">288</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="a297a21ab7b7d3b67c9de70b2a90e7d80"></a><!-- doxytag: member="frepple::Calendar::EventIterator::curPriority" ref="a297a21ab7b7d3b67c9de70b2a90e7d80" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="a00061.html#a297a21ab7b7d3b67c9de70b2a90e7d80">frepple::Calendar::EventIterator::curPriority</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="a00218_source.html#l00289">289</a> of file <a class="el" href="a00218_source.html">model.h</a>.</p>

</div>
</div>
<a class="anchor" id="a62df3a271883d04f42d10afe3ce4c406"></a><!-- doxytag: member="frepple::Calendar::EventIterator::theCalendar" ref="a62df3a271883d04f42d10afe3ce4c406" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="a00013.html">Calendar</a>* <a class="el" href="a00061.html#a62df3a271883d04f42d10afe3ce4c406">frepple::Calendar::EventIterator::theCalendar</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="a00218_source.html#l00286">286</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&nbsp;
<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>