doc/html/boost/date_time/dst_calc_engine.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template dst_calc_engine</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <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;">
   9 <link rel="prev" href="dst_calculator.html" title="Class template dst_calculator">
  10 <link rel="next" href="us_dst_rules.html" title="Class template us_dst_rules">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="dst_calculator.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="us_dst_rules.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.date_time.dst_calc_engine"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template dst_calc_engine</span></h2>
  29 <p>boost::date_time::dst_calc_engine &#8212; Compile-time configurable daylight savings time calculation engine. </p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <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;
  33
  34 </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">,</span> <span class="keyword">typename</span> dst_traits<span class="special">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="dst_calc_engine.html" title="Class template dst_calc_engine">dst_calc_engine</a> <span class="special">{</span>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// types</span>
  38   <span class="keyword">typedef</span> <span class="identifier">date_type</span><span class="special">::</span><span class="identifier">year_type</span>                            <a name="boost.date_time.dst_calc_engine.year_type"></a><span class="identifier">year_type</span><span class="special">;</span>
  39   <span class="keyword">typedef</span> <span class="identifier">date_type</span><span class="special">::</span><span class="identifier">calendar_type</span>                        <a name="boost.date_time.dst_calc_engine.calendar_type"></a><span class="identifier">calendar_type</span><span class="special">;</span>
  40   <span class="keyword">typedef</span> <a class="link" href="dst_calculator.html" title="Class template dst_calculator">dst_calculator</a><span class="special">&lt;</span> <span class="identifier">date_type</span><span class="special">,</span> <span class="identifier">time_duration_type</span> <span class="special">&gt;</span> <a name="boost.date_time.dst_calc_engine.dstcalc"></a><span class="identifier">dstcalc</span><span class="special">;</span>
  41
  42   <span class="comment">// <a class="link" href="dst_calc_engine.html#idp105581440-bb">public static functions</a></span>
  43   <span class="keyword">static</span> <span class="identifier">time_is_dst_result</span>
  44   <a class="link" href="dst_calc_engine.html#idp105582000-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="special">;</span>
  45   <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="dst_calc_engine.html#idp103918576-bb"><span class="identifier">is_dst_boundary_day</span></a><span class="special">(</span><span class="identifier">date_type</span><span class="special">)</span><span class="special">;</span>
  46   <span class="keyword">static</span> <span class="identifier">time_duration_type</span> <a class="link" href="dst_calc_engine.html#idp52029152-bb"><span class="identifier">dst_offset</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  47   <span class="keyword">static</span> <span class="identifier">date_type</span> <a class="link" href="dst_calc_engine.html#idp97070320-bb"><span class="identifier">local_dst_start_day</span></a><span class="special">(</span><span class="identifier">year_type</span><span class="special">)</span><span class="special">;</span>
  48   <span class="keyword">static</span> <span class="identifier">date_type</span> <a class="link" href="dst_calc_engine.html#idp108335088-bb"><span class="identifier">local_dst_end_day</span></a><span class="special">(</span><span class="identifier">year_type</span><span class="special">)</span><span class="special">;</span>
  49 <span class="special">}</span><span class="special">;</span></pre></div>
  50 <div class="refsect1">
  51 <a name="idp189488608"></a><h2>Description</h2>
  52 <div class="refsect2">
  53 <a name="idp189489024"></a><h3>
  54 <a name="idp105581440-bb"></a><code class="computeroutput">dst_calc_engine</code> public static functions</h3>
  55 <div class="orderedlist"><ol class="orderedlist" type="1">
  56 <li class="listitem">
  57 <pre class="literallayout"><span class="keyword">static</span> <span class="identifier">time_is_dst_result</span>
  58 <a name="idp105582000-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> d<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">time_duration_type</span> <span class="special">&amp;</span> td<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.
  59 </p>
  60 </li>
  61 <li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp103918576-bb"></a><span class="identifier">is_dst_boundary_day</span><span class="special">(</span><span class="identifier">date_type</span> d<span class="special">)</span><span class="special">;</span></pre></li>
  62 <li class="listitem">
  63 <pre class="literallayout"><span class="keyword">static</span> <span class="identifier">time_duration_type</span> <a name="idp52029152-bb"></a><span class="identifier">dst_offset</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>The time of day for the dst transition (eg: typically 01:00:00 or 02:00:00) </li>
  64 <li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">date_type</span> <a name="idp97070320-bb"></a><span class="identifier">local_dst_start_day</span><span class="special">(</span><span class="identifier">year_type</span> year<span class="special">)</span><span class="special">;</span></pre></li>
  65 <li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">date_type</span> <a name="idp108335088-bb"></a><span class="identifier">local_dst_end_day</span><span class="special">(</span><span class="identifier">year_type</span> year<span class="special">)</span><span class="special">;</span></pre></li>
  66 </ol></div>
  67 </div>
  68 </div>
  69 </div>
  70 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  71 <td align="left"></td>
  72 <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
  73     <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>
  74 </div></td>
  75 </tr></table>
  76 <hr>
  77 <div class="spirit-nav">
  78 <a accesskey="p" href="dst_calculator.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="us_dst_rules.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  79 </div>
  80 </body>
  81 </html>