Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r65315 - sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference
From: vicente.botet_at_[hidden]
Date: 2010-09-05 18:55:46

Author: viboes
Date: 2010-09-05 18:55:43 EDT (Sun, 05 Sep 2010)
New Revision: 65315
URL: http://svn.boost.org/trac/boost/changeset/65315

Log:
Added missing file
Added:
sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference/other_clocks.html (contents, props changed)

Added: sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference/other_clocks.html
==============================================================================
--- (empty file)
+++ sandbox/chrono/libs/stopwatches/doc/html/boost_stopwatches/reference/other_clocks.html 2010-09-05 18:55:43 EDT (Sun, 05 Sep 2010)
@@ -0,0 +1,347 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title> Other clocks</title>
+<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
+<link rel="start" href="../../index.html" title="Boost.Stopwatches">
+<link rel="up" href="../reference.html" title=" Reference ">
+<link rel="prev" href="chrono_stopwatches_hpp.html" title="
+ Header <boost/stopwatches/stopwatches.hpp>">
+<link rel="next" href="stopwatches.html" title=" Stopwatches">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="chrono_stopwatches_hpp.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><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="stopwatches.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_stopwatches.reference.other_clocks"></a> Other clocks
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_req">
+ <code class="computeroutput">SuspendibleClock</code> Requirements</a></dt>
+<dd><dl>
+<dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_req.SuspendibleClock_suspend">
+ Static Member Function <code class="computeroutput">suspend()</code></a></dt>
+<dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_req.SuspendibleClock_resume">
+ Static Member Function <code class="computeroutput">resume()</code></a></dt>
+<dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_req.SuspendibleClock_suspended">
+ Static Member Function <code class="computeroutput">suspended()</code></a></dt>
+</dl></dd>
+<dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.scoped_suspend_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/scoped_suspend.hpp></code></a></dt>
+<dd><dl>
+<dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.scoped_suspend_hpp.is_suspendible">
+ Meta Function Class <code class="computeroutput">is_suspendible</code></a></dt>
+<dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.scoped_suspend_hpp.scoped_suspend">
+ Template Class <code class="computeroutput">scoped_suspend</code></a></dt>
+</dl></dd>
+<dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_hpp">
+ Header <code class="computeroutput"><boost/stopwatches/suspendible_clock.hpp></code></a></dt>
+<dd><dl><dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_hpp.suspendible_clock">
+ Template Class <code class="computeroutput">suspendible_clock<></code></a></dt></dl></dd>
+</dl></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.reference.other_clocks.suspendible_clock_req"></a><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_req" title="
+ SuspendibleClock Requirements">
+ <code class="computeroutput">SuspendibleClock</code> Requirements</a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_req.SuspendibleClock_suspend">
+ Static Member Function <code class="computeroutput">suspend()</code></a></dt>
+<dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_req.SuspendibleClock_resume">
+ Static Member Function <code class="computeroutput">resume()</code></a></dt>
+<dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_req.SuspendibleClock_suspended">
+ Static Member Function <code class="computeroutput">suspended()</code></a></dt>
+</dl></div>
+
+ A <code class="computeroutput">SuspendibleClock</code> is a
+ Clock that in addition supports <code class="computeroutput">suspend</code>/<code class="computeroutput">resume</code> operations.
+ 
+
+ A <code class="computeroutput">SuspendibleClock</code> must
+ meet the requirements in the following Table.
+ 
+
+ In this table <code class="computeroutput">C</code> denote
+ <code class="computeroutput">clock</code> types.
+ 
+<div class="table">
+<a name="boost_stopwatches.reference.other_clocks.suspendible_clock_req.suspendibleclock_requirements"></a>Table 1. SuspendibleClock Requirements
+<table class="table" summary="SuspendibleClock Requirements">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ expression
+ 
+ </th>
+<th>
+ 
+ return type
+ 
+ </th>
+<th>
+ 
+ operational semantics
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">C::suspend()</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">void</code>
+ 
+ </td>
+<td>
+ 
+ Suspends the time counting of the clock C.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">C::resume()</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">void</code>
+ 
+ </td>
+<td>
+ 
+ Resumes the time counting of the clock C.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">C::suspended()</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">duration</code>
+ 
+ </td>
+<td>
+ 
+ Returns the delay(duration during which the clock has been suspended.
+ 
+ </td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.other_clocks.suspendible_clock_req.SuspendibleClock_suspend"></a><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_req.SuspendibleClock_suspend" title="
+ Static Member Function suspend()">
+ Static Member Function <code class="computeroutput">suspend()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">void suspend( system::error_code & ec = system::throws );
+</pre>
+
+ Effect: Suspends the SuspendibleClock.
+ 
+
+ Throw: Any exception the <code class="computeroutput">Clock::now(ec)</code>
+ function can throw. Otherwise <code class="computeroutput">ec</code>
+ is set with the correspoding error code set by <code class="computeroutput">Clock::now(ec)</code>.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.other_clocks.suspendible_clock_req.SuspendibleClock_resume"></a><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_req.SuspendibleClock_resume" title="
+ Static Member Function resume()">
+ Static Member Function <code class="computeroutput">resume()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">void resume( system::error_code & ec = system::throws );
+</pre>
+
+ Effect: Resumes the <code class="computeroutput">SuspendibleClock</code>.
+ 
+
+ Throw: Any exception the <code class="computeroutput">Clock::now(ec)</code>
+ can throw. Otherwise <code class="computeroutput">ec</code>
+ is set with the correspoding error code set by <code class="computeroutput">Clock::now(ec)</code>.
+ 
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.other_clocks.suspendible_clock_req.SuspendibleClock_suspended"></a><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_req.SuspendibleClock_suspended" title="
+ Static Member Function suspended()">
+ Static Member Function <code class="computeroutput">suspended()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">duration suspended( system::error_code & ec = system::throws );
+</pre>
+
+ Returns: the cumalative elapsed duration
+ during which the <code class="computeroutput">SuspendibleClock</code>
+ has been suspendeed.
+ 
+
+ Throw: Any exception the Clock::now
+ function can throw if <code class="computeroutput">ec == system::throws</code>.
+ Otherwise <code class="computeroutput">ec</code> is set with
+ the correspoding error code set by <code class="computeroutput">Clock::now(ec)</code>.
+ 
+</div>
+
+ Models of <code class="computeroutput">SuspendibleClock</code>:
+ 
+<div class="itemizedlist"><ul type="disc"><li>
+ <a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_hpp.suspendible_clock" title="
+ Template Class suspendible_clock<>"><code class="computeroutput">suspendible_clock</code></a>]
+ </li></ul></div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.reference.other_clocks.scoped_suspend_hpp"></a><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.scoped_suspend_hpp" title="
+ Header <boost/stopwatches/scoped_suspend.hpp>">
+ Header <code class="computeroutput"><boost/stopwatches/scoped_suspend.hpp></code></a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.scoped_suspend_hpp.is_suspendible">
+ Meta Function Class <code class="computeroutput">is_suspendible</code></a></dt>
+<dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.scoped_suspend_hpp.scoped_suspend">
+ Template Class <code class="computeroutput">scoped_suspend</code></a></dt>
+</dl></div>
+<pre class="programlisting">namespace boost { namespace stopwatches {
+ template <class Clock> struct is_suspendible;
+ template <class Clock> class scoped_suspend;
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.other_clocks.scoped_suspend_hpp.is_suspendible"></a><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.scoped_suspend_hpp.is_suspendible" title="
+ Meta Function Class is_suspendible">
+ Meta Function Class <code class="computeroutput">is_suspendible</code></a>
+</h5></div></div></div>
+<pre class="programlisting">template <class Clock>
+struct is_suspendible : mpl:: false_ {};
+</pre>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.other_clocks.scoped_suspend_hpp.scoped_suspend"></a><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.scoped_suspend_hpp.scoped_suspend" title="
+ Template Class scoped_suspend">
+ Template Class <code class="computeroutput">scoped_suspend</code></a>
+</h5></div></div></div>
+<pre class="programlisting">template <class Clock>
+class scoped_suspend {
+public:
+ scoped_suspend(system::error_code & ec = system::throws) {}
+ ~scoped_suspend() {}
+private:
+ scoped_suspend(); // = delete;
+ scoped_suspend(const scoped_suspend&); // = delete;
+ scoped_suspend& operator=(const scoped_suspend&); // = delete;
+};
+</pre>
+</div>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_stopwatches.reference.other_clocks.suspendible_clock_hpp"></a><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_hpp" title="
+ Header <boost/stopwatches/suspendible_clock.hpp>">
+ Header <code class="computeroutput"><boost/stopwatches/suspendible_clock.hpp></code></a>
+</h4></div></div></div>
+<div class="toc"><dl><dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_hpp.suspendible_clock">
+ Template Class <code class="computeroutput">suspendible_clock<></code></a></dt></dl></div>
+<pre class="programlisting">namespace boost { namespace stopwatches {
+
+ template <class Clock>
+ class suspendible_clock;
+
+ template <class Clock>
+ struct is_suspendible<suspendible_clock<Clock> > : mpl:: true_ {};
+
+ template <class Clock>
+ class scoped_suspend<suspendible_clock<Clock> >;
+
+}}
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_stopwatches.reference.other_clocks.suspendible_clock_hpp.suspendible_clock"></a><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_hpp.suspendible_clock" title="
+ Template Class suspendible_clock<>">
+ Template Class <code class="computeroutput">suspendible_clock<></code></a>
+</h5></div></div></div>
+<div class="toc"><dl><dt><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_hpp.suspendible_clock._scoped_suspend__specialization_for__suspendible_clock___"><code class="computeroutput">scoped_suspend</code> specialization for
+ <code class="computeroutput">suspendible_clock<></code></a></dt></dl></div>
+
+ Given a <code class="computeroutput">Clock</code>, <a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_hpp.suspendible_clock" title="
+ Template Class suspendible_clock<>"><code class="computeroutput">suspendible_clock</code></a> < <code class="computeroutput">Clock</code>> is a model of <code class="computeroutput">SuspendibleClock</code>.
+ 
+<pre class="programlisting">template < class Clock >
+class suspendible_clock {
+public:
+ typedef typename Clock::duration duration;
+ typedef typename Clock::rep rep;
+ typedef typename Clock::period period;
+ typedef chrono:: <code class="computeroutput">time_point</code><suspendible_clock<Clock> > time_point;
+ static const bool is_monotonic = true;
+
+ static time_point now( system::error_code & ec = system::throws );
+
+ static void suspend( system::error_code & ec = system::throws );
+ static void resume( system::error_code & ec = system::throws );
+ static duration suspended(system::error_code & ec = system::throws);
+};
+</pre>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="boost_stopwatches.reference.other_clocks.suspendible_clock_hpp.suspendible_clock._scoped_suspend__specialization_for__suspendible_clock___"></a><a href="other_clocks.html#boost_stopwatches.reference.other_clocks.suspendible_clock_hpp.suspendible_clock._scoped_suspend__specialization_for__suspendible_clock___" title="scoped_suspend specialization for
+ suspendible_clock<>"><code class="computeroutput">scoped_suspend</code> specialization for
+ <code class="computeroutput">suspendible_clock<></code></a>
+</h6></div></div></div>
+<pre class="programlisting">template <class Clock>
+class scoped_suspend<suspendible_clock<Clock> > {
+public:
+ scoped_suspend(system::error_code & ec = system::throws);
+ ~scoped_suspend();
+};
+</pre>
+</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 © 2009 -2010 Vicente J. Botet Escriba
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="chrono_stopwatches_hpp.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><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="stopwatches.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Date view	Thread view	Subject view	Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk