Google Git
Sign in
nest-open-source / nest-learning-thermostat / 5.0 / boost / 317601cb979f96545d0e892ce7cfdf59f676ee0a / . / boost_1_45_0 / doc / html / boost / date_time / months_duration.html
blob: 91206e2646b02bf77f6153d139fcf592e2455f85 [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template months_duration</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_duration_types_hpp" title="Header &lt;boost/date_time/date_duration_types.hpp&gt;">
<link rel="prev" href="weeks_duration.html" title="Class template weeks_duration">
<link rel="next" href="years_duration.html" title="Class template years_duration">
</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="weeks_duration.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.date_duration_types_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="years_duration.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.date_time.months_duration"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template months_duration</span></h2>
<p>boost::date_time::months_duration &#8212; additional duration type that represents a logical month </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: &lt;<a class="link" href="../../date_time/doxy.html#header.boost.date_time.date_duration_types_hpp" title="Header &lt;boost/date_time/date_duration_types.hpp&gt;">boost/date_time/date_duration_types.hpp</a>&gt;
</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> base_config<span class="special">&gt;</span>
<span class="keyword">class</span> <a class="link" href="months_duration.html" title="Class template months_duration">months_duration</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
<span class="comment">// <a class="link" href="months_duration.html#boost.date_time.months_durationconstruct-copy-destruct">construct/copy/destruct</a></span>
<a class="link" href="months_duration.html#id368742-bb"><span class="identifier">months_duration</span></a><span class="special">(</span><span class="identifier">int_rep</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="months_duration.html#id368748-bb"><span class="identifier">months_duration</span></a><span class="special">(</span><span class="identifier">special_values</span><span class="special">)</span><span class="special">;</span>
<span class="comment">// <a class="link" href="months_duration.html#id403043-bb">public member functions</a></span>
<span class="identifier">int_rep</span> <a class="link" href="months_duration.html#id403047-bb"><span class="identifier">number_of_months</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">duration_type</span> <a class="link" href="months_duration.html#id403055-bb"><span class="identifier">get_neg_offset</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="special">;</span>
<span class="identifier">duration_type</span> <a class="link" href="months_duration.html#id412475-bb"><span class="identifier">get_offset</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="special">;</span>
<span class="keyword">bool</span> <a class="link" href="months_duration.html#id387810-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> months_type <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">bool</span> <a class="link" href="months_duration.html#id320749-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> months_type <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
months_type <a class="link" href="months_duration.html#id320766-bb"><span class="keyword">operator</span><span class="special">+</span></a><span class="special">(</span><span class="keyword">const</span> months_type <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
months_type <span class="special">&amp;</span> <a class="link" href="months_duration.html#id320785-bb"><span class="keyword">operator</span><span class="special">+=</span></a><span class="special">(</span><span class="keyword">const</span> months_type <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
months_type <a class="link" href="months_duration.html#id320804-bb"><span class="keyword">operator</span><span class="special">-</span></a><span class="special">(</span><span class="keyword">const</span> months_type <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
months_type <span class="special">&amp;</span> <a class="link" href="months_duration.html#id320822-bb"><span class="keyword">operator</span><span class="special">-=</span></a><span class="special">(</span><span class="keyword">const</span> months_type <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
months_type <a class="link" href="months_duration.html#id403265-bb"><span class="keyword">operator</span><span class="special">*</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">int_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
months_type <span class="special">&amp;</span> <a class="link" href="months_duration.html#id403279-bb"><span class="keyword">operator</span><span class="special">*=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">int_type</span><span class="special">)</span><span class="special">;</span>
months_type <a class="link" href="months_duration.html#id403295-bb"><span class="keyword">operator</span><span class="special">/</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">int_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
months_type <span class="special">&amp;</span> <a class="link" href="months_duration.html#id358810-bb"><span class="keyword">operator</span><span class="special">/=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">int_type</span><span class="special">)</span><span class="special">;</span>
months_type <a class="link" href="months_duration.html#id391262-bb"><span class="keyword">operator</span><span class="special">+</span></a><span class="special">(</span><span class="keyword">const</span> years_type <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
months_type <span class="special">&amp;</span> <a class="link" href="months_duration.html#id391280-bb"><span class="keyword">operator</span><span class="special">+=</span></a><span class="special">(</span><span class="keyword">const</span> years_type <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
months_type <a class="link" href="months_duration.html#id467972-bb"><span class="keyword">operator</span><span class="special">-</span></a><span class="special">(</span><span class="keyword">const</span> years_type <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
months_type <span class="special">&amp;</span> <a class="link" href="months_duration.html#id368722-bb"><span class="keyword">operator</span><span class="special">-=</span></a><span class="special">(</span><span class="keyword">const</span> years_type <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="id1069913"></a><h2>Description</h2>
<p>A logical month enables things like: "date(2002,Mar,2) + months(2) -&gt; 2002-May2". If the date is a last day-of-the-month, the result will also be a last-day-of-the-month. </p>
<div class="refsect2">
<a name="id1069918"></a><h3>
<a name="boost.date_time.months_durationconstruct-copy-destruct"></a><code class="computeroutput">months_duration</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><pre class="literallayout"><a name="id368742-bb"></a><span class="identifier">months_duration</span><span class="special">(</span><span class="identifier">int_rep</span> num<span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><a name="id368748-bb"></a><span class="identifier">months_duration</span><span class="special">(</span><span class="identifier">special_values</span> sv<span class="special">)</span><span class="special">;</span></pre></li>
</ol></div>
</div>
<div class="refsect2">
<a name="id1070016"></a><h3>
<a name="id403043-bb"></a><code class="computeroutput">months_duration</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><pre class="literallayout"><span class="identifier">int_rep</span> <a name="id403047-bb"></a><span class="identifier">number_of_months</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">duration_type</span> <a name="id403055-bb"></a><span class="identifier">get_neg_offset</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="special">;</span></pre>returns a negative duration </li>
<li class="listitem"><pre class="literallayout"><span class="identifier">duration_type</span> <a name="id412475-bb"></a><span class="identifier">get_offset</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="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="id387810-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> months_type <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="id320749-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> months_type <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout">months_type <a name="id320766-bb"></a><span class="keyword">operator</span><span class="special">+</span><span class="special">(</span><span class="keyword">const</span> months_type <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout">months_type <span class="special">&amp;</span> <a name="id320785-bb"></a><span class="keyword">operator</span><span class="special">+=</span><span class="special">(</span><span class="keyword">const</span> months_type <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout">months_type <a name="id320804-bb"></a><span class="keyword">operator</span><span class="special">-</span><span class="special">(</span><span class="keyword">const</span> months_type <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout">months_type <span class="special">&amp;</span> <a name="id320822-bb"></a><span class="keyword">operator</span><span class="special">-=</span><span class="special">(</span><span class="keyword">const</span> months_type <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout">months_type <a name="id403265-bb"></a><span class="keyword">operator</span><span class="special">*</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">int_type</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout">months_type <span class="special">&amp;</span> <a name="id403279-bb"></a><span class="keyword">operator</span><span class="special">*=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">int_type</span> rhs<span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout">months_type <a name="id403295-bb"></a><span class="keyword">operator</span><span class="special">/</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">int_type</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout">months_type <span class="special">&amp;</span> <a name="id358810-bb"></a><span class="keyword">operator</span><span class="special">/=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">int_type</span> rhs<span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout">months_type <a name="id391262-bb"></a><span class="keyword">operator</span><span class="special">+</span><span class="special">(</span><span class="keyword">const</span> years_type <span class="special">&amp;</span> y<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout">months_type <span class="special">&amp;</span> <a name="id391280-bb"></a><span class="keyword">operator</span><span class="special">+=</span><span class="special">(</span><span class="keyword">const</span> years_type <span class="special">&amp;</span> y<span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout">months_type <a name="id467972-bb"></a><span class="keyword">operator</span><span class="special">-</span><span class="special">(</span><span class="keyword">const</span> years_type <span class="special">&amp;</span> y<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout">months_type <span class="special">&amp;</span> <a name="id368722-bb"></a><span class="keyword">operator</span><span class="special">-=</span><span class="special">(</span><span class="keyword">const</span> years_type <span class="special">&amp;</span> y<span class="special">)</span><span class="special">;</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"><div class="copyright-footer">Copyright &#169; 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="weeks_duration.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.date_duration_types_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="years_duration.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>