libs/convert/doc/html/boost/cnv/reference.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Struct template reference</title>
   5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;Boost.Convert 2.0">
   8 <link rel="up" href="../../boost_convert_c___reference.html#header.boost.convert_hpp" title="Header &lt;boost/convert.hpp&gt;">
   9 <link rel="prev" href="../../boost_convert_c___reference.html" title="Boost.Convert C++ Reference">
  10 <link rel="next" href="referenc_idm45211508382320.html" title="Struct template reference&lt;Converter, TypeOut, void&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="../../boost_convert_c___reference.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_convert_c___reference.html#header.boost.convert_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="referenc_idm45211508382320.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.cnv.reference"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Struct template reference</span></h2>
  29 <p>boost::cnv::reference</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_convert_c___reference.html#header.boost.convert_hpp" title="Header &lt;boost/convert.hpp&gt;">boost/convert.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Converter<span class="special">,</span> <span class="keyword">typename</span> TypeOut<span class="special">,</span> <span class="keyword">typename</span> TypeIn<span class="special">&gt;</span>
  35 <span class="keyword">struct</span> <a class="link" href="reference.html" title="Struct template reference">reference</a> <span class="special">{</span>
  36   <span class="comment">// types</span>
  37   <span class="keyword">typedef</span> <a class="link" href="reference.html" title="Struct template reference">reference</a> <a name="boost.cnv.reference.this_type"></a><span class="identifier">this_type</span><span class="special">;</span>
  38
  39   <span class="comment">// <a class="link" href="reference.html#boost.cnv.referenceconstruct-copy-destruct">construct/copy/destruct</a></span>
  40   <a class="link" href="reference.html#idm45211508383296-bb"><span class="identifier">reference</span></a><span class="special">(</span><span class="identifier">Converter</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  41
  42   <span class="comment">// <a class="link" href="reference.html#idm45211508346032-bb">public member functions</a></span>
  43   <a class="link" href="reference.html#boost.cnv.reference.this_type">this_type</a> <span class="special">&amp;</span> <a class="link" href="reference.html#idm45211508345472-bb"><span class="identifier">value_or</span></a><span class="special">(</span><span class="identifier">TypeOut</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  44   <span class="identifier">TypeOut</span> <a class="link" href="reference.html#idm45211508343648-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">TypeIn</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  45 <span class="special">}</span><span class="special">;</span></pre></div>
  46 <div class="refsect1">
  47 <a name="idm46230275673168"></a><h2>Description</h2>
  48 <div class="refsect2">
  49 <a name="idm46230275672752"></a><h3>
  50 <a name="boost.cnv.referenceconstruct-copy-destruct"></a><code class="computeroutput">reference</code>
  51         public
  52        construct/copy/destruct</h3>
  53 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idm45211508383296-bb"></a><span class="identifier">reference</span><span class="special">(</span><span class="identifier">Converter</span> <span class="keyword">const</span> <span class="special">&amp;</span> cnv<span class="special">)</span><span class="special">;</span></pre></li></ol></div>
  54 </div>
  55 <div class="refsect2">
  56 <a name="idm46230275664784"></a><h3>
  57 <a name="idm45211508346032-bb"></a><code class="computeroutput">reference</code> public member functions</h3>
  58 <div class="orderedlist"><ol class="orderedlist" type="1">
  59 <li class="listitem"><pre class="literallayout"><a class="link" href="reference.html#boost.cnv.reference.this_type">this_type</a> <span class="special">&amp;</span> <a name="idm45211508345472-bb"></a><span class="identifier">value_or</span><span class="special">(</span><span class="identifier">TypeOut</span> <span class="keyword">const</span> <span class="special">&amp;</span> fallback<span class="special">)</span><span class="special">;</span></pre></li>
  60 <li class="listitem"><pre class="literallayout"><span class="identifier">TypeOut</span> <a name="idm45211508343648-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">TypeIn</span> <span class="keyword">const</span> <span class="special">&amp;</span> value_in<span class="special">)</span><span class="special">;</span></pre></li>
  61 </ol></div>
  62 </div>
  63 </div>
  64 </div>
  65 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  66 <td align="left"></td>
  67 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2016 Vladimir Batov<p>
  68         Distributed under the Boost Software License, Version 1.0. See copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>.
  69       </p>
  70 </div></td>
  71 </tr></table>
  72 <hr>
  73 <div class="spirit-nav">
  74 <a accesskey="p" href="../../boost_convert_c___reference.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_convert_c___reference.html#header.boost.convert_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="referenc_idm45211508382320.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  75 </div>
  76 </body>
  77 </html>