1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>Class template date_duration</title> 6<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> 7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 8<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> 9<link rel="up" href="../../date_time/doxy.html#header.boost.date_time.date_duration_hpp" title="Header <boost/date_time/date_duration.hpp>"> 10<link rel="prev" href="day_clock.html" title="Class template day_clock"> 11<link rel="next" href="duration_traits_adapted.html" title="Struct duration_traits_adapted"> 12</head> 13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 14<table cellpadding="2" width="100%"><tr> 15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> 16<td align="center"><a href="../../../../index.html">Home</a></td> 17<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> 18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 20<td align="center"><a href="../../../../more/index.htm">More</a></td> 21</tr></table> 22<hr> 23<div class="spirit-nav"> 24<a accesskey="p" href="day_clock.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_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="duration_traits_adapted.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.date_time.date_duration"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Class template date_duration</span></h2> 30<p>boost::date_time::date_duration — Duration type with date level resolution. </p> 31</div> 32<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> 33<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_duration_hpp" title="Header <boost/date_time/date_duration.hpp>">boost/date_time/date_duration.hpp</a>> 34 35</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> duration_rep_traits<span class="special">></span> 36<span class="keyword">class</span> <a class="link" href="date_duration.html" title="Class template date_duration">date_duration</a> <span class="special">:</span> <span class="keyword">private</span> boost::less_than_comparable1< date_duration< duration_rep_traits >, boost::equality_comparable1< date_duration< duration_rep_traits >, boost::addable1< date_duration< duration_rep_traits >, boost::subtractable1< date_duration< duration_rep_traits >, boost::dividable2< date_duration< duration_rep_traits >, int > > > > > 37<span class="special">{</span> 38<span class="keyword">public</span><span class="special">:</span> 39 <span class="comment">// types</span> 40 <span class="keyword">typedef</span> <span class="identifier">duration_rep_traits</span><span class="special">::</span><span class="identifier">int_type</span> <a name="boost.date_time.date_duration.duration_rep_type"></a><span class="identifier">duration_rep_type</span><span class="special">;</span> 41 <span class="keyword">typedef</span> <span class="identifier">duration_rep_traits</span><span class="special">::</span><span class="identifier">impl_type</span> <a name="boost.date_time.date_duration.duration_rep"></a><span class="identifier">duration_rep</span><span class="special">;</span> 42 43 <span class="comment">// <a class="link" href="date_duration.html#boost.date_time.date_durationconstruct-copy-destruct">construct/copy/destruct</a></span> 44 <span class="keyword">explicit</span> <a class="link" href="date_duration.html#id-1_3_14_15_3_10_1_1_1_7-bb"><span class="identifier">date_duration</span></a><span class="special">(</span><span class="identifier">duration_rep</span><span class="special">)</span><span class="special">;</span> 45 <a class="link" href="date_duration.html#id-1_3_14_15_3_10_1_1_1_8-bb"><span class="identifier">date_duration</span></a><span class="special">(</span><span class="identifier">special_values</span><span class="special">)</span><span class="special">;</span> 46 47 <span class="comment">// <a class="link" href="date_duration.html#id-1_3_14_15_3_10_1_1_1_6-bb">public member functions</a></span> 48 <span class="identifier">BOOST_CXX14_CONSTEXPR</span> <span class="identifier">duration_rep</span> <a class="link" href="date_duration.html#id-1_3_14_15_3_10_1_1_1_6_1-bb"><span class="identifier">get_rep</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 49 <span class="identifier">BOOST_CXX14_CONSTEXPR</span> <span class="identifier">special_values</span> <a class="link" href="date_duration.html#id-1_3_14_15_3_10_1_1_1_6_2-bb"><span class="identifier">as_special</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 50 <span class="identifier">BOOST_CXX14_CONSTEXPR</span> <span class="keyword">bool</span> <a class="link" href="date_duration.html#id-1_3_14_15_3_10_1_1_1_6_3-bb"><span class="identifier">is_special</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 51 <span class="identifier">BOOST_CXX14_CONSTEXPR</span> <span class="identifier">duration_rep_type</span> <a class="link" href="date_duration.html#id-1_3_14_15_3_10_1_1_1_6_4-bb"><span class="identifier">days</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 52 <span class="identifier">BOOST_CXX14_CONSTEXPR</span> <span class="keyword">bool</span> <a class="link" href="date_duration.html#id-1_3_14_15_3_10_1_1_1_6_5-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 template date_duration">date_duration</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 53 <span class="identifier">BOOST_CXX14_CONSTEXPR</span> <span class="keyword">bool</span> <a class="link" href="date_duration.html#id-1_3_14_15_3_10_1_1_1_6_6-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 template date_duration">date_duration</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 54 <span class="identifier">BOOST_CXX14_CONSTEXPR</span> <a class="link" href="date_duration.html" title="Class template date_duration">date_duration</a> <span class="special">&</span> <a class="link" href="date_duration.html#id-1_3_14_15_3_10_1_1_1_6_7-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 template date_duration">date_duration</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 55 <span class="identifier">BOOST_CXX14_CONSTEXPR</span> <a class="link" href="date_duration.html" title="Class template date_duration">date_duration</a> <span class="special">&</span> <a class="link" href="date_duration.html#id-1_3_14_15_3_10_1_1_1_6_8-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 template date_duration">date_duration</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 56 <span class="identifier">BOOST_CXX14_CONSTEXPR</span> <a class="link" href="date_duration.html" title="Class template date_duration">date_duration</a> <a class="link" href="date_duration.html#id-1_3_14_15_3_10_1_1_1_6_9-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> 57 <span class="identifier">BOOST_CXX14_CONSTEXPR</span> <a class="link" href="date_duration.html" title="Class template date_duration">date_duration</a> <span class="special">&</span> <a class="link" href="date_duration.html#id-1_3_14_15_3_10_1_1_1_6_10-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> 58 <span class="identifier">BOOST_CXX14_CONSTEXPR</span> <span class="keyword">bool</span> <a class="link" href="date_duration.html#id-1_3_14_15_3_10_1_1_1_6_11-bb"><span class="identifier">is_negative</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 59 60 <span class="comment">// <a class="link" href="date_duration.html#id-1_3_14_15_3_10_1_1_1_9-bb">public static functions</a></span> 61 <span class="keyword">static</span> <span class="identifier">BOOST_CXX14_CONSTEXPR</span> <a class="link" href="date_duration.html" title="Class template date_duration">date_duration</a> <a class="link" href="date_duration.html#id-1_3_14_15_3_10_1_1_1_9_1-bb"><span class="identifier">unit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 62<span class="special">}</span><span class="special">;</span></pre></div> 63<div class="refsect1"> 64<a name="id-1.3.14.15.3.10.3.4"></a><h2>Description</h2> 65<div class="refsect2"> 66<a name="id-1.3.14.15.3.10.3.4.2"></a><h3> 67<a name="boost.date_time.date_durationconstruct-copy-destruct"></a><code class="computeroutput">date_duration</code> 68 public 69 construct/copy/destruct</h3> 70<div class="orderedlist"><ol class="orderedlist" type="1"> 71<li class="listitem"> 72<pre class="literallayout"><span class="keyword">explicit</span> <a name="id-1_3_14_15_3_10_1_1_1_7-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="special">;</span></pre>Construct from a day count. </li> 73<li class="listitem"> 74<pre class="literallayout"><a name="id-1_3_14_15_3_10_1_1_1_8-bb"></a><span class="identifier">date_duration</span><span class="special">(</span><span class="identifier">special_values</span> sv<span class="special">)</span><span class="special">;</span></pre> 75<p>construct from special_values - only works when instantiated with <code class="computeroutput"><a class="link" href="duration_traits_adapted.html" title="Struct duration_traits_adapted">duration_traits_adapted</a></code> </p> 76</li> 77</ol></div> 78</div> 79<div class="refsect2"> 80<a name="id-1.3.14.15.3.10.3.4.3"></a><h3> 81<a name="id-1_3_14_15_3_10_1_1_1_6-bb"></a><code class="computeroutput">date_duration</code> public member functions</h3> 82<div class="orderedlist"><ol class="orderedlist" type="1"> 83<li class="listitem"> 84<pre class="literallayout"><span class="identifier">BOOST_CXX14_CONSTEXPR</span> <span class="identifier">duration_rep</span> <a name="id-1_3_14_15_3_10_1_1_1_6_1-bb"></a><span class="identifier">get_rep</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>returns days_ as it's instantiated type - used for streaming </li> 85<li class="listitem"><pre class="literallayout"><span class="identifier">BOOST_CXX14_CONSTEXPR</span> <span class="identifier">special_values</span> <a name="id-1_3_14_15_3_10_1_1_1_6_2-bb"></a><span class="identifier">as_special</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> 86<li class="listitem"><pre class="literallayout"><span class="identifier">BOOST_CXX14_CONSTEXPR</span> <span class="keyword">bool</span> <a name="id-1_3_14_15_3_10_1_1_1_6_3-bb"></a><span class="identifier">is_special</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> 87<li class="listitem"> 88<pre class="literallayout"><span class="identifier">BOOST_CXX14_CONSTEXPR</span> <span class="identifier">duration_rep_type</span> <a name="id-1_3_14_15_3_10_1_1_1_6_4-bb"></a><span class="identifier">days</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>returns days as value, not object. </li> 89<li class="listitem"> 90<pre class="literallayout"><span class="identifier">BOOST_CXX14_CONSTEXPR</span> <span class="keyword">bool</span> <a name="id-1_3_14_15_3_10_1_1_1_6_5-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 template date_duration">date_duration</a> <span class="special">&</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Equality. </li> 91<li class="listitem"> 92<pre class="literallayout"><span class="identifier">BOOST_CXX14_CONSTEXPR</span> <span class="keyword">bool</span> <a name="id-1_3_14_15_3_10_1_1_1_6_6-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 template date_duration">date_duration</a> <span class="special">&</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Less. </li> 93<li class="listitem"> 94<pre class="literallayout"><span class="identifier">BOOST_CXX14_CONSTEXPR</span> <a class="link" href="date_duration.html" title="Class template date_duration">date_duration</a> <span class="special">&</span> <a name="id-1_3_14_15_3_10_1_1_1_6_7-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 template date_duration">date_duration</a> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre>Subtract another duration – result is signed. </li> 95<li class="listitem"> 96<pre class="literallayout"><span class="identifier">BOOST_CXX14_CONSTEXPR</span> <a class="link" href="date_duration.html" title="Class template date_duration">date_duration</a> <span class="special">&</span> <a name="id-1_3_14_15_3_10_1_1_1_6_8-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 template date_duration">date_duration</a> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre>Add a duration – result is signed. </li> 97<li class="listitem"> 98<pre class="literallayout"><span class="identifier">BOOST_CXX14_CONSTEXPR</span> <a class="link" href="date_duration.html" title="Class template date_duration">date_duration</a> <a name="id-1_3_14_15_3_10_1_1_1_6_9-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); -> dd == -2 </li> 99<li class="listitem"> 100<pre class="literallayout"><span class="identifier">BOOST_CXX14_CONSTEXPR</span> <a class="link" href="date_duration.html" title="Class template date_duration">date_duration</a> <span class="special">&</span> <a name="id-1_3_14_15_3_10_1_1_1_6_10-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> 101<li class="listitem"> 102<pre class="literallayout"><span class="identifier">BOOST_CXX14_CONSTEXPR</span> <span class="keyword">bool</span> <a name="id-1_3_14_15_3_10_1_1_1_6_11-bb"></a><span class="identifier">is_negative</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>return sign information </li> 103</ol></div> 104</div> 105<div class="refsect2"> 106<a name="id-1.3.14.15.3.10.3.4.4"></a><h3> 107<a name="id-1_3_14_15_3_10_1_1_1_9-bb"></a><code class="computeroutput">date_duration</code> public static functions</h3> 108<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> 109<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">BOOST_CXX14_CONSTEXPR</span> <a class="link" href="date_duration.html" title="Class template date_duration">date_duration</a> <a name="id-1_3_14_15_3_10_1_1_1_9_1-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> 110</div> 111</div> 112</div> 113<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 114<td align="left"></td> 115<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 116 <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> 117</div></td> 118</tr></table> 119<hr> 120<div class="spirit-nav"> 121<a accesskey="p" href="day_clock.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_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="duration_traits_adapted.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 122</div> 123</body> 124</html> 125
