diff options
Diffstat (limited to 'doc/html/local_adjustor.html')
| -rw-r--r-- | doc/html/local_adjustor.html | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/doc/html/local_adjustor.html b/doc/html/local_adjustor.html new file mode 100644 index 0000000000..fceb5442e5 --- /dev/null +++ b/doc/html/local_adjustor.html @@ -0,0 +1,77 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>Class template local_adjustor</title> +<link rel="stylesheet" href="boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.69.1"> +<link rel="start" href="index.html" title="The Boost C++ Libraries"> +<link rel="up" href="date_time/doxy.html#id2485115" title="Header <boost/date_time/local_time_adjustor.hpp>"> +<link rel="prev" href="static_local_time_adjustor.html" title="Class template static_local_time_adjustor"> +<link rel="next" href="us_dst_trait.html" title="Struct template us_dst_trait"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td> +<td align="center"><a href="../../index.htm">Home</a></td> +<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../people/people.htm">People</a></td> +<td align="center"><a href="../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="static_local_time_adjustor.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id2485115"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="us_dst_trait.html"><img src="images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="local_adjustor"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class template local_adjustor</span></h2> +<p>boost::date_time::local_adjustor — Template that simplifies the creation of local time calculator. </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="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> time_type, <span class="bold"><strong>short</strong></span> utc_offset, <span class="bold"><strong>typename</strong></span> dst_rule> +<span class="bold"><strong>class</strong></span> local_adjustor { +<span class="bold"><strong>public</strong></span>: + <span class="emphasis"><em>// types</em></span> + <span class="bold"><strong>typedef</strong></span> time_type::time_duration_type time_duration_type; + <span class="bold"><strong>typedef</strong></span> time_type::date_type date_type; + <span class="bold"><strong>typedef</strong></span> <a href="static_local_time_adjustor.html" title="Class template static_local_time_adjustor">static_local_time_adjustor</a>< time_type, dst_rule, <a href="utc_adjustment.html" title="Class template utc_adjustment">utc_adjustment</a>< time_duration_type, utc_offset > > dst_adjustor; + + <span class="emphasis"><em>// <a href="local_adjustor.html#id2493207-bb">public static functions</a></em></span> + <span class="type">time_type</span> <a href="local_adjustor.html#id2493211-bb">utc_to_local</a>(<span class="bold"><strong>const</strong></span> time_type &) ; + <span class="type">time_type</span> <a href="local_adjustor.html#id2394631-bb">local_to_utc</a>(<span class="bold"><strong>const</strong></span> time_type &, + date_time::dst_flags = date_time::calculate) ; +};</pre></div> +<div class="refsect1" lang="en"> +<a name="id2643723"></a><h2>Description</h2> +<p>Use this template to create the timezone to utc convertors as required.</p> +<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> +<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> +<pre class="programlisting"> //eastern timezone is utc-5 + typedef date_time::local_adjustor<ptime, -5, us_dst> us_eastern; + typedef date_time::local_adjustor<ptime, -6, us_dst> us_central; + typedef date_time::local_adjustor<ptime, -7, us_dst> us_mountain; + typedef date_time::local_adjustor<ptime, -8, us_dst> us_pacific; + typedef date_time::local_adjustor<ptime, -7, no_dst> us_arizona; +</pre> +<div class="refsect2" lang="en"> +<a name="id2643760"></a><h3> +<a name="id2493207-bb"></a><code class="computeroutput">local_adjustor</code> public static functions</h3> +<div class="orderedlist"><ol type="1"> +<li><pre class="literallayout"><span class="type">time_type</span> <a name="id2493211-bb"></a>utc_to_local(<span class="bold"><strong>const</strong></span> time_type & t) ;</pre></li> +<li><pre class="literallayout"><span class="type">time_type</span> <a name="id2394631-bb"></a>local_to_utc(<span class="bold"><strong>const</strong></span> time_type & t, + date_time::dst_flags dst = date_time::calculate) ;</pre></li> +</ol></div> +</div> +</div> +</div> +<table width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2001-2005 CrystalClear Software, Inc</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="static_local_time_adjustor.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id2485115"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="us_dst_trait.html"><img src="images/next.png" alt="Next"></a> +</div> +</body> +</html> |