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>Struct template us_dst_trait</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_timezone_defs_hpp" title="Header <boost/date_time/local_timezone_defs.hpp>"> 10<link rel="prev" href="uk_dst_trait.html" title="Struct template uk_dst_trait"> 11<link rel="next" href="microsec_clock.html" title="Class template microsec_clock"> 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="uk_dst_trait.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.local_timezone_defs_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="microsec_clock.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.date_time.us_dst_trait"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Struct template us_dst_trait</span></h2> 30<p>boost::date_time::us_dst_trait — Specification for daylight savings start rules in US. </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_timezone_defs_hpp" title="Header <boost/date_time/local_timezone_defs.hpp>">boost/date_time/local_timezone_defs.hpp</a>> 34 35</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> date_type<span class="special">></span> 36<span class="keyword">struct</span> <a class="link" href="us_dst_trait.html" title="Struct template us_dst_trait">us_dst_trait</a> <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">day_of_week_type</span> <a name="boost.date_time.us_dst_trait.day_of_week_type"></a><span class="identifier">day_of_week_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">month_type</span> <a name="boost.date_time.us_dst_trait.month_type"></a><span class="identifier">month_type</span><span class="special">;</span> 40 <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.us_dst_trait.year_type"></a><span class="identifier">year_type</span><span class="special">;</span> 41 <span class="keyword">typedef</span> <a class="link" href="nth_kday_of_month.html" title="Class template nth_kday_of_month">date_time::nth_kday_of_month</a><span class="special"><</span> <span class="identifier">date_type</span> <span class="special">></span> <a name="boost.date_time.us_dst_trait.start_rule_functor"></a><span class="identifier">start_rule_functor</span><span class="special">;</span> 42 <span class="keyword">typedef</span> <a class="link" href="first_kday_of_month.html" title="Class template first_kday_of_month">date_time::first_kday_of_month</a><span class="special"><</span> <span class="identifier">date_type</span> <span class="special">></span> <a name="boost.date_time.us_dst_trait.end_rule_functor"></a><span class="identifier">end_rule_functor</span><span class="special">;</span> 43 <span class="keyword">typedef</span> <a class="link" href="first_kday_of_month.html" title="Class template first_kday_of_month">date_time::first_kday_of_month</a><span class="special"><</span> <span class="identifier">date_type</span> <span class="special">></span> <a name="boost.date_time.us_dst_trait.start_rule_functor_pre2007"></a><span class="identifier">start_rule_functor_pre2007</span><span class="special">;</span> 44 <span class="keyword">typedef</span> <a class="link" href="last_kday_of_month.html" title="Class template last_kday_of_month">date_time::last_kday_of_month</a><span class="special"><</span> <span class="identifier">date_type</span> <span class="special">></span> <a name="boost.date_time.us_dst_trait.end_rule_functor_pre2007"></a><span class="identifier">end_rule_functor_pre2007</span><span class="special">;</span> 45 46 <span class="comment">// <a class="link" href="us_dst_trait.html#id-1_3_14_15_3_32_1_1_4_11-bb">public static functions</a></span> 47 <span class="keyword">static</span> <span class="identifier">day_of_week_type</span> <a class="link" href="us_dst_trait.html#id-1_3_14_15_3_32_1_1_4_11_1-bb"><span class="identifier">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">month_type</span> <a class="link" href="us_dst_trait.html#id-1_3_14_15_3_32_1_1_4_11_2-bb"><span class="identifier">start_month</span></a><span class="special">(</span><span class="identifier">year_type</span><span class="special">)</span><span class="special">;</span> 49 <span class="keyword">static</span> <span class="identifier">day_of_week_type</span> <a class="link" href="us_dst_trait.html#id-1_3_14_15_3_32_1_1_4_11_3-bb"><span class="identifier">end_day</span></a><span class="special">(</span><span class="identifier">year_type</span><span class="special">)</span><span class="special">;</span> 50 <span class="keyword">static</span> <span class="identifier">month_type</span> <a class="link" href="us_dst_trait.html#id-1_3_14_15_3_32_1_1_4_11_4-bb"><span class="identifier">end_month</span></a><span class="special">(</span><span class="identifier">year_type</span><span class="special">)</span><span class="special">;</span> 51 <span class="keyword">static</span> <span class="identifier">date_type</span> <a class="link" href="us_dst_trait.html#id-1_3_14_15_3_32_1_1_4_11_5-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> 52 <span class="keyword">static</span> <span class="identifier">date_type</span> <a class="link" href="us_dst_trait.html#id-1_3_14_15_3_32_1_1_4_11_6-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> 53 <span class="keyword">static</span> <span class="keyword">int</span> <a class="link" href="us_dst_trait.html#id-1_3_14_15_3_32_1_1_4_11_7-bb"><span class="identifier">dst_start_offset_minutes</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 54 <span class="keyword">static</span> <span class="keyword">int</span> <a class="link" href="us_dst_trait.html#id-1_3_14_15_3_32_1_1_4_11_8-bb"><span class="identifier">dst_end_offset_minutes</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 55 <span class="keyword">static</span> <span class="keyword">int</span> <a class="link" href="us_dst_trait.html#id-1_3_14_15_3_32_1_1_4_11_9-bb"><span class="identifier">dst_shift_length_minutes</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 56<span class="special">}</span><span class="special">;</span></pre></div> 57<div class="refsect1"> 58<a name="id-1.3.14.15.3.32.6.4"></a><h2>Description</h2> 59<p>This class is used to configure <a class="link" href="dst_calc_engine.html" title="Class template dst_calc_engine">dst_calc_engine</a> template typically as follows: </p> 60<pre class="programlisting"><span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">gregorian</span><span class="special">;</span> 61<span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">;</span> 62<span class="keyword">typedef</span> <span class="identifier">us_dst_trait</span><span class="special"><</span><span class="identifier">date</span><span class="special">></span> <span class="identifier">us_dst_traits</span><span class="special">;</span> 63<span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">date_time</span><span class="special">::</span><span class="identifier">dst_calc_engine</span><span class="special"><</span><span class="identifier">date</span><span class="special">,</span> <span class="identifier">time_duration</span><span class="special">,</span> 64 <span class="identifier">us_dst_traits</span><span class="special">></span> 65 <span class="identifier">us_dst_calc</span><span class="special">;</span> 66<span class="comment">//calculate the 2002 transition day of USA April 7 2002</span> 67<span class="identifier">date</span> <span class="identifier">dst_start</span> <span class="special">=</span> <span class="identifier">us_dst_calc</span><span class="special">::</span><span class="identifier">local_dst_start_day</span><span class="special">(</span><span class="number">2002</span><span class="special">)</span><span class="special">;</span> 68 69<span class="comment">//calculate the 2002 transition day of USA Oct 27 2002</span> 70<span class="identifier">date</span> <span class="identifier">dst_end</span> <span class="special">=</span> <span class="identifier">us_dst_calc</span><span class="special">::</span><span class="identifier">local_dst_end_day</span><span class="special">(</span><span class="number">2002</span><span class="special">)</span><span class="special">;</span> 71 72<span class="comment">//check if a local time is in dst or not -- posible answers</span> 73<span class="comment">//are yes, no, invalid time label, ambiguous</span> 74<span class="identifier">ptime</span> <span class="identifier">t</span><span class="special">(</span><span class="special">...</span><span class="identifier">some</span> <span class="identifier">time</span><span class="special">...</span><span class="special">)</span><span class="special">;</span> 75<span class="keyword">if</span> <span class="special">(</span><span class="identifier">us_dst</span><span class="special">::</span><span class="identifier">local_is_dst</span><span class="special">(</span><span class="identifier">t</span><span class="special">.</span><span class="identifier">date</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="identifier">t</span><span class="special">.</span><span class="identifier">time_of_day</span><span class="special">(</span><span class="special">)</span><span class="special">)</span> 76 <span class="special">==</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">date_time</span><span class="special">::</span><span class="identifier">is_not_in_dst</span><span class="special">)</span> 77<span class="special">{</span> 78 79<span class="special">}</span> 80</pre> 81<p> This generates a type suitable for the calculation of dst transitions for the United States. Of course other templates can be used for other locales. </p> 82<div class="refsect2"> 83<a name="id-1.3.14.15.3.32.6.4.3"></a><h3> 84<a name="id-1_3_14_15_3_32_1_1_4_11-bb"></a><code class="computeroutput">us_dst_trait</code> public static functions</h3> 85<div class="orderedlist"><ol class="orderedlist" type="1"> 86<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">day_of_week_type</span> <a name="id-1_3_14_15_3_32_1_1_4_11_1-bb"></a><span class="identifier">start_day</span><span class="special">(</span><span class="identifier">year_type</span><span class="special">)</span><span class="special">;</span></pre></li> 87<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">month_type</span> <a name="id-1_3_14_15_3_32_1_1_4_11_2-bb"></a><span class="identifier">start_month</span><span class="special">(</span><span class="identifier">year_type</span> y<span class="special">)</span><span class="special">;</span></pre></li> 88<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">day_of_week_type</span> <a name="id-1_3_14_15_3_32_1_1_4_11_3-bb"></a><span class="identifier">end_day</span><span class="special">(</span><span class="identifier">year_type</span><span class="special">)</span><span class="special">;</span></pre></li> 89<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">month_type</span> <a name="id-1_3_14_15_3_32_1_1_4_11_4-bb"></a><span class="identifier">end_month</span><span class="special">(</span><span class="identifier">year_type</span> y<span class="special">)</span><span class="special">;</span></pre></li> 90<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">date_type</span> <a name="id-1_3_14_15_3_32_1_1_4_11_5-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> 91<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">date_type</span> <a name="id-1_3_14_15_3_32_1_1_4_11_6-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> 92<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">int</span> <a name="id-1_3_14_15_3_32_1_1_4_11_7-bb"></a><span class="identifier">dst_start_offset_minutes</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> 93<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">int</span> <a name="id-1_3_14_15_3_32_1_1_4_11_8-bb"></a><span class="identifier">dst_end_offset_minutes</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> 94<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">int</span> <a name="id-1_3_14_15_3_32_1_1_4_11_9-bb"></a><span class="identifier">dst_shift_length_minutes</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> 95</ol></div> 96</div> 97</div> 98</div> 99<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 100<td align="left"></td> 101<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 102 <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> 103</div></td> 104</tr></table> 105<hr> 106<div class="spirit-nav"> 107<a accesskey="p" href="uk_dst_trait.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.local_timezone_defs_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="microsec_clock.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 108</div> 109</body> 110</html> 111
