• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<html>
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5<title>Class template date_itr_base</title>
6<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
8<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
9<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;">
10<link rel="prev" href="date_itr.html" title="Class template date_itr">
11<link rel="next" href="all_date_names_put.html" title="Class template all_date_names_put">
12</head>
13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
14<table cellpadding="2" width="100%"><tr>
15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
16<td align="center"><a href="../../../../index.html">Home</a></td>
17<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
20<td align="center"><a href="../../../../more/index.htm">More</a></td>
21</tr></table>
22<hr>
23<div class="spirit-nav">
24<a accesskey="p" href="date_itr.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="all_date_names_put.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
25</div>
26<div class="refentry">
27<a name="boost.date_time.date_itr_base"></a><div class="titlepage"></div>
28<div class="refnamediv">
29<h2><span class="refentrytitle">Class template date_itr_base</span></h2>
30<p>boost::date_time::date_itr_base — Base date iterator type. </p>
31</div>
32<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
33<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;
34
35</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> date_type<span class="special">&gt;</span>
36<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>
37<span class="keyword">public</span><span class="special">:</span>
38  <span class="comment">// types</span>
39  <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>
40  <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>
41  <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>
42
43  <span class="comment">// <a class="link" href="date_itr_base.html#boost.date_time.date_itr_baseconstruct-copy-destruct">construct/copy/destruct</a></span>
44  <a class="link" href="date_itr_base.html#id-1_3_14_15_3_20_1_1_2_8-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>
45  <a class="link" href="date_itr_base.html#id-1_3_14_15_3_20_1_1_2_9-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>
46
47  <span class="comment">// <a class="link" href="date_itr_base.html#id-1_3_14_15_3_20_1_1_2_7-bb">public member functions</a></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#id-1_3_14_15_3_20_1_1_2_7_1-bb"><span class="keyword">operator</span><span class="special">++</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
49  <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#id-1_3_14_15_3_20_1_1_2_7_2-bb"><span class="keyword">operator</span><span class="special">--</span></a><span class="special">(</span><span class="special">)</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#id-1_3_14_15_3_20_1_1_2_7_3-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>
51  <span class="keyword">virtual</span> <span class="identifier">duration_type</span> <a class="link" href="date_itr_base.html#id-1_3_14_15_3_20_1_1_2_7_4-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>
52  <span class="identifier">date_type</span> <a class="link" href="date_itr_base.html#id-1_3_14_15_3_20_1_1_2_7_5-bb"><span class="keyword">operator</span> <span class="special">*</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
53  <span class="identifier">date_type</span> <span class="special">*</span> <a class="link" href="date_itr_base.html#id-1_3_14_15_3_20_1_1_2_7_6-bb"><span class="keyword">operator</span><span class="special">-&gt;</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
54  <span class="keyword">bool</span> <a class="link" href="date_itr_base.html#id-1_3_14_15_3_20_1_1_2_7_7-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#id-1_3_14_15_3_20_1_1_2_7_8-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>
56  <span class="keyword">bool</span> <a class="link" href="date_itr_base.html#id-1_3_14_15_3_20_1_1_2_7_9-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#id-1_3_14_15_3_20_1_1_2_7_10-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>
58  <span class="keyword">bool</span> <a class="link" href="date_itr_base.html#id-1_3_14_15_3_20_1_1_2_7_11-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="keyword">bool</span> <a class="link" href="date_itr_base.html#id-1_3_14_15_3_20_1_1_2_7_12-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>
60<span class="special">}</span><span class="special">;</span></pre></div>
61<div class="refsect1">
62<a name="id-1.3.14.15.3.20.4.4"></a><h2>Description</h2>
63<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>
64<p><span class="bold"><strong>Template Parameters</strong></span></p>
65<p><span class="bold"><strong>date_type</strong></span></p>
66<p>The date_type is a concrete date_type. The date_type must define a duration_type and a calendar_type. </p>
67<div class="refsect2">
68<a name="id-1.3.14.15.3.20.4.4.6"></a><h3>
69<a name="boost.date_time.date_itr_baseconstruct-copy-destruct"></a><code class="computeroutput">date_itr_base</code>
70        public
71       construct/copy/destruct</h3>
72<div class="orderedlist"><ol class="orderedlist" type="1">
73<li class="listitem"><pre class="literallayout"><a name="id-1_3_14_15_3_20_1_1_2_8-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>
74<li class="listitem"><pre class="literallayout"><a name="id-1_3_14_15_3_20_1_1_2_9-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>
75</ol></div>
76</div>
77<div class="refsect2">
78<a name="id-1.3.14.15.3.20.4.4.7"></a><h3>
79<a name="id-1_3_14_15_3_20_1_1_2_7-bb"></a><code class="computeroutput">date_itr_base</code> public member functions</h3>
80<div class="orderedlist"><ol class="orderedlist" type="1">
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="id-1_3_14_15_3_20_1_1_2_7_1-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"><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="id-1_3_14_15_3_20_1_1_2_7_2-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>
83<li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">duration_type</span> <a name="id-1_3_14_15_3_20_1_1_2_7_3-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>
84<li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">duration_type</span> <a name="id-1_3_14_15_3_20_1_1_2_7_4-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>
85<li class="listitem"><pre class="literallayout"><span class="identifier">date_type</span> <a name="id-1_3_14_15_3_20_1_1_2_7_5-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>
86<li class="listitem"><pre class="literallayout"><span class="identifier">date_type</span> <span class="special">*</span> <a name="id-1_3_14_15_3_20_1_1_2_7_6-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>
87<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="id-1_3_14_15_3_20_1_1_2_7_7-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="id-1_3_14_15_3_20_1_1_2_7_8-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>
89<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="id-1_3_14_15_3_20_1_1_2_7_9-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="id-1_3_14_15_3_20_1_1_2_7_10-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>
91<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="id-1_3_14_15_3_20_1_1_2_7_11-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<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="id-1_3_14_15_3_20_1_1_2_7_12-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>
93</ol></div>
94</div>
95</div>
96</div>
97<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
98<td align="left"></td>
99<td align="right"><div class="copyright-footer">Copyright © 2001-2005 CrystalClear Software, Inc<p>Subject to the Boost Software License, Version 1.0. (See accompanying file
100    <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>
101</div></td>
102</tr></table>
103<hr>
104<div class="spirit-nav">
105<a accesskey="p" href="date_itr.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="all_date_names_put.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
106</div>
107</body>
108</html>
109