doc/html/boost/date_time/date_duration.html

   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=US-ASCII">
   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 &lt;boost/date_time/date_duration.hpp&gt;">
  10 <link rel="prev" href="day_clock.html" title="Class template day_clock">
  11 <link rel="next" href="duration_traits_long.html" title="Struct duration_traits_long">
  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_long.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 &#8212; 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: &lt;<a class="link" href="../../date_time/doxy.html#header.boost.date_time.date_duration_hpp" title="Header &lt;boost/date_time/date_duration.hpp&gt;">boost/date_time/date_duration.hpp</a>&gt;
  34
  35 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> duration_rep_traits<span class="special">&gt;</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&lt; date_duration&lt; duration_rep_traits &gt;, boost::equality_comparable1&lt; date_duration&lt; duration_rep_traits &gt;, boost::addable1&lt; date_duration&lt; duration_rep_traits &gt;, boost::subtractable1&lt; date_duration&lt; duration_rep_traits &gt;, boost::dividable2&lt; date_duration&lt; duration_rep_traits &gt;, int &gt; &gt; &gt; &gt; &gt;
  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#idp495038064-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#idp495039616-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   <a class="link" href="date_duration.html#idp495041808-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 template date_duration">date_duration</a><span class="special">&lt;</span> <span class="identifier">duration_rep_traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  47
  48   <span class="comment">// <a class="link" href="date_duration.html#idp495017952-bb">public member functions</a></span>
  49   <span class="identifier">duration_rep</span> <a class="link" href="date_duration.html#idp495018512-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>
  50   <span class="keyword">bool</span> <a class="link" href="date_duration.html#idp495019968-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">duration_rep_type</span> <a class="link" href="date_duration.html#idp495021088-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="keyword">bool</span> <a class="link" href="date_duration.html#idp495022512-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">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  53   <span class="keyword">bool</span> <a class="link" href="date_duration.html#idp495025056-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 template date_duration">date_duration</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  54   <a class="link" href="date_duration.html" title="Class template date_duration">date_duration</a> <span class="special">&amp;</span> <a class="link" href="date_duration.html#idp495027600-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">&amp;</span><span class="special">)</span><span class="special">;</span>
  55   <a class="link" href="date_duration.html" title="Class template date_duration">date_duration</a> <span class="special">&amp;</span> <a class="link" href="date_duration.html#idp495030192-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">&amp;</span><span class="special">)</span><span class="special">;</span>
  56   <a class="link" href="date_duration.html" title="Class template date_duration">date_duration</a> <a class="link" href="date_duration.html#idp495032768-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   <a class="link" href="date_duration.html" title="Class template date_duration">date_duration</a> <span class="special">&amp;</span> <a class="link" href="date_duration.html#idp495034336-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="keyword">bool</span> <a class="link" href="date_duration.html#idp495036480-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#idp495044272-bb">public static functions</a></span>
  61   <span class="keyword">static</span> <a class="link" href="date_duration.html" title="Class template date_duration">date_duration</a> <a class="link" href="date_duration.html#idp495044832-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="idp215758896"></a><h2>Description</h2>
  65 <div class="refsect2">
  66 <a name="idp215759312"></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="idp495038064-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="idp495039616-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 <li class="listitem">
  78 <pre class="literallayout"><a name="idp495041808-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 template date_duration">date_duration</a><span class="special">&lt;</span> <span class="identifier">duration_rep_traits</span> <span class="special">&gt;</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 template date_duration">date_duration</a></code> (Copy Constructor) </li>
  79 </ol></div>
  80 </div>
  81 <div class="refsect2">
  82 <a name="idp215781936"></a><h3>
  83 <a name="idp495017952-bb"></a><code class="computeroutput">date_duration</code> public member functions</h3>
  84 <div class="orderedlist"><ol class="orderedlist" type="1">
  85 <li class="listitem">
  86 <pre class="literallayout"><span class="identifier">duration_rep</span> <a name="idp495018512-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>
  87 <li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idp495019968-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>
  88 <li class="listitem">
  89 <pre class="literallayout"><span class="identifier">duration_rep_type</span> <a name="idp495021088-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>
  90 <li class="listitem">
  91 <pre class="literallayout"><span class="keyword">bool</span> <a name="idp495022512-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">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Equality. </li>
  92 <li class="listitem">
  93 <pre class="literallayout"><span class="keyword">bool</span> <a name="idp495025056-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 template 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>Less. </li>
  94 <li class="listitem">
  95 <pre class="literallayout"><a class="link" href="date_duration.html" title="Class template date_duration">date_duration</a> <span class="special">&amp;</span> <a name="idp495027600-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">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>Subtract another duration &#8211; result is signed. </li>
  96 <li class="listitem">
  97 <pre class="literallayout"><a class="link" href="date_duration.html" title="Class template date_duration">date_duration</a> <span class="special">&amp;</span> <a name="idp495030192-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">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>Add a duration &#8211; result is signed. </li>
  98 <li class="listitem">
  99 <pre class="literallayout"><a class="link" href="date_duration.html" title="Class template date_duration">date_duration</a> <a name="idp495032768-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>
 100 <li class="listitem">
 101 <pre class="literallayout"><a class="link" href="date_duration.html" title="Class template date_duration">date_duration</a> <span class="special">&amp;</span> <a name="idp495034336-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>
 102 <li class="listitem">
 103 <pre class="literallayout"><span class="keyword">bool</span> <a name="idp495036480-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>
 104 </ol></div>
 105 </div>
 106 <div class="refsect2">
 107 <a name="idp215849392"></a><h3>
 108 <a name="idp495044272-bb"></a><code class="computeroutput">date_duration</code> public static functions</h3>
 109 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
 110 <pre class="literallayout"><span class="keyword">static</span> <a class="link" href="date_duration.html" title="Class template date_duration">date_duration</a> <a name="idp495044832-bb"></a><span class="identifier">unit</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Returns the smallest duration &#8211; used by to calculate 'end'. </li></ol></div>
 111 </div>
 112 </div>
 113 </div>
 114 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 115 <td align="left"></td>
 116 <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
 117     <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>
 118 </div></td>
 119 </tr></table>
 120 <hr>
 121 <div class="spirit-nav">
 122 <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_long.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 123 </div>
 124 </body>
 125 </html>