doc/html/boost/date_time/date_itr_base.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template date_itr_base</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="../../date_time/doxy.html#header.boost.date_time.date_iterator_hpp" title="Header &lt;boost/date_time/date_iterator.hpp&gt;">
   9 <link rel="prev" href="previous_weekday.html" title="Function template previous_weekday">
  10 <link rel="next" href="date_itr.html" title="Class template date_itr">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="previous_weekday.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.date_iterator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="date_itr.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.date_time.date_itr_base"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template date_itr_base</span></h2>
  29 <p>boost::date_time::date_itr_base &#8212; Base date iterator type. </p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../date_time/doxy.html#header.boost.date_time.date_iterator_hpp" title="Header &lt;boost/date_time/date_iterator.hpp&gt;">boost/date_time/date_iterator.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> date_type<span class="special">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="date_itr_base.html" title="Class template date_itr_base">date_itr_base</a> <span class="special">{</span>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// types</span>
  38   <span class="keyword">typedef</span> <span class="identifier">date_type</span><span class="special">::</span><span class="identifier">duration_type</span> <a name="boost.date_time.date_itr_base.duration_type"></a><span class="identifier">duration_type</span><span class="special">;</span>
  39   <span class="keyword">typedef</span> <span class="identifier">date_type</span>                <a name="boost.date_time.date_itr_base.value_type"></a><span class="identifier">value_type</span><span class="special">;</span>
  40   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">input_iterator_tag</span>  <a name="boost.date_time.date_itr_base.iterator_category"></a><span class="identifier">iterator_category</span><span class="special">;</span>
  41
  42   <span class="comment">// <a class="link" href="date_itr_base.html#boost.date_time.date_itr_baseconstruct-copy-destruct">construct/copy/destruct</a></span>
  43   <a class="link" href="date_itr_base.html#idp96957040-bb"><span class="identifier">date_itr_base</span></a><span class="special">(</span><span class="identifier">date_type</span><span class="special">)</span><span class="special">;</span>
  44   <a class="link" href="date_itr_base.html#idp96958016-bb"><span class="special">~</span><span class="identifier">date_itr_base</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  45
  46   <span class="comment">// <a class="link" href="date_itr_base.html#idp46156592-bb">public member functions</a></span>
  47   <a class="link" href="date_itr_base.html" title="Class template date_itr_base">date_itr_base</a> <span class="special">&amp;</span> <a class="link" href="date_itr_base.html#idp46157152-bb"><span class="keyword">operator</span><span class="special">++</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  48   <a class="link" href="date_itr_base.html" title="Class template date_itr_base">date_itr_base</a> <span class="special">&amp;</span> <a class="link" href="date_itr_base.html#idp38198592-bb"><span class="keyword">operator</span><span class="special">--</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  49   <span class="keyword">virtual</span> <span class="identifier">duration_type</span> <a class="link" href="date_itr_base.html#idp110791520-bb"><span class="identifier">get_offset</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">date_type</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span>
  50   <span class="keyword">virtual</span> <span class="identifier">duration_type</span> <a class="link" href="date_itr_base.html#idp46287440-bb"><span class="identifier">get_neg_offset</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">date_type</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span>
  51   <span class="identifier">date_type</span> <a class="link" href="date_itr_base.html#idp69859088-bb"><span class="keyword">operator</span><span class="special">*</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  52   <span class="identifier">date_type</span> <span class="special">*</span> <a class="link" href="date_itr_base.html#idp49852096-bb"><span class="keyword">operator</span><span class="special">-&gt;</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  53   <span class="keyword">bool</span> <a class="link" href="date_itr_base.html#idp107081440-bb"><span class="keyword">operator</span><span class="special">&lt;</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">date_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  54   <span class="keyword">bool</span> <a class="link" href="date_itr_base.html#idp113191264-bb"><span class="keyword">operator</span><span class="special">&lt;=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">date_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  55   <span class="keyword">bool</span> <a class="link" href="date_itr_base.html#idp72262768-bb"><span class="keyword">operator</span><span class="special">&gt;</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">date_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  56   <span class="keyword">bool</span> <a class="link" href="date_itr_base.html#idp39021760-bb"><span class="keyword">operator</span><span class="special">&gt;=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">date_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  57   <span class="keyword">bool</span> <a class="link" href="date_itr_base.html#idp102902944-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">date_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  58   <span class="keyword">bool</span> <a class="link" href="date_itr_base.html#idp104016224-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">date_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  59 <span class="special">}</span><span class="special">;</span></pre></div>
  60 <div class="refsect1">
  61 <a name="idp187998928"></a><h2>Description</h2>
  62 <p>This class provides the skeleton for the creation of iterators. New and interesting interators can be created by plugging in a new function that derives the next value from the current state. generation of various types of -based information.</p>
  63 <p><span class="bold"><strong>Template Parameters</strong></span></p>
  64 <p><span class="bold"><strong>date_type</strong></span></p>
  65 <p>The date_type is a concrete date_type. The date_type must define a duration_type and a calendar_type. </p>
  66 <div class="refsect2">
  67 <a name="idp188001600"></a><h3>
  68 <a name="boost.date_time.date_itr_baseconstruct-copy-destruct"></a><code class="computeroutput">date_itr_base</code>
  69         public
  70        construct/copy/destruct</h3>
  71 <div class="orderedlist"><ol class="orderedlist" type="1">
  72 <li class="listitem"><pre class="literallayout"><a name="idp96957040-bb"></a><span class="identifier">date_itr_base</span><span class="special">(</span><span class="identifier">date_type</span> d<span class="special">)</span><span class="special">;</span></pre></li>
  73 <li class="listitem"><pre class="literallayout"><a name="idp96958016-bb"></a><span class="special">~</span><span class="identifier">date_itr_base</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
  74 </ol></div>
  75 </div>
  76 <div class="refsect2">
  77 <a name="idp188012320"></a><h3>
  78 <a name="idp46156592-bb"></a><code class="computeroutput">date_itr_base</code> public member functions</h3>
  79 <div class="orderedlist"><ol class="orderedlist" type="1">
  80 <li class="listitem"><pre class="literallayout"><a class="link" href="date_itr_base.html" title="Class template date_itr_base">date_itr_base</a> <span class="special">&amp;</span> <a name="idp46157152-bb"></a><span class="keyword">operator</span><span class="special">++</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
  81 <li class="listitem"><pre class="literallayout"><a class="link" href="date_itr_base.html" title="Class template date_itr_base">date_itr_base</a> <span class="special">&amp;</span> <a name="idp38198592-bb"></a><span class="keyword">operator</span><span class="special">--</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
  82 <li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">duration_type</span> <a name="idp110791520-bb"></a><span class="identifier">get_offset</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">date_type</span> <span class="special">&amp;</span> current<span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre></li>
  83 <li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">duration_type</span> <a name="idp46287440-bb"></a><span class="identifier">get_neg_offset</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">date_type</span> <span class="special">&amp;</span> current<span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre></li>
  84 <li class="listitem"><pre class="literallayout"><span class="identifier">date_type</span> <a name="idp69859088-bb"></a><span class="keyword">operator</span><span class="special">*</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
  85 <li class="listitem"><pre class="literallayout"><span class="identifier">date_type</span> <span class="special">*</span> <a name="idp49852096-bb"></a><span class="keyword">operator</span><span class="special">-&gt;</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
  86 <li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idp107081440-bb"></a><span class="keyword">operator</span><span class="special">&lt;</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">date_type</span> <span class="special">&amp;</span> d<span class="special">)</span><span class="special">;</span></pre></li>
  87 <li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idp113191264-bb"></a><span class="keyword">operator</span><span class="special">&lt;=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">date_type</span> <span class="special">&amp;</span> d<span class="special">)</span><span class="special">;</span></pre></li>
  88 <li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idp72262768-bb"></a><span class="keyword">operator</span><span class="special">&gt;</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">date_type</span> <span class="special">&amp;</span> d<span class="special">)</span><span class="special">;</span></pre></li>
  89 <li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idp39021760-bb"></a><span class="keyword">operator</span><span class="special">&gt;=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">date_type</span> <span class="special">&amp;</span> d<span class="special">)</span><span class="special">;</span></pre></li>
  90 <li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idp102902944-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">date_type</span> <span class="special">&amp;</span> d<span class="special">)</span><span class="special">;</span></pre></li>
  91 <li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idp104016224-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">date_type</span> <span class="special">&amp;</span> d<span class="special">)</span><span class="special">;</span></pre></li>
  92 </ol></div>
  93 </div>
  94 </div>
  95 </div>
  96 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  97 <td align="left"></td>
  98 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2005 CrystalClear Software, Inc<p>Subject to the Boost Software License, Version 1.0. (See accompanying file
  99     <code class="filename">LICENSE_1_0.txt</code> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)</p>
 100 </div></td>
 101 </tr></table>
 102 <hr>
 103 <div class="spirit-nav">
 104 <a accesskey="p" href="previous_weekday.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.date_iterator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="date_itr.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 105 </div>
 106 </body>
 107 </html>