• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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=UTF-8">
5<title>Struct template base_unit_info</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="../../boost_units/Reference.html#header.boost.units.scaled_base_unit_hpp" title="Header &lt;boost/units/scaled_base_unit.hpp&gt;">
10<link rel="prev" href="scale.html" title="Struct template scale">
11<link rel="next" href="heterogeneous_system.html" title="Struct template heterogeneous_system">
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="scale.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_units/Reference.html#header.boost.units.scaled_base_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="heterogeneous_system.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
25</div>
26<div class="refentry">
27<a name="boost.units.base_unit_info"></a><div class="titlepage"></div>
28<div class="refnamediv">
29<h2><span class="refentrytitle">Struct template base_unit_info</span></h2>
30<p>boost::units::base_unit_info — traits template for unit names. </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="../../boost_units/Reference.html#header.boost.units.scaled_base_unit_hpp" title="Header &lt;boost/units/scaled_base_unit.hpp&gt;">boost/units/scaled_base_unit.hpp</a>&gt;
34
35</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> BaseUnit<span class="special">&gt;</span>
36<span class="keyword">struct</span> <a class="link" href="base_unit_info.html" title="Struct template base_unit_info">base_unit_info</a> <span class="special">{</span>
37
38  <span class="comment">// <a class="link" href="base_unit_info.html#id-1_3_44_10_2_39_1_1_1_3-bb">public static functions</a></span>
39  <span class="keyword">static</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="base_unit_info.html#id-1_3_44_10_2_39_1_1_1_3_1-bb"><span class="identifier">name</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
40  <span class="keyword">static</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="base_unit_info.html#id-1_3_44_10_2_39_1_1_1_3_2-bb"><span class="identifier">symbol</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
41<span class="special">}</span><span class="special">;</span></pre></div>
42<div class="refsect1">
43<a name="id-1.3.44.10.2.39.3.4"></a><h2>Description</h2>
44<div class="refsect2">
45<a name="id-1.3.44.10.2.39.3.4.2"></a><h3>
46<a name="id-1_3_44_10_2_39_1_1_1_3-bb"></a><code class="computeroutput">base_unit_info</code> public static functions</h3>
47<div class="orderedlist"><ol class="orderedlist" type="1">
48<li class="listitem">
49<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="id-1_3_44_10_2_39_1_1_1_3_1-bb"></a><span class="identifier">name</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>The full name of the unit (returns BaseUnit::name() by default) </li>
50<li class="listitem">
51<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="id-1_3_44_10_2_39_1_1_1_3_2-bb"></a><span class="identifier">symbol</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>The symbol for the base unit (Returns BaseUnit::symbol() by default) <p>
52</p>
53<div class="variablelist"><table border="0" class="variablelist compact">
54<colgroup>
55<col align="left" valign="top">
56<col>
57</colgroup>
58<tbody><tr>
59<td><p><span class="term">Returns:</span></p></td>
60<td><p>BaseUnit::symbol(), for example "m" </p></td>
61</tr></tbody>
62</table></div>
63</li>
64</ol></div>
65</div>
66</div>
67</div>
68<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
69<td align="left"></td>
70<td align="right"><div class="copyright-footer">Copyright © 2003-2008 Matthias Christian Schabel<br>Copyright © 2007-2010 Steven
71      Watanabe<p>
72        Distributed under the Boost Software License, Version 1.0. (See accompanying
73        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>)
74      </p>
75</div></td>
76</tr></table>
77<hr>
78<div class="spirit-nav">
79<a accesskey="p" href="scale.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_units/Reference.html#header.boost.units.scaled_base_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="heterogeneous_system.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
80</div>
81</body>
82</html>
83