• 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 custom_time_zone_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.local_time.custom_time_zone_hpp" title="Header &lt;boost/date_time/local_time/custom_time_zone.hpp&gt;">
10<link rel="prev" href="../serialization/load_1_3_14_15_5_16_1_1_11.html" title="Function template load">
11<link rel="next" href="operat_1_3_14_15_6_4_2_1_1.html" title="Function operator+">
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="../serialization/load_1_3_14_15_5_16_1_1_11.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.local_time.custom_time_zone_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="operat_1_3_14_15_6_4_2_1_1.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
25</div>
26<div class="refentry">
27<a name="boost.local_time.custom_time_zone_base"></a><div class="titlepage"></div>
28<div class="refnamediv">
29<h2><span class="refentrytitle">Class template custom_time_zone_base</span></h2>
30<p>boost::local_time::custom_time_zone_base — A real time zone. </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.local_time.custom_time_zone_hpp" title="Header &lt;boost/date_time/local_time/custom_time_zone.hpp&gt;">boost/date_time/local_time/custom_time_zone.hpp</a>&gt;
34
35</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">&gt;</span>
36<span class="keyword">class</span> <a class="link" href="custom_time_zone_base.html" title="Class template custom_time_zone_base">custom_time_zone_base</a> <span class="special">:</span>
37  <span class="keyword">public</span> <span class="identifier">date_time</span><span class="special">::</span><span class="identifier">time_zone_base</span><span class="special">&lt;</span> <span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span><span class="special">,</span> <span class="identifier">CharT</span> <span class="special">&gt;</span>
38<span class="special">{</span>
39<span class="keyword">public</span><span class="special">:</span>
40  <span class="comment">// types</span>
41  <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">time_duration</span>                      <a name="boost.local_time.custom_time_zone_base.time_duration_type"></a><span class="identifier">time_duration_type</span><span class="special">;</span>
42  <span class="keyword">typedef</span> <span class="identifier">date_time</span><span class="special">::</span><span class="identifier">time_zone_base</span><span class="special">&lt;</span> <span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span><span class="special">,</span> <span class="identifier">CharT</span> <span class="special">&gt;</span> <a name="boost.local_time.custom_time_zone_base.base_type"></a><span class="identifier">base_type</span><span class="special">;</span>
43  <span class="keyword">typedef</span> <span class="identifier">base_type</span><span class="special">::</span><span class="identifier">string_type</span>                                <a name="boost.local_time.custom_time_zone_base.string_type"></a><span class="identifier">string_type</span><span class="special">;</span>
44  <span class="keyword">typedef</span> <span class="identifier">base_type</span><span class="special">::</span><span class="identifier">stringstream_type</span>                          <a name="boost.local_time.custom_time_zone_base.stringstream_type"></a><span class="identifier">stringstream_type</span><span class="special">;</span>
45  <span class="keyword">typedef</span> <span class="identifier">date_time</span><span class="special">::</span><span class="identifier">time_zone_names_base</span><span class="special">&lt;</span> <span class="identifier">CharT</span> <span class="special">&gt;</span>              <a name="boost.local_time.custom_time_zone_base.time_zone_names"></a><span class="identifier">time_zone_names</span><span class="special">;</span>
46  <span class="keyword">typedef</span> <span class="identifier">CharT</span>                                                 <a name="boost.local_time.custom_time_zone_base.char_type"></a><span class="identifier">char_type</span><span class="special">;</span>
47
48  <span class="comment">// <a class="link" href="custom_time_zone_base.html#boost.local_time.custom_time_zone_baseconstruct-copy-destruct">construct/copy/destruct</a></span>
49  <a class="link" href="custom_time_zone_base.html#id-1_3_14_15_6_3_1_1_1_11-bb"><span class="identifier">custom_time_zone_base</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">time_zone_names</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>
50                        <span class="keyword">const</span> <span class="identifier">dst_adjustment_offsets</span> <span class="special">&amp;</span><span class="special">,</span>
51                        <span class="identifier">boost</span><span class="special">::</span><span class="identifier">shared_ptr</span><span class="special">&lt;</span> <span class="identifier">dst_calc_rule</span> <span class="special">&gt;</span><span class="special">)</span><span class="special">;</span>
52  <a class="link" href="custom_time_zone_base.html#id-1_3_14_15_6_3_1_1_1_12-bb"><span class="special">~</span><span class="identifier">custom_time_zone_base</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
53
54  <span class="comment">// <a class="link" href="custom_time_zone_base.html#id-1_3_14_15_6_3_1_1_1_10-bb">public member functions</a></span>
55  <span class="keyword">virtual</span> <span class="identifier">string_type</span> <a class="link" href="custom_time_zone_base.html#id-1_3_14_15_6_3_1_1_1_10_1-bb"><span class="identifier">dst_zone_abbrev</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
56  <span class="keyword">virtual</span> <span class="identifier">string_type</span> <a class="link" href="custom_time_zone_base.html#id-1_3_14_15_6_3_1_1_1_10_2-bb"><span class="identifier">std_zone_abbrev</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
57  <span class="keyword">virtual</span> <span class="identifier">string_type</span> <a class="link" href="custom_time_zone_base.html#id-1_3_14_15_6_3_1_1_1_10_3-bb"><span class="identifier">dst_zone_name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
58  <span class="keyword">virtual</span> <span class="identifier">string_type</span> <a class="link" href="custom_time_zone_base.html#id-1_3_14_15_6_3_1_1_1_10_4-bb"><span class="identifier">std_zone_name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
59  <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="custom_time_zone_base.html#id-1_3_14_15_6_3_1_1_1_10_5-bb"><span class="identifier">has_dst</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
60  <span class="keyword">virtual</span> <span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <a class="link" href="custom_time_zone_base.html#id-1_3_14_15_6_3_1_1_1_10_6-bb"><span class="identifier">dst_local_start_time</span></a><span class="special">(</span><span class="identifier">gregorian</span><span class="special">::</span><span class="identifier">greg_year</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
61  <span class="keyword">virtual</span> <span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <a class="link" href="custom_time_zone_base.html#id-1_3_14_15_6_3_1_1_1_10_7-bb"><span class="identifier">dst_local_end_time</span></a><span class="special">(</span><span class="identifier">gregorian</span><span class="special">::</span><span class="identifier">greg_year</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
62  <span class="keyword">virtual</span> <span class="identifier">time_duration_type</span> <a class="link" href="custom_time_zone_base.html#id-1_3_14_15_6_3_1_1_1_10_8-bb"><span class="identifier">base_utc_offset</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
63  <span class="keyword">virtual</span> <span class="identifier">time_duration_type</span> <a class="link" href="custom_time_zone_base.html#id-1_3_14_15_6_3_1_1_1_10_9-bb"><span class="identifier">dst_offset</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
64  <span class="keyword">virtual</span> <span class="identifier">string_type</span> <a class="link" href="custom_time_zone_base.html#id-1_3_14_15_6_3_1_1_1_10_10-bb"><span class="identifier">to_posix_string</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
65<span class="special">}</span><span class="special">;</span></pre></div>
66<div class="refsect1">
67<a name="id-1.3.14.15.6.3.3.4"></a><h2>Description</h2>
68<div class="refsect2">
69<a name="id-1.3.14.15.6.3.3.4.2"></a><h3>
70<a name="boost.local_time.custom_time_zone_baseconstruct-copy-destruct"></a><code class="computeroutput">custom_time_zone_base</code>
71        public
72       construct/copy/destruct</h3>
73<div class="orderedlist"><ol class="orderedlist" type="1">
74<li class="listitem"><pre class="literallayout"><a name="id-1_3_14_15_6_3_1_1_1_11-bb"></a><span class="identifier">custom_time_zone_base</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">time_zone_names</span> <span class="special">&amp;</span> zone_names<span class="special">,</span>
75                      <span class="keyword">const</span> <span class="identifier">time_duration_type</span> <span class="special">&amp;</span> utc_offset<span class="special">,</span>
76                      <span class="keyword">const</span> <span class="identifier">dst_adjustment_offsets</span> <span class="special">&amp;</span> dst_shift<span class="special">,</span>
77                      <span class="identifier">boost</span><span class="special">::</span><span class="identifier">shared_ptr</span><span class="special">&lt;</span> <span class="identifier">dst_calc_rule</span> <span class="special">&gt;</span> calc_rule<span class="special">)</span><span class="special">;</span></pre></li>
78<li class="listitem"><pre class="literallayout"><a name="id-1_3_14_15_6_3_1_1_1_12-bb"></a><span class="special">~</span><span class="identifier">custom_time_zone_base</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
79</ol></div>
80</div>
81<div class="refsect2">
82<a name="id-1.3.14.15.6.3.3.4.3"></a><h3>
83<a name="id-1_3_14_15_6_3_1_1_1_10-bb"></a><code class="computeroutput">custom_time_zone_base</code> public member functions</h3>
84<div class="orderedlist"><ol class="orderedlist" type="1">
85<li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">string_type</span> <a name="id-1_3_14_15_6_3_1_1_1_10_1-bb"></a><span class="identifier">dst_zone_abbrev</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
86<li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">string_type</span> <a name="id-1_3_14_15_6_3_1_1_1_10_2-bb"></a><span class="identifier">std_zone_abbrev</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
87<li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">string_type</span> <a name="id-1_3_14_15_6_3_1_1_1_10_3-bb"></a><span class="identifier">dst_zone_name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
88<li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">string_type</span> <a name="id-1_3_14_15_6_3_1_1_1_10_4-bb"></a><span class="identifier">std_zone_name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
89<li class="listitem">
90<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="id-1_3_14_15_6_3_1_1_1_10_5-bb"></a><span class="identifier">has_dst</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>True if zone uses daylight savings adjustments. </li>
91<li class="listitem">
92<pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <a name="id-1_3_14_15_6_3_1_1_1_10_6-bb"></a><span class="identifier">dst_local_start_time</span><span class="special">(</span><span class="identifier">gregorian</span><span class="special">::</span><span class="identifier">greg_year</span> y<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Local time that DST starts – NADT if has_dst is false. </li>
93<li class="listitem">
94<pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <a name="id-1_3_14_15_6_3_1_1_1_10_7-bb"></a><span class="identifier">dst_local_end_time</span><span class="special">(</span><span class="identifier">gregorian</span><span class="special">::</span><span class="identifier">greg_year</span> y<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Local time that DST ends – NADT if has_dst is false. </li>
95<li class="listitem">
96<pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">time_duration_type</span> <a name="id-1_3_14_15_6_3_1_1_1_10_8-bb"></a><span class="identifier">base_utc_offset</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Base offset from UTC for zone (eg: -07:30:00) </li>
97<li class="listitem">
98<pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">time_duration_type</span> <a name="id-1_3_14_15_6_3_1_1_1_10_9-bb"></a><span class="identifier">dst_offset</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Adjustment forward or back made while DST is in effect. </li>
99<li class="listitem">
100<pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">string_type</span> <a name="id-1_3_14_15_6_3_1_1_1_10_10-bb"></a><span class="identifier">to_posix_string</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns a POSIX time_zone string for this object. </li>
101</ol></div>
102</div>
103</div>
104</div>
105<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
106<td align="left"></td>
107<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
108    <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>
109</div></td>
110</tr></table>
111<hr>
112<div class="spirit-nav">
113<a accesskey="p" href="../serialization/load_1_3_14_15_5_16_1_1_11.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.local_time.custom_time_zone_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="operat_1_3_14_15_6_4_2_1_1.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
114</div>
115</body>
116</html>
117