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 local_adjustor</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_adjustor_hpp" title="Header <boost/date_time/local_time_adjustor.hpp>"> 10<link rel="prev" href="dynam_1_3_14_15_3_31_2_1_1.html" title="Class template dynamic_local_time_adjustor"> 11<link rel="next" href="static_local_time_adjustor.html" title="Class template static_local_time_adjustor"> 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="dynam_1_3_14_15_3_31_2_1_1.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_adjustor_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="static_local_time_adjustor.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.date_time.local_adjustor"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Class template local_adjustor</span></h2> 30<p>boost::date_time::local_adjustor — Template that simplifies the creation of local time calculator. </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: <<a class="link" href="../../date_time/doxy.html#header.boost.date_time.local_time_adjustor_hpp" title="Header <boost/date_time/local_time_adjustor.hpp>">boost/date_time/local_time_adjustor.hpp</a>> 34 35</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> time_type<span class="special">,</span> <span class="keyword">short</span> utc_offset<span class="special">,</span> <span class="keyword">typename</span> dst_rule<span class="special">></span> 36<span class="keyword">class</span> <a class="link" href="local_adjustor.html" title="Class template local_adjustor">local_adjustor</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">time_type</span><span class="special">::</span><span class="identifier">time_duration_type</span> <a name="boost.date_time.local_adjustor.time_duration_type"></a><span class="identifier">time_duration_type</span><span class="special">;</span> 40 <span class="keyword">typedef</span> <span class="identifier">time_type</span><span class="special">::</span><span class="identifier">date_type</span> <a name="boost.date_time.local_adjustor.date_type"></a><span class="identifier">date_type</span><span class="special">;</span> 41 <span class="keyword">typedef</span> <a class="link" href="static_local_time_adjustor.html" title="Class template static_local_time_adjustor">static_local_time_adjustor</a><span class="special"><</span> <span class="identifier">time_type</span><span class="special">,</span> <span class="identifier">dst_rule</span><span class="special">,</span> <a class="link" href="utc_adjustment.html" title="Class template utc_adjustment">utc_adjustment</a><span class="special"><</span> <span class="identifier">time_duration_type</span><span class="special">,</span> <span class="identifier">utc_offset</span> <span class="special">></span> <span class="special">></span> <a name="boost.date_time.local_adjustor.dst_adjustor"></a><span class="identifier">dst_adjustor</span><span class="special">;</span> 42 43 <span class="comment">// <a class="link" href="local_adjustor.html#id-1_3_14_15_3_31_2_1_2_7-bb">public static functions</a></span> 44 <span class="keyword">static</span> <span class="identifier">time_type</span> <a class="link" href="local_adjustor.html#id-1_3_14_15_3_31_2_1_2_7_1-bb"><span class="identifier">utc_to_local</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">time_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 45 <span class="keyword">static</span> <span class="identifier">time_type</span> 46 <a class="link" href="local_adjustor.html#id-1_3_14_15_3_31_2_1_2_7_2-bb"><span class="identifier">local_to_utc</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">time_type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">date_time</span><span class="special">::</span><span class="identifier">dst_flags</span> <span class="special">=</span> <span class="identifier">date_time</span><span class="special">::</span><span class="identifier">calculate</span><span class="special">)</span><span class="special">;</span> 47<span class="special">}</span><span class="special">;</span></pre></div> 48<div class="refsect1"> 49<a name="id-1.3.14.15.3.31.5.4"></a><h2>Description</h2> 50<p>Use this template to create the timezone to utc convertors as required.</p> 51<p>This class will also work for other regions that don't use dst and have a utc offset which is an integral number of hours.</p> 52<p><span class="bold"><strong>Template Parameters</strong></span> -time_type – Time class to use -utc_offset – Number hours local time is adjust from utc -use_dst – true (default) if region uses dst, false otherwise For example: </p> 53<pre class="programlisting"> <span class="comment">//eastern timezone is utc-5</span> 54<span class="keyword">typedef</span> <span class="identifier">date_time</span><span class="special">::</span><span class="identifier">local_adjustor</span><span class="special"><</span><span class="identifier">ptime</span><span class="special">,</span> <span class="special">-</span><span class="number">5</span><span class="special">,</span> <span class="identifier">us_dst</span><span class="special">></span> <span class="identifier">us_eastern</span><span class="special">;</span> 55<span class="keyword">typedef</span> <span class="identifier">date_time</span><span class="special">::</span><span class="identifier">local_adjustor</span><span class="special"><</span><span class="identifier">ptime</span><span class="special">,</span> <span class="special">-</span><span class="number">6</span><span class="special">,</span> <span class="identifier">us_dst</span><span class="special">></span> <span class="identifier">us_central</span><span class="special">;</span> 56<span class="keyword">typedef</span> <span class="identifier">date_time</span><span class="special">::</span><span class="identifier">local_adjustor</span><span class="special"><</span><span class="identifier">ptime</span><span class="special">,</span> <span class="special">-</span><span class="number">7</span><span class="special">,</span> <span class="identifier">us_dst</span><span class="special">></span> <span class="identifier">us_mountain</span><span class="special">;</span> 57<span class="keyword">typedef</span> <span class="identifier">date_time</span><span class="special">::</span><span class="identifier">local_adjustor</span><span class="special"><</span><span class="identifier">ptime</span><span class="special">,</span> <span class="special">-</span><span class="number">8</span><span class="special">,</span> <span class="identifier">us_dst</span><span class="special">></span> <span class="identifier">us_pacific</span><span class="special">;</span> 58<span class="keyword">typedef</span> <span class="identifier">date_time</span><span class="special">::</span><span class="identifier">local_adjustor</span><span class="special"><</span><span class="identifier">ptime</span><span class="special">,</span> <span class="special">-</span><span class="number">7</span><span class="special">,</span> <span class="identifier">no_dst</span><span class="special">></span> <span class="identifier">us_arizona</span><span class="special">;</span> 59</pre> 60<p> </p> 61<div class="refsect2"> 62<a name="id-1.3.14.15.3.31.5.4.5"></a><h3> 63<a name="id-1_3_14_15_3_31_2_1_2_7-bb"></a><code class="computeroutput">local_adjustor</code> public static functions</h3> 64<div class="orderedlist"><ol class="orderedlist" type="1"> 65<li class="listitem"> 66<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">time_type</span> <a name="id-1_3_14_15_3_31_2_1_2_7_1-bb"></a><span class="identifier">utc_to_local</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">time_type</span> <span class="special">&</span> t<span class="special">)</span><span class="special">;</span></pre>Convert a utc time to local time. </li> 67<li class="listitem"> 68<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">time_type</span> 69<a name="id-1_3_14_15_3_31_2_1_2_7_2-bb"></a><span class="identifier">local_to_utc</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">time_type</span> <span class="special">&</span> t<span class="special">,</span> 70 <span class="identifier">date_time</span><span class="special">::</span><span class="identifier">dst_flags</span> dst <span class="special">=</span> <span class="identifier">date_time</span><span class="special">::</span><span class="identifier">calculate</span><span class="special">)</span><span class="special">;</span></pre>Convert a local time to utc. </li> 71</ol></div> 72</div> 73</div> 74</div> 75<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 76<td align="left"></td> 77<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 78 <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> 79</div></td> 80</tr></table> 81<hr> 82<div class="spirit-nav"> 83<a accesskey="p" href="dynam_1_3_14_15_3_31_2_1_1.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_adjustor_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="static_local_time_adjustor.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 84</div> 85</body> 86</html> 87
