blob: 2e7b80c37e6da6a47ae719b2c9cd9d75471f9b30 [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template absolute</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../../boost_units/Reference.html#header.boost.units.absolute_hpp" title="Header &lt;boost/units/absolute.hpp&gt;">
<link rel="prev" href="../../boost_units/Reference.html" title="Reference">
<link rel="next" href="../../BOOST_UNITS_DEFINE_CONVERSION_OFFSET.html" title="Macro BOOST_UNITS_DEFINE_CONVERSION_OFFSET">
</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="../../boost_units/Reference.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_units/Reference.html#header.boost.units.absolute_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="../../BOOST_UNITS_DEFINE_CONVERSION_OFFSET.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.units.absolute"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template absolute</span></h2>
<p>boost::units::absolute</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="../../boost_units/Reference.html#header.boost.units.absolute_hpp" title="Header &lt;boost/units/absolute.hpp&gt;">boost/units/absolute.hpp</a>&gt;
</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Y<span class="special">&gt;</span>
<span class="keyword">class</span> <a class="link" href="absolute.html" title="Class template absolute">absolute</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
<span class="comment">// types</span>
<span class="keyword">typedef</span> <a class="link" href="absolute.html" title="Class template absolute">absolute</a><span class="special">&lt;</span> <span class="identifier">Y</span> <span class="special">&gt;</span> <a name="boost.units.absolute.this_type"></a><span class="identifier">this_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">Y</span> <a name="boost.units.absolute.value_type"></a><span class="identifier">value_type</span><span class="special">;</span>
<span class="comment">// <a class="link" href="absolute.html#boost.units.absoluteconstruct-copy-destruct">construct/copy/destruct</a></span>
<a class="link" href="absolute.html#id1443943-bb"><span class="identifier">absolute</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="absolute.html#id1443944-bb"><span class="identifier">absolute</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="absolute.html#id1443951-bb"><span class="identifier">absolute</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="absolute.html#boost.units.absolute.this_type">this_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
absolute&amp; <a class="link" href="absolute.html#id1443962-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="absolute.html#boost.units.absolute.this_type">this_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
<span class="comment">// <a class="link" href="absolute.html#id1443897-bb">public member functions</a></span>
<span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&amp;</span> <a class="link" href="absolute.html#id1443901-bb"><span class="identifier">value</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="keyword">const</span> <a class="link" href="absolute.html#boost.units.absolute.this_type">this_type</a> <span class="special">&amp;</span> <a class="link" href="absolute.html#id1443909-bb"><span class="keyword">operator</span><span class="special">+=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">const</span> <a class="link" href="absolute.html#boost.units.absolute.this_type">this_type</a> <span class="special">&amp;</span> <a class="link" href="absolute.html#id1443926-bb"><span class="keyword">operator</span><span class="special">-=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="id2819848"></a><h2>Description</h2>
<p>A wrapper to represent absolute units (points rather than vectors). Intended originally for temperatures, this class implements operators for absolute units so that addition of a relative unit to an absolute unit results in another absolute unit : absolute&lt;T&gt; +/- T -&gt; absolute&lt;T&gt; and subtraction of one absolute unit from another results in a relative unit : absolute&lt;T&gt; - absolute&lt;T&gt; -&gt; T. </p>
<div class="refsect2">
<a name="id2819854"></a><h3>
<a name="boost.units.absoluteconstruct-copy-destruct"></a><code class="computeroutput">absolute</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><pre class="literallayout"><a name="id1443943-bb"></a><span class="identifier">absolute</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><a name="id1443944-bb"></a><span class="identifier">absolute</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&amp;</span> val<span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><a name="id1443951-bb"></a><span class="identifier">absolute</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="absolute.html#boost.units.absolute.this_type">this_type</a> <span class="special">&amp;</span> source<span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout">absolute&amp; <a name="id1443962-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="absolute.html#boost.units.absolute.this_type">this_type</a> <span class="special">&amp;</span> source<span class="special">)</span><span class="special">;</span></pre></li>
</ol></div>
</div>
<div class="refsect2">
<a name="id2820049"></a><h3>
<a name="id1443897-bb"></a><code class="computeroutput">absolute</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&amp;</span> <a name="id1443901-bb"></a><span class="identifier">value</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="keyword">const</span> <a class="link" href="absolute.html#boost.units.absolute.this_type">this_type</a> <span class="special">&amp;</span> <a name="id1443909-bb"></a><span class="keyword">operator</span><span class="special">+=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&amp;</span> val<span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <a class="link" href="absolute.html#boost.units.absolute.this_type">this_type</a> <span class="special">&amp;</span> <a name="id1443926-bb"></a><span class="keyword">operator</span><span class="special">-=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&amp;</span> val<span class="special">)</span><span class="special">;</span></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"><div class="copyright-footer">Copyright &#169; 2003 -2008 Matthias Christian Schabel, 2007-2010 Steven
Watanabe<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt 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="../../boost_units/Reference.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_units/Reference.html#header.boost.units.absolute_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="../../BOOST_UNITS_DEFINE_CONVERSION_OFFSET.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>