Imported Upstream version 1.64.0
[platform/upstream/boost.git] / doc / html / boost / posix_time / time_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 time_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.posix_time.posix_time_config_hpp" title="Header &lt;boost/date_time/posix_time/posix_time_config.hpp&gt;">
10 <link rel="prev" href="operator-__idp498502096.html" title="Function operator-=">
11 <link rel="next" href="simple_time_rep.html" title="Struct simple_time_rep">
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="operator-__idp498502096.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.posix_time.posix_time_config_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="simple_time_rep.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
25 </div>
26 <div class="refentry">
27 <a name="boost.posix_time.time_duration"></a><div class="titlepage"></div>
28 <div class="refnamediv">
29 <h2><span class="refentrytitle">Class time_duration</span></h2>
30 <p>boost::posix_time::time_duration &#8212; Base time duration type. </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.posix_time.posix_time_config_hpp" title="Header &lt;boost/date_time/posix_time/posix_time_config.hpp&gt;">boost/date_time/posix_time/posix_time_config.hpp</a>&gt;
34
35 </span>
36 <span class="keyword">class</span> <a class="link" href="time_duration.html" title="Class time_duration">time_duration</a> <span class="special">:</span>
37   <span class="keyword">public</span> <span class="identifier">date_time</span><span class="special">::</span><span class="identifier">time_duration</span><span class="special">&lt;</span> <span class="identifier">time_duration</span><span class="special">,</span> <span class="identifier">time_res_traits</span> <span class="special">&gt;</span>
38 <span class="special">{</span>
39 <span class="keyword">public</span><span class="special">:</span>
40   <span class="comment">// types</span>
41   <span class="keyword">typedef</span> <span class="identifier">time_res_traits</span>                          <a name="boost.posix_time.time_duration.rep_type"></a><span class="identifier">rep_type</span><span class="special">;</span>               
42   <span class="keyword">typedef</span> <span class="identifier">time_res_traits</span><span class="special">::</span><span class="identifier">day_type</span>                <a name="boost.posix_time.time_duration.day_type"></a><span class="identifier">day_type</span><span class="special">;</span>               
43   <span class="keyword">typedef</span> <span class="identifier">time_res_traits</span><span class="special">::</span><span class="identifier">hour_type</span>               <a name="boost.posix_time.time_duration.hour_type"></a><span class="identifier">hour_type</span><span class="special">;</span>              
44   <span class="keyword">typedef</span> <span class="identifier">time_res_traits</span><span class="special">::</span><span class="identifier">min_type</span>                <a name="boost.posix_time.time_duration.min_type"></a><span class="identifier">min_type</span><span class="special">;</span>               
45   <span class="keyword">typedef</span> <span class="identifier">time_res_traits</span><span class="special">::</span><span class="identifier">sec_type</span>                <a name="boost.posix_time.time_duration.sec_type"></a><span class="identifier">sec_type</span><span class="special">;</span>               
46   <span class="keyword">typedef</span> <span class="identifier">time_res_traits</span><span class="special">::</span><span class="identifier">fractional_seconds_type</span> <a name="boost.posix_time.time_duration.fractional_seconds_type"></a><span class="identifier">fractional_seconds_type</span><span class="special">;</span>
47   <span class="keyword">typedef</span> <span class="identifier">time_res_traits</span><span class="special">::</span><span class="identifier">tick_type</span>               <a name="boost.posix_time.time_duration.tick_type"></a><span class="identifier">tick_type</span><span class="special">;</span>              
48   <span class="keyword">typedef</span> <span class="identifier">time_res_traits</span><span class="special">::</span><span class="identifier">impl_type</span>               <a name="boost.posix_time.time_duration.impl_type"></a><span class="identifier">impl_type</span><span class="special">;</span>              
49
50   <span class="comment">// <a class="link" href="time_duration.html#boost.posix_time.time_durationconstruct-copy-destruct">construct/copy/destruct</a></span>
51   <a class="link" href="time_duration.html#idp498517568-bb"><span class="identifier">time_duration</span></a><span class="special">(</span><span class="identifier">hour_type</span><span class="special">,</span> <span class="identifier">min_type</span><span class="special">,</span> <span class="identifier">sec_type</span><span class="special">,</span> <span class="identifier">fractional_seconds_type</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span>
52   <a class="link" href="time_duration.html#idp498520896-bb"><span class="identifier">time_duration</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
53   <a class="link" href="time_duration.html#idp498521184-bb"><span class="identifier">time_duration</span></a><span class="special">(</span><span class="identifier">boost</span><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>
54   <span class="keyword">explicit</span> <a class="link" href="time_duration.html#idp498523216-bb"><span class="identifier">time_duration</span></a><span class="special">(</span><span class="identifier">impl_type</span><span class="special">)</span><span class="special">;</span>
55 <span class="special">}</span><span class="special">;</span></pre></div>
56 <div class="refsect1">
57 <a name="idp236459248"></a><h2>Description</h2>
58 <div class="refsect2">
59 <a name="idp236459664"></a><h3>
60 <a name="boost.posix_time.time_durationconstruct-copy-destruct"></a><code class="computeroutput">time_duration</code> 
61         public
62        construct/copy/destruct</h3>
63 <div class="orderedlist"><ol class="orderedlist" type="1">
64 <li class="listitem"><pre class="literallayout"><a name="idp498517568-bb"></a><span class="identifier">time_duration</span><span class="special">(</span><span class="identifier">hour_type</span> hour<span class="special">,</span> <span class="identifier">min_type</span> min<span class="special">,</span> <span class="identifier">sec_type</span> sec<span class="special">,</span> 
65               <span class="identifier">fractional_seconds_type</span> fs <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre></li>
66 <li class="listitem"><pre class="literallayout"><a name="idp498520896-bb"></a><span class="identifier">time_duration</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
67 <li class="listitem">
68 <pre class="literallayout"><a name="idp498521184-bb"></a><span class="identifier">time_duration</span><span class="special">(</span><span class="identifier">boost</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>
69 <li class="listitem"><pre class="literallayout"><span class="keyword">explicit</span> <a name="idp498523216-bb"></a><span class="identifier">time_duration</span><span class="special">(</span><span class="identifier">impl_type</span> tick_count<span class="special">)</span><span class="special">;</span></pre></li>
70 </ol></div>
71 </div>
72 </div>
73 </div>
74 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
75 <td align="left"></td>
76 <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
77     <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>
78 </div></td>
79 </tr></table>
80 <hr>
81 <div class="spirit-nav">
82 <a accesskey="p" href="operator-__idp498502096.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.posix_time.posix_time_config_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="simple_time_rep.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
83 </div>
84 </body>
85 </html>