doc/html/boost/units/unit.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template unit</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="../../boost_units/Reference.html#header.boost.units.unit_hpp" title="Header &lt;boost/units/unit.hpp&gt;">
   9 <link rel="prev" href="static_rational.html" title="Class template static_rational">
  10 <link rel="next" href="reduce_unit_u_idp345508944.html" title="Struct template reduce_unit&lt;unit&lt; Dim, System &gt;&gt;">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="static_rational.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_units/Reference.html#header.boost.units.unit_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="reduce_unit_u_idp345508944.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.units.unit"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template unit</span></h2>
  29 <p>boost::units::unit &#8212; class representing a model-dependent unit with no associated value </p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <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.unit_hpp" title="Header &lt;boost/units/unit.hpp&gt;">boost/units/unit.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Dim<span class="special">,</span> <span class="keyword">typename</span> System<span class="special">,</span> <span class="keyword">typename</span> Enable<span class="special">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="unit.html" title="Class template unit">unit</a> <span class="special">{</span>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// types</span>
  38   <span class="keyword">typedef</span> <a class="link" href="unit.html" title="Class template unit">unit</a><span class="special">&lt;</span> <span class="identifier">Dim</span><span class="special">,</span> <span class="identifier">System</span> <span class="special">&gt;</span> <a name="boost.units.unit.unit_type"></a><span class="identifier">unit_type</span><span class="special">;</span>
  39   <span class="keyword">typedef</span> <a class="link" href="unit.html" title="Class template unit">unit</a><span class="special">&lt;</span> <span class="identifier">Dim</span><span class="special">,</span> <span class="identifier">System</span> <span class="special">&gt;</span> <a name="boost.units.unit.this_type"></a><span class="identifier">this_type</span><span class="special">;</span>
  40   <span class="keyword">typedef</span> <span class="identifier">Dim</span>                 <a name="boost.units.unit.dimension_type"></a><span class="identifier">dimension_type</span><span class="special">;</span>
  41   <span class="keyword">typedef</span> <span class="identifier">System</span>              <a name="boost.units.unit.system_type"></a><span class="identifier">system_type</span><span class="special">;</span>
  42
  43   <span class="comment">// <a class="link" href="unit.html#boost.units.unitconstruct-copy-destruct">construct/copy/destruct</a></span>
  44   <a class="link" href="unit.html#idp345506416-bb"><span class="identifier">unit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  45   <a class="link" href="unit.html#idp345506704-bb"><span class="identifier">unit</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">this_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  46   <span class="identifier">this_type</span> <span class="special">&amp;</span> <a class="link" href="unit.html#idp345507680-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">this_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  47 <span class="special">}</span><span class="special">;</span></pre></div>
  48 <div class="refsect1">
  49 <a name="idp501038464"></a><h2>Description</h2>
  50 <p>(e.g. meters, Kelvin, feet, etc...) </p>
  51 <div class="refsect2">
  52 <a name="idp501039184"></a><h3>
  53 <a name="boost.units.unitconstruct-copy-destruct"></a><code class="computeroutput">unit</code>
  54         public
  55        construct/copy/destruct</h3>
  56 <div class="orderedlist"><ol class="orderedlist" type="1">
  57 <li class="listitem"><pre class="literallayout"><a name="idp345506416-bb"></a><span class="identifier">unit</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
  58 <li class="listitem"><pre class="literallayout"><a name="idp345506704-bb"></a><span class="identifier">unit</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">this_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre></li>
  59 <li class="listitem"><pre class="literallayout"><span class="identifier">this_type</span> <span class="special">&amp;</span> <a name="idp345507680-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">this_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre></li>
  60 </ol></div>
  61 </div>
  62 </div>
  63 </div>
  64 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  65 <td align="left"></td>
  66 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2008 Matthias Christian Schabel<br>Copyright &#169; 2007-2010 Steven
  67       Watanabe<p>
  68         Distributed under the Boost Software License, Version 1.0. (See accompanying
  69         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>)
  70       </p>
  71 </div></td>
  72 </tr></table>
  73 <hr>
  74 <div class="spirit-nav">
  75 <a accesskey="p" href="static_rational.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_units/Reference.html#header.boost.units.unit_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="reduce_unit_u_idp345508944.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  76 </div>
  77 </body>
  78 </html>