File: dst_calculator.html

package info (click to toggle)
boost1.49 1.49.0-3.2
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 427,096 kB
  • sloc: cpp: 1,806,930; xml: 101,307; ansic: 43,491; python: 28,668; sh: 11,922; cs: 2,118; perl: 714; makefile: 671; yacc: 456; asm: 353; php: 116; lisp: 60; sql: 13; csh: 6
file content (232 lines) | stat: -rwxr-xr-x 17,936 bytes parent folder | download 
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template dst_calculator</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<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.dst_rules_hpp" title="Header &lt;boost/date_time/dst_rules.hpp&gt;">
<link rel="prev" href="from_stream_type_id721908.html" title="Function template from_stream_type">
<link rel="next" href="dst_calc_engine.html" title="Class template dst_calc_engine">
</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="from_stream_type_id721908.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.dst_rules_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="dst_calc_engine.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.date_time.dst_calculator"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template dst_calculator</span></h2>
<p>boost::date_time::dst_calculator &#8212; Dynamic class used to caluclate dst transition information. </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="comment">// In header: &lt;<a class="link" href="../../date_time/doxy.html#header.boost.date_time.dst_rules_hpp" title="Header &lt;boost/date_time/dst_rules.hpp&gt;">boost/date_time/dst_rules.hpp</a>&gt;

</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> date_type_<span class="special">,</span> <span class="keyword">typename</span> time_duration_type_<span class="special">&gt;</span> 
<span class="keyword">class</span> <a class="link" href="dst_calculator.html" title="Class template dst_calculator">dst_calculator</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
  <span class="comment">// types</span>
  <span class="keyword">typedef</span> <span class="identifier">time_duration_type_</span> <a name="boost.date_time.dst_calculator.time_duration_type"></a><span class="identifier">time_duration_type</span><span class="special">;</span>
  <span class="keyword">typedef</span> <span class="identifier">date_type_</span>          <a name="boost.date_time.dst_calculator.date_type"></a><span class="identifier">date_type</span><span class="special">;</span>         

  <span class="comment">// <a class="link" href="dst_calculator.html#id692106-bb">public static functions</a></span>
  <span class="keyword">static</span> <span class="identifier">time_is_dst_result</span> 
  <a class="link" href="dst_calculator.html#id673839-bb"><span class="identifier">process_local_dst_start_day</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">time_duration_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">long</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">static</span> <span class="identifier">time_is_dst_result</span> 
  <a class="link" href="dst_calculator.html#id719800-bb"><span class="identifier">process_local_dst_end_day</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">time_duration_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">long</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">static</span> <span class="identifier">time_is_dst_result</span> 
  <a class="link" href="dst_calculator.html#id683072-bb"><span class="identifier">local_is_dst</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="identifier">time_duration_type</span> <span class="special">&amp;</span><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="identifier">time_duration_type</span> <span class="special">&amp;</span><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="identifier">time_duration_type</span> <span class="special">&amp;</span><span class="special">,</span> 
               <span class="keyword">const</span> <span class="identifier">time_duration_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">static</span> <span class="identifier">time_is_dst_result</span> 
  <a class="link" href="dst_calculator.html#id717180-bb"><span class="identifier">local_is_dst</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="identifier">time_duration_type</span> <span class="special">&amp;</span><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">unsigned</span> <span class="keyword">int</span><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">unsigned</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">long</span><span class="special">)</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="id1383405"></a><h2>Description</h2>
