1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template date_generator_parser</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../../date_time/doxy.html#header.boost.date_time.date_generator_parser_hpp" title="Header <boost/date_time/date_generator_parser.hpp>">
<link rel="prev" href="date_generator_formatter.html" title="Class template date_generator_formatter">
<link rel="next" href="year_based_generator.html" title="Class template year_based_generator">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="date_generator_formatter.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.date_generator_parser_hpp"><img src="../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="year_based_generator.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="refentry" title="Class template date_generator_parser">
<a name="boost.date_time.date_generator_parser"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template date_generator_parser</span></h2>
<p>boost::date_time::date_generator_parser — Class for date_generator parsing. </p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="emphasis"><em>// In header: <<a class="link" href="../../date_time/doxy.html#header.boost.date_time.date_generator_parser_hpp" title="Header <boost/date_time/date_generator_parser.hpp>">boost/date_time/date_generator_parser.hpp</a>>
</em></span><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> date_type, <span class="bold"><strong>typename</strong></span> charT>
<span class="bold"><strong>class</strong></span> <a class="link" href="date_generator_parser.html" title="Class template date_generator_parser">date_generator_parser</a> {
<span class="bold"><strong>public</strong></span>:
<span class="emphasis"><em>// types</em></span>
<span class="bold"><strong>typedef</strong></span> std::basic_string< charT > <a name="boost.date_time.date_generator_parser.string_type"></a>string_type;
<span class="bold"><strong>typedef</strong></span> std::istreambuf_iterator< charT > <a name="boost.date_time.date_generator_parser.stream_itr_type"></a>stream_itr_type;
<span class="bold"><strong>typedef</strong></span> date_type::month_type <a name="boost.date_time.date_generator_parser.month_type"></a>month_type;
<span class="bold"><strong>typedef</strong></span> date_type::day_of_week_type <a name="boost.date_time.date_generator_parser.day_of_week_type"></a>day_of_week_type;
<span class="bold"><strong>typedef</strong></span> date_type::day_type <a name="boost.date_time.date_generator_parser.day_type"></a>day_type;
<span class="bold"><strong>typedef</strong></span> <a class="link" href="string_parse_tree.html" title="Struct template string_parse_tree">string_parse_tree</a>< charT > <a name="boost.date_time.date_generator_parser.parse_tree_type"></a>parse_tree_type;
<span class="bold"><strong>typedef</strong></span> parse_tree_type::parse_match_result_type <a name="boost.date_time.date_generator_parser.match_results"></a>match_results;
<span class="bold"><strong>typedef</strong></span> std::vector< std::basic_string< charT > > <a name="boost.date_time.date_generator_parser.collection_type"></a>collection_type;
<span class="bold"><strong>typedef</strong></span> <a class="link" href="partial_date.html" title="Class template partial_date">partial_date</a>< date_type > <a name="boost.date_time.date_generator_parser.partial_date_type"></a>partial_date_type;
<span class="bold"><strong>typedef</strong></span> <a class="link" href="nth_kday_of_month.html" title="Class template nth_kday_of_month">nth_kday_of_month</a>< date_type > <a name="boost.date_time.date_generator_parser.nth_kday_type"></a>nth_kday_type;
<span class="bold"><strong>typedef</strong></span> <a class="link" href="first_kday_of_month.html" title="Class template first_kday_of_month">first_kday_of_month</a>< date_type > <a name="boost.date_time.date_generator_parser.first_kday_type"></a>first_kday_type;
<span class="bold"><strong>typedef</strong></span> <a class="link" href="last_kday_of_month.html" title="Class template last_kday_of_month">last_kday_of_month</a>< date_type > <a name="boost.date_time.date_generator_parser.last_kday_type"></a>last_kday_type;
<span class="bold"><strong>typedef</strong></span> <a class="link" href="first_kday_after.html" title="Class template first_kday_after">first_kday_after</a>< date_type > <a name="boost.date_time.date_generator_parser.kday_after_type"></a>kday_after_type;
<span class="bold"><strong>typedef</strong></span> <a class="link" href="first_kday_before.html" title="Class template first_kday_before">first_kday_before</a>< date_type > <a name="boost.date_time.date_generator_parser.kday_before_type"></a>kday_before_type;
<span class="bold"><strong>typedef</strong></span> charT <a name="boost.date_time.date_generator_parser.char_type"></a>char_type;
<span class="bold"><strong>enum</strong></span> <a name="boost.date_time.date_generator_parser.phrase_elements"></a>phrase_elements { first = 0, second, third, fourth, fifth, last,
before, after, of, number_of_phrase_elements };
<span class="emphasis"><em>// <a class="link" href="date_generator_parser.html#boost.date_time.date_generator_parserconstruct-copy-destruct">construct/copy/destruct</a></em></span>
<a class="link" href="date_generator_parser.html#id328034-bb">date_generator_parser</a>();
<a class="link" href="date_generator_parser.html#id328039-bb">date_generator_parser</a>(<span class="bold"><strong>const</strong></span> string_type &, <span class="bold"><strong>const</strong></span> string_type &,
<span class="bold"><strong>const</strong></span> string_type &, <span class="bold"><strong>const</strong></span> string_type &,
<span class="bold"><strong>const</strong></span> string_type &, <span class="bold"><strong>const</strong></span> string_type &,
<span class="bold"><strong>const</strong></span> string_type &, <span class="bold"><strong>const</strong></span> string_type &,
<span class="bold"><strong>const</strong></span> string_type &);
<span class="emphasis"><em>// <a class="link" href="date_generator_parser.html#id396504-bb">public member functions</a></em></span>
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="date_generator_parser.html#id396508-bb">element_strings</a>(<span class="bold"><strong>const</strong></span> string_type &, <span class="bold"><strong>const</strong></span> string_type &,
<span class="bold"><strong>const</strong></span> string_type &, <span class="bold"><strong>const</strong></span> string_type &,
<span class="bold"><strong>const</strong></span> string_type &, <span class="bold"><strong>const</strong></span> string_type &,
<span class="bold"><strong>const</strong></span> string_type &, <span class="bold"><strong>const</strong></span> string_type &,
<span class="bold"><strong>const</strong></span> string_type &) ;
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="date_generator_parser.html#id607010-bb">element_strings</a>(<span class="bold"><strong>const</strong></span> collection_type &) ;
<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> facet_type>
<span class="type"><a class="link" href="date_generator_parser.html#boost.date_time.date_generator_parser.partial_date_type">partial_date_type</a></span>
<a class="link" href="date_generator_parser.html#id361439-bb">get_partial_date_type</a>(stream_itr_type &, stream_itr_type &,
std::ios_base &, <span class="bold"><strong>const</strong></span> facet_type &) <span class="bold"><strong>const</strong></span>;
<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> facet_type>
<span class="type"><a class="link" href="date_generator_parser.html#boost.date_time.date_generator_parser.nth_kday_type">nth_kday_type</a></span>
<a class="link" href="date_generator_parser.html#id336199-bb">get_nth_kday_type</a>(stream_itr_type &, stream_itr_type &, std::ios_base &,
<span class="bold"><strong>const</strong></span> facet_type &) <span class="bold"><strong>const</strong></span>;
<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> facet_type>
<span class="type"><a class="link" href="date_generator_parser.html#boost.date_time.date_generator_parser.first_kday_type">first_kday_type</a></span>
<a class="link" href="date_generator_parser.html#id368941-bb">get_first_kday_type</a>(stream_itr_type &, stream_itr_type &, std::ios_base &,
<span class="bold"><strong>const</strong></span> facet_type &) <span class="bold"><strong>const</strong></span>;
<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> facet_type>
<span class="type"><a class="link" href="date_generator_parser.html#boost.date_time.date_generator_parser.last_kday_type">last_kday_type</a></span>
<a class="link" href="date_generator_parser.html#id473164-bb">get_last_kday_type</a>(stream_itr_type &, stream_itr_type &, std::ios_base &,
<span class="bold"><strong>const</strong></span> facet_type &) <span class="bold"><strong>const</strong></span>;
<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> facet_type>
<span class="type"><a class="link" href="date_generator_parser.html#boost.date_time.date_generator_parser.kday_before_type">kday_before_type</a></span>
<a class="link" href="date_generator_parser.html#id321582-bb">get_kday_before_type</a>(stream_itr_type &, stream_itr_type &,
std::ios_base &, <span class="bold"><strong>const</strong></span> facet_type &) <span class="bold"><strong>const</strong></span>;
<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> facet_type>
<span class="type"><a class="link" href="date_generator_parser.html#boost.date_time.date_generator_parser.kday_after_type">kday_after_type</a></span>
<a class="link" href="date_generator_parser.html#id363325-bb">get_kday_after_type</a>(stream_itr_type &, stream_itr_type &, std::ios_base &,
<span class="bold"><strong>const</strong></span> facet_type &) <span class="bold"><strong>const</strong></span>;
<span class="emphasis"><em>// <a class="link" href="date_generator_parser.html#id355053-bb">private member functions</a></em></span>
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="date_generator_parser.html#id355056-bb">extract_element</a>(stream_itr_type &, stream_itr_type &,
<span class="bold"><strong>typename</strong></span> date_generator_parser::phrase_elements) <span class="bold"><strong>const</strong></span>;
<span class="bold"><strong>static</strong></span> <span class="type"><span class="bold"><strong>const</strong></span> char_type</span> first_string;
<span class="bold"><strong>static</strong></span> <span class="type"><span class="bold"><strong>const</strong></span> char_type</span> second_string;
<span class="bold"><strong>static</strong></span> <span class="type"><span class="bold"><strong>const</strong></span> char_type</span> third_string;
<span class="bold"><strong>static</strong></span> <span class="type"><span class="bold"><strong>const</strong></span> char_type</span> fourth_string;
<span class="bold"><strong>static</strong></span> <span class="type"><span class="bold"><strong>const</strong></span> char_type</span> fifth_string;
<span class="bold"><strong>static</strong></span> <span class="type"><span class="bold"><strong>const</strong></span> char_type</span> last_string;
<span class="bold"><strong>static</strong></span> <span class="type"><span class="bold"><strong>const</strong></span> char_type</span> before_string;
<span class="bold"><strong>static</strong></span> <span class="type"><span class="bold"><strong>const</strong></span> char_type</span> after_string;
<span class="bold"><strong>static</strong></span> <span class="type"><span class="bold"><strong>const</strong></span> char_type</span> of_string;
};</pre></div>
<div class="refsect1" title="Description">
<a name="id784246"></a><h2>Description</h2>
<p>The elements of a date_generator "phrase" are parsed from the input stream in a particular order. All elements are required and the order in which they appear cannot change, however, the elements themselves can be changed. The default elements and their order are as follows:</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem"><p>partial_date => "dd Month"</p></li>
<li class="listitem"><p>nth_day_of_the_week_in_month => "nth weekday of month"</p></li>
<li class="listitem"><p>first_day_of_the_week_in_month => "first weekday of month"</p></li>
<li class="listitem"><p>last_day_of_the_week_in_month => "last weekday of month"</p></li>
<li class="listitem"><p>first_day_of_the_week_after => "weekday after"</p></li>
<li class="listitem"><p>first_day_of_the_week_before => "weekday before"</p></li>
</ul></div>
<p>
</p>
<p>Weekday and Month names and formats are handled via the date_input_facet. </p>
<div class="refsect2" title="date_generator_parser public construct/copy/destruct">
<a name="id784292"></a><h3>
<a name="boost.date_time.date_generator_parserconstruct-copy-destruct"></a><code class="computeroutput">date_generator_parser</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><a name="id328034-bb"></a>date_generator_parser();</pre>Creates a date_generator_parser with the default set of "element_strings". </li>
<li class="listitem">
<pre class="literallayout"><a name="id328039-bb"></a>date_generator_parser(<span class="bold"><strong>const</strong></span> string_type & first_str,
<span class="bold"><strong>const</strong></span> string_type & second_str,
<span class="bold"><strong>const</strong></span> string_type & third_str,
<span class="bold"><strong>const</strong></span> string_type & fourth_str,
<span class="bold"><strong>const</strong></span> string_type & fifth_str,
<span class="bold"><strong>const</strong></span> string_type & last_str,
<span class="bold"><strong>const</strong></span> string_type & before_str,
<span class="bold"><strong>const</strong></span> string_type & after_str,
<span class="bold"><strong>const</strong></span> string_type & of_str);</pre>Creates a date_generator_parser using a user defined set of element strings. </li>
</ol></div>
</div>
<div class="refsect2" title="date_generator_parser public member functions">
<a name="id784411"></a><h3>
<a name="id396504-bb"></a><code class="computeroutput">date_generator_parser</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id396508-bb"></a>element_strings(<span class="bold"><strong>const</strong></span> string_type & first_str,
<span class="bold"><strong>const</strong></span> string_type & second_str,
<span class="bold"><strong>const</strong></span> string_type & third_str,
<span class="bold"><strong>const</strong></span> string_type & fourth_str,
<span class="bold"><strong>const</strong></span> string_type & fifth_str,
<span class="bold"><strong>const</strong></span> string_type & last_str,
<span class="bold"><strong>const</strong></span> string_type & before_str,
<span class="bold"><strong>const</strong></span> string_type & after_str,
<span class="bold"><strong>const</strong></span> string_type & of_str) ;</pre>Replace strings that determine nth week for generator. </li>
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id607010-bb"></a>element_strings(<span class="bold"><strong>const</strong></span> collection_type & col) ;</pre></li>
<li class="listitem">
<pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> facet_type>
<span class="type"><a class="link" href="date_generator_parser.html#boost.date_time.date_generator_parser.partial_date_type">partial_date_type</a></span>
<a name="id361439-bb"></a>get_partial_date_type(stream_itr_type & sitr, stream_itr_type & stream_end,
std::ios_base & a_ios, <span class="bold"><strong>const</strong></span> facet_type & facet) <span class="bold"><strong>const</strong></span>;</pre>returns partial_date parsed from stream </li>
<li class="listitem">
<pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> facet_type>
<span class="type"><a class="link" href="date_generator_parser.html#boost.date_time.date_generator_parser.nth_kday_type">nth_kday_type</a></span>
<a name="id336199-bb"></a>get_nth_kday_type(stream_itr_type & sitr, stream_itr_type & stream_end,
std::ios_base & a_ios, <span class="bold"><strong>const</strong></span> facet_type & facet) <span class="bold"><strong>const</strong></span>;</pre>returns nth_kday_of_week parsed from stream </li>
<li class="listitem">
<pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> facet_type>
<span class="type"><a class="link" href="date_generator_parser.html#boost.date_time.date_generator_parser.first_kday_type">first_kday_type</a></span>
<a name="id368941-bb"></a>get_first_kday_type(stream_itr_type & sitr, stream_itr_type & stream_end,
std::ios_base & a_ios, <span class="bold"><strong>const</strong></span> facet_type & facet) <span class="bold"><strong>const</strong></span>;</pre>returns first_kday_of_week parsed from stream </li>
<li class="listitem">
<pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> facet_type>
<span class="type"><a class="link" href="date_generator_parser.html#boost.date_time.date_generator_parser.last_kday_type">last_kday_type</a></span>
<a name="id473164-bb"></a>get_last_kday_type(stream_itr_type & sitr, stream_itr_type & stream_end,
std::ios_base & a_ios, <span class="bold"><strong>const</strong></span> facet_type & facet) <span class="bold"><strong>const</strong></span>;</pre>returns last_kday_of_week parsed from stream </li>
<li class="listitem">
<pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> facet_type>
<span class="type"><a class="link" href="date_generator_parser.html#boost.date_time.date_generator_parser.kday_before_type">kday_before_type</a></span>
<a name="id321582-bb"></a>get_kday_before_type(stream_itr_type & sitr, stream_itr_type & stream_end,
std::ios_base & a_ios, <span class="bold"><strong>const</strong></span> facet_type & facet) <span class="bold"><strong>const</strong></span>;</pre>returns first_kday_of_week parsed from stream </li>
<li class="listitem">
<pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> facet_type>
<span class="type"><a class="link" href="date_generator_parser.html#boost.date_time.date_generator_parser.kday_after_type">kday_after_type</a></span>
<a name="id363325-bb"></a>get_kday_after_type(stream_itr_type & sitr, stream_itr_type & stream_end,
std::ios_base & a_ios, <span class="bold"><strong>const</strong></span> facet_type & facet) <span class="bold"><strong>const</strong></span>;</pre>returns first_kday_of_week parsed from stream </li>
</ol></div>
</div>
<div class="refsect2" title="date_generator_parser private member functions">
<a name="id784861"></a><h3>
<a name="id355053-bb"></a><code class="computeroutput">date_generator_parser</code> private member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id355056-bb"></a>extract_element(stream_itr_type & sitr, stream_itr_type & stream_end,
<span class="bold"><strong>typename</strong></span> date_generator_parser::phrase_elements ele) <span class="bold"><strong>const</strong></span>;</pre>Extracts phrase element from input. Throws ios_base::failure on error. </li></ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<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
<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>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="date_generator_formatter.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.date_generator_parser_hpp"><img src="../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="year_based_generator.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>
|
