<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template years_duration</title>
<link rel="stylesheet" href="../../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 <boost/date_time/date_duration_types.hpp>">
<link rel="prev" href="months_duration.html" title="Class template months_duration">
<link rel="next" href="date_facet.html" title="Class template date_facet">
</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="months_duration.html"><img src="../../../../doc/html/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/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="date_facet.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="refentry" title="Class template years_duration">
<a name="boost.date_time.years_duration"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template years_duration</span></h2>
<p>boost::date_time::years_duration — additional duration type that represents a logical year </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="emphasis"><em>// In header: <<a class="link" href="../../date_time/doxy.html#header.boost.date_time.date_duration_types_hpp" title="Header <boost/date_time/date_duration_types.hpp>">boost/date_time/date_duration_types.hpp</a>>
</em></span><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> base_config>
<span class="bold"><strong>class</strong></span> <a class="link" href="years_duration.html" title="Class template years_duration">years_duration</a> {
<span class="bold"><strong>public</strong></span>:
<span class="emphasis"><em>// <a class="link" href="years_duration.html#boost.date_time.years_durationconstruct-copy-destruct">construct/copy/destruct</a></em></span>
<a class="link" href="years_duration.html#id397202-bb">years_duration</a>(int_rep);
<a class="link" href="years_duration.html#id397209-bb">years_duration</a>(special_values);
<span class="emphasis"><em>// <a class="link" href="years_duration.html#id578148-bb">public member functions</a></em></span>
<span class="type">int_rep</span> <a class="link" href="years_duration.html#id331727-bb">number_of_years</a>() <span class="bold"><strong>const</strong></span>;
<span class="type">duration_type</span> <a class="link" href="years_duration.html#id331734-bb">get_neg_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 class="link" href="years_duration.html#id331750-bb">get_offset</a>(<span class="bold"><strong>const</strong></span> date_type &) <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>bool</strong></span></span> <a class="link" href="years_duration.html#id344232-bb"><span class="bold"><strong>operator</strong></span>==</a>(<span class="bold"><strong>const</strong></span> years_type &) <span class="bold"><strong>const</strong></span>;
<span class="type"><span class="bold"><strong>bool</strong></span></span> <a class="link" href="years_duration.html#id344249-bb"><span class="bold"><strong>operator</strong></span>!=</a>(<span class="bold"><strong>const</strong></span> years_type &) <span class="bold"><strong>const</strong></span>;
<span class="type">years_type</span> <a class="link" href="years_duration.html#id348492-bb"><span class="bold"><strong>operator</strong></span>+</a>(<span class="bold"><strong>const</strong></span> years_type &) <span class="bold"><strong>const</strong></span>;
<span class="type">years_type &</span> <a class="link" href="years_duration.html#id348510-bb"><span class="bold"><strong>operator</strong></span>+=</a>(<span class="bold"><strong>const</strong></span> years_type &) ;
<span class="type">years_type</span> <a class="link" href="years_duration.html#id333698-bb"><span class="bold"><strong>operator</strong></span>-</a>(<span class="bold"><strong>const</strong></span> years_type &) <span class="bold"><strong>const</strong></span>;
<span class="type">years_type &</span> <a class="link" href="years_duration.html#id333716-bb"><span class="bold"><strong>operator</strong></span>-=</a>(<span class="bold"><strong>const</strong></span> years_type &) ;
<span class="type">years_type</span> <a class="link" href="years_duration.html#id367053-bb"><span class="bold"><strong>operator</strong></span>*</a>(<span class="bold"><strong>const</strong></span> int_type) <span class="bold"><strong>const</strong></span>;
<span class="type">years_type &</span> <a class="link" href="years_duration.html#id367067-bb"><span class="bold"><strong>operator</strong></span>*=</a>(<span class="bold"><strong>const</strong></span> int_type) ;
<span class="type">years_type</span> <a class="link" href="years_duration.html#id358009-bb"><span class="bold"><strong>operator</strong></span>/</a>(<span class="bold"><strong>const</strong></span> int_type) <span class="bold"><strong>const</strong></span>;
<span class="type">years_type &</span> <a class="link" href="years_duration.html#id333176-bb"><span class="bold"><strong>operator</strong></span>/=</a>(<span class="bold"><strong>const</strong></span> int_type) ;
<span class="type">months_type</span> <a class="link" href="years_duration.html#id331518-bb"><span class="bold"><strong>operator</strong></span>+</a>(<span class="bold"><strong>const</strong></span> months_type &) <span class="bold"><strong>const</strong></span>;
<span class="type">months_type</span> <a class="link" href="years_duration.html#id397184-bb"><span class="bold"><strong>operator</strong></span>-</a>(<span class="bold"><strong>const</strong></span> months_type &) <span class="bold"><strong>const</strong></span>;
};</pre></div>
<div class="refsect1" title="Description">
<a name="id772718"></a><h2>Description</h2>
<p>A logical year enables things like: "date(2002,Mar,2) + years(2) -> 2004-Mar-2". If the date is a last day-of-the-month, the result will also be a last-day-of-the-month (ie date(2001-Feb-28) + years(3) -> 2004-Feb-29). </p>
<div class="refsect2" title="years_duration public construct/copy/destruct">
<a name="id772724"></a><h3>
<a name="boost.date_time.years_durationconstruct-copy-destruct"></a><code class="computeroutput">years_duration</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><pre class="literallayout"><a name="id397202-bb"></a>years_duration(int_rep num);</pre></li>
<li class="listitem"><pre class="literallayout"><a name="id397209-bb"></a>years_duration(special_values sv);</pre></li>
</ol></div>
</div>
<div class="refsect2" title="years_duration public member functions">
<a name="id772771"></a><h3>
<a name="id578148-bb"></a><code class="computeroutput">years_duration</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><pre class="literallayout"><span class="type">int_rep</span> <a name="id331727-bb"></a>number_of_years() <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem">
<pre class="literallayout"><span class="type">duration_type</span> <a name="id331734-bb"></a>get_neg_offset(<span class="bold"><strong>const</strong></span> date_type & d) <span class="bold"><strong>const</strong></span>;</pre>returns a negative duration </li>
<li class="listitem"><pre class="literallayout"><span class="type">duration_type</span> <a name="id331750-bb"></a>get_offset(<span class="bold"><strong>const</strong></span> date_type & d) <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id344232-bb"></a><span class="bold"><strong>operator</strong></span>==(<span class="bold"><strong>const</strong></span> years_type & rhs) <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type"><span class="bold"><strong>bool</strong></span></span> <a name="id344249-bb"></a><span class="bold"><strong>operator</strong></span>!=(<span class="bold"><strong>const</strong></span> years_type & rhs) <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type">years_type</span> <a name="id348492-bb"></a><span class="bold"><strong>operator</strong></span>+(<span class="bold"><strong>const</strong></span> years_type & rhs) <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type">years_type &</span> <a name="id348510-bb"></a><span class="bold"><strong>operator</strong></span>+=(<span class="bold"><strong>const</strong></span> years_type & rhs) ;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type">years_type</span> <a name="id333698-bb"></a><span class="bold"><strong>operator</strong></span>-(<span class="bold"><strong>const</strong></span> years_type & rhs) <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type">years_type &</span> <a name="id333716-bb"></a><span class="bold"><strong>operator</strong></span>-=(<span class="bold"><strong>const</strong></span> years_type & rhs) ;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type">years_type</span> <a name="id367053-bb"></a><span class="bold"><strong>operator</strong></span>*(<span class="bold"><strong>const</strong></span> int_type rhs) <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type">years_type &</span> <a name="id367067-bb"></a><span class="bold"><strong>operator</strong></span>*=(<span class="bold"><strong>const</strong></span> int_type rhs) ;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type">years_type</span> <a name="id358009-bb"></a><span class="bold"><strong>operator</strong></span>/(<span class="bold"><strong>const</strong></span> int_type rhs) <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type">years_type &</span> <a name="id333176-bb"></a><span class="bold"><strong>operator</strong></span>/=(<span class="bold"><strong>const</strong></span> int_type rhs) ;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type">months_type</span> <a name="id331518-bb"></a><span class="bold"><strong>operator</strong></span>+(<span class="bold"><strong>const</strong></span> months_type & m) <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type">months_type</span> <a name="id397184-bb"></a><span class="bold"><strong>operator</strong></span>-(<span class="bold"><strong>const</strong></span> months_type & m) <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"><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="months_duration.html"><img src="../../../../doc/html/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/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="date_facet.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>
