Google Git
Sign in
android / platform / external / boost / 077d563efdb280a3d144892e2d0ca01e6a49f454 / . / doc / html / boost / gregorian / date_duration.html
blob: 2b0c7342a89383f7089823b8d9ff6e2041c6e544 [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class date_duration</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<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.gregorian.greg_duration_hpp" title="Header &lt;boost/date_time/gregorian/greg_duration.hpp&gt;">
<link rel="prev" href="bad_day_of_year.html" title="Struct bad_day_of_year">
<link rel="next" href="greg_durations_config.html" title="Struct greg_durations_config">
</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="bad_day_of_year.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.gregorian.greg_duration_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="greg_durations_config.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.gregorian.date_duration"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class date_duration</span></h2>
<p>boost::gregorian::date_duration &#8212; Durations in days for gregorian system. </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.gregorian.greg_duration_hpp" title="Header &lt;boost/date_time/gregorian/greg_duration.hpp&gt;">boost/date_time/gregorian/greg_duration.hpp</a>&gt;
</span>
<span class="keyword">class</span> <a class="link" href="date_duration.html" title="Class date_duration">date_duration</a> <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">base_type</span><span class="special">::</span><span class="identifier">duration_rep</span> <a name="boost.gregorian.date_duration.duration_rep"></a><span class="identifier">duration_rep</span><span class="special">;</span>
<span class="comment">// <a class="link" href="date_duration.html#boost.gregorian.date_durationconstruct-copy-destruct">construct/copy/destruct</a></span>
<span class="keyword">explicit</span> <a class="link" href="date_duration.html#id629429-bb"><span class="identifier">date_duration</span></a><span class="special">(</span><span class="identifier">duration_rep</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="date_duration.html#id629443-bb"><span class="identifier">date_duration</span></a><span class="special">(</span><span class="identifier">date_time</span><span class="special">::</span><span class="identifier">special_values</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="date_duration.html#id629452-bb"><span class="identifier">date_duration</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="date_duration.html" title="Class date_duration">date_duration</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="date_duration.html#id629465-bb"><span class="identifier">date_duration</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">base_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
<span class="comment">// <a class="link" href="date_duration.html#id406618-bb">public member functions</a></span>
<span class="keyword">bool</span> <a class="link" href="date_duration.html#id406621-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="date_duration.html" title="Class date_duration">date_duration</a> <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="date_duration.html#id441872-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="date_duration.html" title="Class date_duration">date_duration</a> <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="date_duration.html#id633696-bb"><span class="keyword">operator</span><span class="special">&lt;</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="date_duration.html" title="Class date_duration">date_duration</a> <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="date_duration.html#id442145-bb"><span class="keyword">operator</span><span class="special">&gt;</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="date_duration.html" title="Class date_duration">date_duration</a> <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="date_duration.html#id438044-bb"><span class="keyword">operator</span><span class="special">&lt;=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="date_duration.html" title="Class date_duration">date_duration</a> <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="date_duration.html#id412094-bb"><span class="keyword">operator</span><span class="special">&gt;=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="date_duration.html" title="Class date_duration">date_duration</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<a class="link" href="date_duration.html" title="Class date_duration">date_duration</a> <span class="special">&amp;</span> <a class="link" href="date_duration.html#id412111-bb"><span class="keyword">operator</span><span class="special">-=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="date_duration.html" title="Class date_duration">date_duration</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="date_duration.html" title="Class date_duration">date_duration</a> <span class="special">&amp;</span> <a class="link" href="date_duration.html#id465543-bb"><span class="keyword">operator</span><span class="special">+=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="date_duration.html" title="Class date_duration">date_duration</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="date_duration.html" title="Class date_duration">date_duration</a> <a class="link" href="date_duration.html#id629398-bb"><span class="keyword">operator</span><span class="special">-</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<a class="link" href="date_duration.html" title="Class date_duration">date_duration</a> <span class="special">&amp;</span> <a class="link" href="date_duration.html#id629410-bb"><span class="keyword">operator</span><span class="special">/=</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">;</span>
<span class="comment">// <a class="link" href="date_duration.html#id403339-bb">public static functions</a></span>
<span class="keyword">static</span> <a class="link" href="date_duration.html" title="Class date_duration">date_duration</a> <a class="link" href="date_duration.html#id445707-bb"><span class="identifier">unit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="id1307398"></a><h2>Description</h2>
<div class="refsect2">
<a name="id1307402"></a><h3>
<a name="boost.gregorian.date_durationconstruct-copy-destruct"></a><code class="computeroutput">date_duration</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="keyword">explicit</span> <a name="id629429-bb"></a><span class="identifier">date_duration</span><span class="special">(</span><span class="identifier">duration_rep</span> day_count <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre>Construct from a day count. </li>
<li class="listitem">
<pre class="literallayout"><a name="id629443-bb"></a><span class="identifier">date_duration</span><span class="special">(</span><span class="identifier">date_time</span><span class="special">::</span><span class="identifier">special_values</span> sv<span class="special">)</span><span class="special">;</span></pre>construct from special_values </li>
<li class="listitem">
<pre class="literallayout"><a name="id629452-bb"></a><span class="identifier">date_duration</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="date_duration.html" title="Class date_duration">date_duration</a> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>Copy constructor. </li>
<li class="listitem">
<pre class="literallayout"><a name="id629465-bb"></a><span class="identifier">date_duration</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">base_type</span> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>Construct from another <code class="computeroutput"><a class="link" href="date_duration.html" title="Class date_duration">date_duration</a></code>. </li>
</ol></div>
</div>
<div class="refsect2">
<a name="id1307627"></a><h3>
<a name="id406618-bb"></a><code class="computeroutput">date_duration</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="id406621-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="date_duration.html" title="Class date_duration">date_duration</a> <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="id441872-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="date_duration.html" title="Class date_duration">date_duration</a> <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="id633696-bb"></a><span class="keyword">operator</span><span class="special">&lt;</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="date_duration.html" title="Class date_duration">date_duration</a> <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="id442145-bb"></a><span class="keyword">operator</span><span class="special">&gt;</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="date_duration.html" title="Class date_duration">date_duration</a> <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="id438044-bb"></a><span class="keyword">operator</span><span class="special">&lt;=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="date_duration.html" title="Class date_duration">date_duration</a> <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="id412094-bb"></a><span class="keyword">operator</span><span class="special">&gt;=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="date_duration.html" title="Class date_duration">date_duration</a> <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"><a class="link" href="date_duration.html" title="Class date_duration">date_duration</a> <span class="special">&amp;</span> <a name="id412111-bb"></a><span class="keyword">operator</span><span class="special">-=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="date_duration.html" title="Class date_duration">date_duration</a> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>Subtract another duration -- result is signed. </li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="date_duration.html" title="Class date_duration">date_duration</a> <span class="special">&amp;</span> <a name="id465543-bb"></a><span class="keyword">operator</span><span class="special">+=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="date_duration.html" title="Class date_duration">date_duration</a> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>Add a duration -- result is signed. </li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="date_duration.html" title="Class date_duration">date_duration</a> <a name="id629398-bb"></a><span class="keyword">operator</span><span class="special">-</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>unary- Allows for dd = -date_duration(2); -&gt; dd == -2 </li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="date_duration.html" title="Class date_duration">date_duration</a> <span class="special">&amp;</span> <a name="id629410-bb"></a><span class="keyword">operator</span><span class="special">/=</span><span class="special">(</span><span class="keyword">int</span> divisor<span class="special">)</span><span class="special">;</span></pre>Division operations on a duration with an integer. </li>
</ol></div>
</div>
<div class="refsect2">
<a name="id1308262"></a><h3>
<a name="id403339-bb"></a><code class="computeroutput">date_duration</code> public static functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
<pre class="literallayout"><span class="keyword">static</span> <a class="link" href="date_duration.html" title="Class date_duration">date_duration</a> <a name="id445707-bb"></a><span class="identifier">unit</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Returns the smallest duration -- used by to calculate 'end'. </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="bad_day_of_year.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.gregorian.greg_duration_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="greg_durations_config.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>