<div class="refsect2">
<a name="id1383408"></a><h3>
<a name="id692106-bb"></a><code class="computeroutput">dst_calculator</code> public static functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">time_is_dst_result</span> 
<a name="id673839-bb"></a><span class="identifier">process_local_dst_start_day</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">time_duration_type</span> <span class="special">&amp;</span> time_of_day<span class="special">,</span> 
                            <span class="keyword">unsigned</span> <span class="keyword">int</span> dst_start_offset_minutes<span class="special">,</span> 
                            <span class="keyword">long</span> dst_length_minutes<span class="special">)</span><span class="special">;</span></pre>Check the local time offset when on dst start day. <p>On this dst transition, the time label between the transition boundary and the boudary + the offset are invalid times. If before the boundary then still not in dst. 

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><code class="computeroutput">dst_length_minutes</code></span></p></td>
<td><p>Number of minutes to adjust clock forward </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">dst_start_offset_minutes</code></span></p></td>
<td><p>Local day offset for start of dst </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">time_of_day</code></span></p></td>
<td><p>Time offset in the day for the local time </p></td>
</tr>
</tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">time_is_dst_result</span> 
<a name="id719800-bb"></a><span class="identifier">process_local_dst_end_day</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">time_duration_type</span> <span class="special">&amp;</span> time_of_day<span class="special">,</span> 
                          <span class="keyword">unsigned</span> <span class="keyword">int</span> dst_end_offset_minutes<span class="special">,</span> 
                          <span class="keyword">long</span> dst_length_minutes<span class="special">)</span><span class="special">;</span></pre>Check the local time offset when on the last day of dst. <p>This is the calculation for the DST end day. On that day times prior to the conversion time - dst_length (1 am in US) are still in dst. Times between the above and the switch time are ambiguous. Times after the start_offset are not in dst. 

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><code class="computeroutput">dst_end_offset_minutes</code></span></p></td>
<td><p>Local time of day for end of dst </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">time_of_day</code></span></p></td>
<td><p>Time offset in the day for the local time </p></td>
</tr>
</tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">time_is_dst_result</span> 
<a name="id683072-bb"></a><span class="identifier">local_is_dst</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">date_type</span> <span class="special">&amp;</span> current_day<span class="special">,</span> 
             <span class="keyword">const</span> <span class="identifier">time_duration_type</span> <span class="special">&amp;</span> time_of_day<span class="special">,</span> 
             <span class="keyword">const</span> <span class="identifier">date_type</span> <span class="special">&amp;</span> dst_start_day<span class="special">,</span> 
             <span class="keyword">const</span> <span class="identifier">time_duration_type</span> <span class="special">&amp;</span> dst_start_offset<span class="special">,</span> 
             <span class="keyword">const</span> <span class="identifier">date_type</span> <span class="special">&amp;</span> dst_end_day<span class="special">,</span> 
             <span class="keyword">const</span> <span class="identifier">time_duration_type</span> <span class="special">&amp;</span> dst_end_offset<span class="special">,</span> 
             <span class="keyword">const</span> <span class="identifier">time_duration_type</span> <span class="special">&amp;</span> dst_length_minutes<span class="special">)</span><span class="special">;</span></pre>Calculates if the given local time is dst or not. <p>Determines if the time is really in DST or not. Also checks for invalid and ambiguous. 

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><code class="computeroutput">current_day</code></span></p></td>
<td><p>The day to check for dst </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">dst_end_day</code></span></p></td>
<td><p>Ending day of dst for the given locality </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">dst_end_offset</code></span></p></td>
<td><p>Time offset within day given in dst for dst boundary </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">dst_start_day</code></span></p></td>
<td><p>Starting day of dst for the given locality </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">dst_start_offset</code></span></p></td>
<td><p>Time offset within day for dst boundary </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">time_of_day</code></span></p></td>
<td><p>Time offset within the day to check </p></td>
</tr>
</tbody>
</table></div></td>
</tr></tbody>
</table></div>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">time_is_dst_result</span> 
<a name="id717180-bb"></a><span class="identifier">local_is_dst</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">date_type</span> <span class="special">&amp;</span> current_day<span class="special">,</span> 
             <span class="keyword">const</span> <span class="identifier">time_duration_type</span> <span class="special">&amp;</span> time_of_day<span class="special">,</span> 
             <span class="keyword">const</span> <span class="identifier">date_type</span> <span class="special">&amp;</span> dst_start_day<span class="special">,</span> 
             <span class="keyword">unsigned</span> <span class="keyword">int</span> dst_start_offset_minutes<span class="special">,</span> 
             <span class="keyword">const</span> <span class="identifier">date_type</span> <span class="special">&amp;</span> dst_end_day<span class="special">,</span> 
             <span class="keyword">unsigned</span> <span class="keyword">int</span> dst_end_offset_minutes<span class="special">,</span> <span class="keyword">long</span> dst_length_minutes<span class="special">)</span><span class="special">;</span></pre>Calculates if the given local time is dst or not. <p>Determines if the time is really in DST or not. Also checks for invalid and ambiguous. 

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term">Parameters:</span></p></td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><code class="computeroutput">current_day</code></span></p></td>
<td><p>The day to check for dst </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">dst_end_day</code></span></p></td>
<td><p>Ending day of dst for the given locality </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">dst_end_offset_minutes</code></span></p></td>
<td><p>Offset within day given in dst for dst boundary (eg 120 for US which is 02:00:00) </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">dst_length_minutes</code></span></p></td>
<td><p>Length of dst adjusment (eg: 60 for US) </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">dst_start_day</code></span></p></td>
<td><p>Starting day of dst for the given locality </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">dst_start_offset_minutes</code></span></p></td>
<td><p>Offset within day for dst boundary (eg 120 for US which is 02:00:00) </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="computeroutput">time_of_day</code></span></p></td>
<td><p>Time offset within the day to check </p></td>
</tr>
</tbody>
</table></div></td>
</tr></tbody>
</table></div>
</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 &#169; 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="from_stream_type_id721908.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.dst_rules_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="dst_calc_engine.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>