diff options
Diffstat (limited to 'doc/html/month_functor.html')
| -rw-r--r-- | doc/html/month_functor.html | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/doc/html/month_functor.html b/doc/html/month_functor.html new file mode 100644 index 0000000000..c99b7cb1fd --- /dev/null +++ b/doc/html/month_functor.html @@ -0,0 +1,75 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>Class template month_functor</title> +<link rel="stylesheet" href="boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="index.html" title="The Boost C++ Libraries"> +<link rel="up" href="date_time/doxy.html#id797437" title="Header <boost/date_time/adjust_functors.hpp>"> +<link rel="prev" href="day_functor.html" title="Class template day_functor"> +<link rel="next" href="week_functor.html" title="Class template week_functor"> +</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="day_functor.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id797437"><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="week_functor.html"><img src="images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="month_functor"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class template month_functor</span></h2> +<p>boost::date_time::month_functor — Provides calculation to find next nth month given a date. </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> date_type> +<span class="bold"><strong>class</strong></span> month_functor { +<span class="bold"><strong>public</strong></span>: + <span class="emphasis"><em>// types</em></span> + <span class="bold"><strong>typedef</strong></span> date_type::duration_type duration_type; + <span class="bold"><strong>typedef</strong></span> date_type::calendar_type cal_type; + <span class="bold"><strong>typedef</strong></span> cal_type::ymd_type ymd_type; + <span class="bold"><strong>typedef</strong></span> cal_type::day_type day_type; + + <span class="emphasis"><em>// <a href="month_functor.html#month_functorconstruct-copy-destruct">construct/copy/destruct</a></em></span> + <a href="month_functor.html#id793432-bb">month_functor</a>(<span class="bold"><strong>int</strong></span>); + + <span class="emphasis"><em>// <a href="month_functor.html#id961825-bb">public member functions</a></em></span> + <span class="type">duration_type</span> <a href="month_functor.html#id861542-bb">get_offset</a>(<span class="bold"><strong>const</strong></span> date_type &) <span class="bold"><strong>const</strong></span>; + <span class="type">duration_type</span> <a href="month_functor.html#id829839-bb">get_neg_offset</a>(<span class="bold"><strong>const</strong></span> date_type &) <span class="bold"><strong>const</strong></span>; +};</pre></div> +<div class="refsect1" lang="en"> +<a name="id1038507"></a><h2>Description</h2> +<p>This adjustment function provides the logic for 'month-based' advancement on a ymd based calendar. The policy it uses to handle the non existant end of month days is to back up to the last day of the month. Also, if the starting date is the last day of a month, this functor will attempt to adjust to the end of the month. </p> +<div class="refsect2" lang="en"> +<a name="id1038518"></a><h3> +<a name="month_functorconstruct-copy-destruct"></a><code class="computeroutput">month_functor</code> construct/copy/destruct</h3> +<div class="orderedlist"><ol type="1"><li><pre class="literallayout"><a name="id793432-bb"></a>month_functor(<span class="bold"><strong>int</strong></span> f);</pre></li></ol></div> +</div> +<div class="refsect2" lang="en"> +<a name="id1038557"></a><h3> +<a name="id961825-bb"></a><code class="computeroutput">month_functor</code> public member functions</h3> +<div class="orderedlist"><ol type="1"> +<li><pre class="literallayout"><span class="type">duration_type</span> <a name="id861542-bb"></a>get_offset(<span class="bold"><strong>const</strong></span> date_type & d) <span class="bold"><strong>const</strong></span>;</pre></li> +<li><pre class="literallayout"><span class="type">duration_type</span> <a name="id829839-bb"></a>get_neg_offset(<span class="bold"><strong>const</strong></span> date_type & d) <span class="bold"><strong>const</strong></span>;</pre></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"><small>Copyright © 2001-2005 CrystalClear Software, Inc</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="day_functor.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id797437"><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="week_functor.html"><img src="images/next.png" alt="Next"></a> +</div> +</body> +</html> |