| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>Class template first_kday_of_month</title> |
| <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> |
| <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> |
| <link rel="up" href="../../date_time/doxy.html#header.boost.date_time.date_generators_hpp" title="Header <boost/date_time/date_generators.hpp>"> |
| <link rel="prev" href="nth_kday_of_month.html" title="Class template nth_kday_of_month"> |
| <link rel="next" href="last_kday_of_month.html" title="Class template last_kday_of_month"> |
| </head> |
| <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| <table cellpadding="2" width="100%"><tr> |
| <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> |
| <td align="center"><a href="../../../../index.html">Home</a></td> |
| <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> |
| <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> |
| <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> |
| <td align="center"><a href="../../../../more/index.htm">More</a></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="nth_kday_of_month.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.date_generators_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="last_kday_of_month.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| <div class="refentry"> |
| <a name="boost.date_time.first_kday_of_month"></a><div class="titlepage"></div> |
| <div class="refnamediv"> |
| <h2><span class="refentrytitle">Class template first_kday_of_month</span></h2> |
| <p>boost::date_time::first_kday_of_month — Useful generator functor for finding holidays and daylight savings. </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="comment">// In header: <<a class="link" href="../../date_time/doxy.html#header.boost.date_time.date_generators_hpp" title="Header <boost/date_time/date_generators.hpp>">boost/date_time/date_generators.hpp</a>> |
| |
| </span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> date_type<span class="special">></span> |
| <span class="keyword">class</span> <a class="link" href="first_kday_of_month.html" title="Class template first_kday_of_month">first_kday_of_month</a> <span class="special">:</span> |
| <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">date_time</span><span class="special">::</span><span class="identifier">year_based_generator</span><span class="special"><</span> <span class="identifier">date_type</span> <span class="special">></span> |
| <span class="special">{</span> |
| <span class="keyword">public</span><span class="special">:</span> |
| <span class="comment">// types</span> |
| <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.first_kday_of_month.calendar_type"></a><span class="identifier">calendar_type</span><span class="special">;</span> |
| <span class="keyword">typedef</span> <span class="identifier">calendar_type</span><span class="special">::</span><span class="identifier">day_of_week_type</span> <a name="boost.date_time.first_kday_of_month.day_of_week_type"></a><span class="identifier">day_of_week_type</span><span class="special">;</span> |
| <span class="keyword">typedef</span> <span class="identifier">calendar_type</span><span class="special">::</span><span class="identifier">month_type</span> <a name="boost.date_time.first_kday_of_month.month_type"></a><span class="identifier">month_type</span><span class="special">;</span> |
| <span class="keyword">typedef</span> <span class="identifier">calendar_type</span><span class="special">::</span><span class="identifier">year_type</span> <a name="boost.date_time.first_kday_of_month.year_type"></a><span class="identifier">year_type</span><span class="special">;</span> |
| <span class="keyword">typedef</span> <span class="identifier">date_type</span><span class="special">::</span><span class="identifier">duration_type</span> <a name="boost.date_time.first_kday_of_month.duration_type"></a><span class="identifier">duration_type</span><span class="special">;</span> |
| |
| <span class="comment">// <a class="link" href="first_kday_of_month.html#boost.date_time.first_kday_of_monthconstruct-copy-destruct">construct/copy/destruct</a></span> |
| <a class="link" href="first_kday_of_month.html#id368574-bb"><span class="identifier">first_kday_of_month</span></a><span class="special">(</span><span class="identifier">day_of_week_type</span><span class="special">,</span> <span class="identifier">month_type</span><span class="special">)</span><span class="special">;</span> |
| |
| <span class="comment">// <a class="link" href="first_kday_of_month.html#id373454-bb">public member functions</a></span> |
| <span class="identifier">date_type</span> <a class="link" href="first_kday_of_month.html#id373457-bb"><span class="identifier">get_date</span></a><span class="special">(</span><span class="identifier">year_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> |
| <span class="identifier">month_type</span> <a class="link" href="first_kday_of_month.html#id373474-bb"><span class="identifier">month</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> |
| <span class="identifier">day_of_week_type</span> <a class="link" href="first_kday_of_month.html#id373482-bb"><span class="identifier">day_of_week</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> |
| <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="first_kday_of_month.html#id370438-bb"><span class="identifier">to_string</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> |
| <span class="special">}</span><span class="special">;</span></pre></div> |
| <div class="refsect1"> |
| <a name="id1104708"></a><h2>Description</h2> |
| <p>Similar to nth_kday_of_month, but requires less paramters </p> |
| <div class="refsect2"> |
| <a name="id1104714"></a><h3> |
| <a name="boost.date_time.first_kday_of_monthconstruct-copy-destruct"></a><code class="computeroutput">first_kday_of_month</code> |
| public |
| construct/copy/destruct</h3> |
| <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> |
| <pre class="literallayout"><a name="id368574-bb"></a><span class="identifier">first_kday_of_month</span><span class="special">(</span><span class="identifier">day_of_week_type</span> dow<span class="special">,</span> <span class="identifier">month_type</span> m<span class="special">)</span><span class="special">;</span></pre>Specify the first 'Sunday' in 'April' spec. <p> |
| </p> |
| <div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody><tr> |
| <td><p><span class="term">Parameters:</span></p></td> |
| <td><div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody> |
| <tr> |
| <td><p><span class="term"><code class="computeroutput">dow</code></span></p></td> |
| <td><p>The day of week, eg: Sunday, Monday, etc </p></td> |
| </tr> |
| <tr> |
| <td><p><span class="term"><code class="computeroutput">m</code></span></p></td> |
| <td><p>The month of the year, eg: Jan, Feb, Mar, etc </p></td> |
| </tr> |
| </tbody> |
| </table></div></td> |
| </tr></tbody> |
| </table></div> |
| </li></ol></div> |
| </div> |
| <div class="refsect2"> |
| <a name="id1104823"></a><h3> |
| <a name="id373454-bb"></a><code class="computeroutput">first_kday_of_month</code> public member functions</h3> |
| <div class="orderedlist"><ol class="orderedlist" type="1"> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="identifier">date_type</span> <a name="id373457-bb"></a><span class="identifier">get_date</span><span class="special">(</span><span class="identifier">year_type</span> year<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Return a concrete date when provided with a year specific year. </li> |
| <li class="listitem"><pre class="literallayout"><span class="identifier">month_type</span> <a name="id373474-bb"></a><span class="identifier">month</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> |
| <li class="listitem"><pre class="literallayout"><span class="identifier">day_of_week_type</span> <a name="id373482-bb"></a><span class="identifier">day_of_week</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="id370438-bb"></a><span class="identifier">to_string</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns string suitable for use in POSIX time zone string. <p>Returns a string formatted as "M4.1.0" ==> 1st Sunday in April. </p> |
| </li> |
| </ol></div> |
| </div> |
| </div> |
| </div> |
| <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> |
| <td align="left"></td> |
| <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 |
| <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> |
| </div></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="nth_kday_of_month.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.date_generators_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="last_kday_of_month.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| </body> |
| </html> |