summaryrefslogtreecommitdiff
path: root/doc/html/microsec_clock.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/microsec_clock.html')
-rw-r--r--doc/html/microsec_clock.html86
1 files changed, 86 insertions, 0 deletions
diff --git a/doc/html/microsec_clock.html b/doc/html/microsec_clock.html
new file mode 100644
index 0000000000..f8f1c3f423
--- /dev/null
+++ b/doc/html/microsec_clock.html
@@ -0,0 +1,86 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Class template microsec_clock</title>
+<link rel="stylesheet" href="boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
+<link rel="start" href="index.html" title="The Boost C++ Libraries">
+<link rel="up" href="date_time/doxy.html#id1070509" title="Header &lt;boost/date_time/microsec_time_clock.hpp&gt;">
+<link rel="prev" href="acst_dst_trait.html" title="Struct template acst_dst_trait">
+<link rel="next" href="id974797.html" title="Type ymd_order_spec">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%">
+<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td>
+<td align="center"><a href="../../index.htm">Home</a></td>
+<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
+<td align="center"><a href="../../people/people.htm">People</a></td>
+<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
+<td align="center"><a href="../../more/index.htm">More</a></td>
+</table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="acst_dst_trait.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id1070509"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="id974797.html"><img src="images/next.png" alt="Next"></a>
+</div>
+<div class="refentry" lang="en">
+<a name="microsec_clock"></a><div class="titlepage"></div>
+<div class="refnamediv">
+<h2><span class="refentrytitle">Class template microsec_clock</span></h2>
+<p>boost::date_time::microsec_clock &#8212; A clock providing microsecond 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="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> time_type&gt;
+<span class="bold"><strong>class</strong></span> microsec_clock {
+<span class="bold"><strong>public</strong></span>:
+  <span class="emphasis"><em>// types</em></span>
+  <span class="bold"><strong>typedef</strong></span> time_type::date_type          date_type;             
+  <span class="bold"><strong>typedef</strong></span> time_type::time_duration_type time_duration_type;    
+  <span class="bold"><strong>typedef</strong></span> time_duration_type::rep_type  resolution_traits_type;
+
+  <span class="emphasis"><em>// <a href="microsec_clock.html#id1112505-bb">public static functions</a></em></span>
+  <span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> time_zone_type&gt;
+    <span class="type">time_type</span> <a href="microsec_clock.html#id1112510-bb">local_time</a>(shared_ptr&lt; time_zone_type &gt;) ;
+  <span class="type">time_type</span> <a href="microsec_clock.html#id976440-bb">local_time</a>() ;
+  <span class="type">time_type</span> <a href="microsec_clock.html#id865368-bb">universal_time</a>() ;
+
+  <span class="emphasis"><em>// <a href="microsec_clock.html#id932996-bb">private static functions</a></em></span>
+  <span class="type">time_type</span> <a href="microsec_clock.html#id933001-bb">create_time</a>(TZ_FOR_CREATE) ;
+  <span class="type">time_type</span> <a href="microsec_clock.html#id1069967-bb">local_time</a>() ;
+  <span class="type">time_type</span> <a href="microsec_clock.html#id1039743-bb">universal_time</a>() ;
+  <span class="type">time_type</span> <a href="microsec_clock.html#id964788-bb">create_time</a>(FILETIME &amp;, TZ_FOR_CREATE) ;
+};</pre></div>
+<div class="refsect1" lang="en">
+<a name="id1110675"></a><h2>Description</h2>
+<p>A high precision clock that measures the local time at a resolution up to microseconds and adjusts to the resolution of the time system. For example, for the a library configuration with nano second resolution, the last 3 places of the fractional seconds will always be 000 since there are 1000 nano-seconds in a micro second. </p>
+<div class="refsect2" lang="en">
+<a name="id1110686"></a><h3>
+<a name="id1112505-bb"></a><code class="computeroutput">microsec_clock</code> public static functions</h3>
+<div class="orderedlist"><ol type="1">
+<li><pre class="literallayout"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> time_zone_type&gt;
+  <span class="type">time_type</span> <a name="id1112510-bb"></a>local_time(shared_ptr&lt; time_zone_type &gt; tz_ptr) ;</pre></li>
+<li><pre class="literallayout"><span class="type">time_type</span> <a name="id976440-bb"></a>local_time() ;</pre></li>
+<li><pre class="literallayout"><span class="type">time_type</span> <a name="id865368-bb"></a>universal_time() ;</pre></li>
+</ol></div>
+</div>
+<div class="refsect2" lang="en">
+<a name="id1110769"></a><h3>
+<a name="id932996-bb"></a><code class="computeroutput">microsec_clock</code> private static functions</h3>
+<div class="orderedlist"><ol type="1">
+<li><pre class="literallayout"><span class="type">time_type</span> <a name="id933001-bb"></a>create_time(TZ_FOR_CREATE tz) ;</pre></li>
+<li><pre class="literallayout"><span class="type">time_type</span> <a name="id1069967-bb"></a>local_time() ;</pre></li>
+<li><pre class="literallayout"><span class="type">time_type</span> <a name="id1039743-bb"></a>universal_time() ;</pre></li>
+<li><pre class="literallayout"><span class="type">time_type</span> <a name="id964788-bb"></a>create_time(FILETIME &amp; ft, TZ_FOR_CREATE tz) ;</pre></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"><small>Copyright © 2001-2005 CrystalClear Software, Inc</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="acst_dst_trait.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="date_time/doxy.html#id1070509"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="id974797.html"><img src="images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>