doc/html/boost/date_time/date_duration.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template date_duration</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.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.date_duration_hpp" title="Header &lt;boost/date_time/date_duration.hpp&gt;">
<link rel="prev" href="day_clock.html" title="Class template day_clock">
<link rel="next" href="duration_traits_long.html" title="Struct duration_traits_long">
</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="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>
</div>
<div class="refentry">
<a name="boost.date_time.date_duration"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template date_duration</span></h2>
<p>boost::date_time::date_duration &#8212; Duration type with date level resolution. </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_hpp" title="Header &lt;boost/date_time/date_duration.hpp&gt;">boost/date_time/date_duration.hpp</a>&gt;

</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> duration_rep_traits<span class="special">&gt;</span> 
<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;
<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">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>
  <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>     

  <span class="comment">// <a class="link" href="date_duration.html#boost.date_time.date_durationconstruct-copy-destruct">construct/copy/destruct</a></span>
  <span class="keyword">explicit</span> <a class="link" href="date_duration.html#idp495949024-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>
  <a class="link" href="date_duration.html#idp495950576-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>
  <a class="link" href="date_duration.html#idp495952768-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>

  <span class="comment">// <a class="link" href="date_duration.html#idp495928912-bb">public member functions</a></span>
  <span class="identifier">duration_rep</span> <a class="link" href="date_duration.html#idp495929472-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>
  <span class="keyword">bool</span> <a class="link" href="date_duration.html#idp495930928-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>
  <span class="identifier">duration_rep_type</span> <a class="link" href="date_duration.html#idp495932048-bb"><span class="identifier">days</span></a><span class="special">(</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#idp495933472-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>
  <span class="keyword">bool</span> <a class="link" href="date_duration.html#idp495936016-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>
  <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#idp495938560-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>
  <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#idp495941152-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>
  <a class="link" href="date_duration.html" title="Class template date_duration">date_duration</a> <a class="link" href="date_duration.html#idp495943728-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 template date_duration">date_duration</a> <span class="special">&amp;</span> <a class="link" href="date_duration.html#idp495945296-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="keyword">bool</span> <a class="link" href="date_duration.html#idp495947440-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>

  <span class="comment">// <a class="link" href="date_duration.html#idp495955232-bb">public static functions</a></span>
  <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#idp495955792-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="idp210223648"></a><h2>Description</h2>
<div class="refsect2">
<a name="idp210224064"></a><h3>
<a name="boost.date_time.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="idp495949024-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>
<li class="listitem">
<pre class="literallayout"><a name="idp495950576-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>
<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>
</li>
<li class="listitem">
<pre class="literallayout"><a name="idp495952768-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>
</ol></div>
</div>
<div class="refsect2">
<a name="idp210246688"></a><h3>
<a name="idp495928912-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="identifier">duration_rep</span> <a name="idp495929472-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>
<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idp495930928-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>
<li class="listitem">
<pre class="literallayout"><span class="identifier">duration_rep_type</span> <a name="idp495932048-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>
<li class="listitem">
<pre class="literallayout"><span class="keyword">bool</span> <a name="idp495933472-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>
<li class="listitem">
<pre class="literallayout"><span class="keyword">bool</span> <a name="idp495936016-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>
<li class="listitem">
<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="idp495938560-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>
<li class="listitem">
<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="idp495941152-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>
<li class="listitem">
<pre class="literallayout"><a class="link" href="date_duration.html" title="Class template date_duration">date_duration</a> <a name="idp495943728-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 template date_duration">date_duration</a> <span class="special">&amp;</span> <a name="idp495945296-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>
<li class="listitem">
<pre class="literallayout"><span class="keyword">bool</span> <a name="idp495947440-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>
</ol></div>
</div>
<div class="refsect2">
<a name="idp210314096"></a><h3>
<a name="idp495955232-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 template date_duration">date_duration</a> <a name="idp495955792-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>
</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="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>
</div>
</body>
</html>